<?xml version="1.0"?>
<wxPython-metadata>
- <module name="core">
+ <module name="_core">
<pythoncode>
#// Give a reference to the dictionary of this module to the C++ extension
#// code.
-_core._wxPySetDictionary(vars())
+_core_._wxPySetDictionary(vars())
#// A little trick to make 'wx' be a reference to this module so wx.Names can
#// be used here.
import sys as _sys
wx = _sys.modules[__name__]
+
+</pythoncode>
+ <pythoncode>
+#----------------------------------------------------------------------------
+
+def _deprecated(callable, msg=None):
+ """
+ Create a wrapper function that will raise a DeprecationWarning
+ before calling the callable.
+ """
+ if msg is None:
+ msg = "%s is deprecated" % callable
+ def deprecatedWrapper(*args, **kwargs):
+ import warnings
+ warnings.warn(msg, DeprecationWarning, stacklevel=2)
+ return callable(*args, **kwargs)
+ deprecatedWrapper.__doc__ = msg
+ return deprecatedWrapper
+
+
+#----------------------------------------------------------------------------
</pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Object" oldname="wxObject" module="core">
+ <class name="Object" oldname="wxObject" module="_core">
<docstring>The base class for most wx objects, although in wxPython not
much functionality is needed nor exposed.</docstring>
<method name="GetClassName" type="String" overloaded="no">
- <autodoc>GetClassName() -> String</autodoc>
- <docstring>Returns the class name of the C++ object using wxRTTI.</docstring>
+ <autodoc>GetClassName(self) -> String</autodoc>
+ <docstring>Returns the class name of the C++ class using wxRTTI.</docstring>
</method>
<method name="Destroy" type="" overloaded="no">
- <autodoc>Destroy()</autodoc>
+ <autodoc>Destroy(self)</autodoc>
<docstring>Deletes the C++ object this Python object is a proxy for.</docstring>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Size" oldname="wxSize" module="core">
- <docstring>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.</docstring>
+ <class name="Size" oldname="wxSize" module="_core">
+ <docstring>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.</docstring>
<constructor name="Size" overloaded="no">
- <autodoc>__init__(int w=0, int h=0) -> Size</autodoc>
+ <autodoc>__init__(self, int w=0, int h=0) -> Size</autodoc>
<docstring>Creates a size object.</docstring>
<paramlist>
<param name="w" type="int" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxSize" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<property name="width" type="int" readonly="no"/>
<property name="height" type="int" readonly="no"/>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(Size sz) -> bool</autodoc>
+ <autodoc>__eq__(self, Size sz) -> bool</autodoc>
<docstring>Test for equality of wx.Size objects.</docstring>
<paramlist>
<param name="sz" type="Size" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(Size sz) -> bool</autodoc>
+ <autodoc>__ne__(self, Size sz) -> bool</autodoc>
<docstring>Test for inequality.</docstring>
<paramlist>
<param name="sz" type="Size" default=""/>
</paramlist>
</method>
<method name="__add__" type="Size" overloaded="no">
- <autodoc>__add__(Size sz) -> Size</autodoc>
+ <autodoc>__add__(self, Size sz) -> Size</autodoc>
<docstring>Add sz's proprties to this and return the result.</docstring>
<paramlist>
<param name="sz" type="Size" default=""/>
</paramlist>
</method>
<method name="__sub__" type="Size" overloaded="no">
- <autodoc>__sub__(Size sz) -> Size</autodoc>
+ <autodoc>__sub__(self, Size sz) -> Size</autodoc>
<docstring>Subtract sz's properties from this and return the result.</docstring>
<paramlist>
<param name="sz" type="Size" default=""/>
</paramlist>
</method>
<method name="IncTo" type="" overloaded="no">
- <autodoc>IncTo(Size sz)</autodoc>
+ <autodoc>IncTo(self, Size sz)</autodoc>
<docstring>Increments this object so that both of its dimensions are not less
than the corresponding dimensions of the size.</docstring>
<paramlist>
</paramlist>
</method>
<method name="DecTo" type="" overloaded="no">
- <autodoc>DecTo(Size sz)</autodoc>
+ <autodoc>DecTo(self, Size sz)</autodoc>
<docstring>Decrements this object so that both of its dimensions are not greater
than the corresponding dimensions of the size.</docstring>
<paramlist>
</paramlist>
</method>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(int w, int h)</autodoc>
+ <autodoc>Set(self, int w, int h)</autodoc>
<docstring>Set both width and height.</docstring>
<paramlist>
<param name="w" type="int" default=""/>
</paramlist>
</method>
<method name="SetWidth" type="" overloaded="no">
- <autodoc>SetWidth(int w)</autodoc>
+ <autodoc>SetWidth(self, int w)</autodoc>
<paramlist>
<param name="w" type="int" default=""/>
</paramlist>
</method>
<method name="SetHeight" type="" overloaded="no">
- <autodoc>SetHeight(int h)</autodoc>
+ <autodoc>SetHeight(self, int h)</autodoc>
<paramlist>
<param name="h" type="int" default=""/>
</paramlist>
</method>
<method name="GetWidth" type="int" overloaded="no">
- <autodoc>GetWidth() -> int</autodoc>
+ <autodoc>GetWidth(self) -> int</autodoc>
</method>
<method name="GetHeight" type="int" overloaded="no">
- <autodoc>GetHeight() -> int</autodoc>
+ <autodoc>GetHeight(self) -> int</autodoc>
+ </method>
+ <method name="IsFullySpecified" type="bool" overloaded="no">
+ <autodoc>IsFullySpecified(self) -> bool</autodoc>
+ <docstring>Returns True if both components of the size are non-default values.</docstring>
+ </method>
+ <method name="SetDefaults" type="" overloaded="no">
+ <autodoc>SetDefaults(self, Size size)</autodoc>
+ <docstring>Combine this size with the other one replacing the default components
+of this object (i.e. equal to -1) with those of the other.</docstring>
+ <paramlist>
+ <param name="size" type="Size" default=""/>
+ </paramlist>
</method>
<method name="Get" type="PyObject" overloaded="no">
<autodoc>Get() -> (width,height)</autodoc>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="RealPoint" oldname="wxRealPoint" module="core">
- <docstring>A data structure for representing a point or position with floating point x
-and y properties. In wxPython most places that expect a wx.RealPoint can also
-accept a (x,y) tuple.</docstring>
+ <class name="RealPoint" oldname="wxRealPoint" module="_core">
+ <docstring>A data structure for representing a point or position with floating
+point x and y properties. In wxPython most places that expect a
+wx.RealPoint can also accept a (x,y) tuple.</docstring>
<constructor name="RealPoint" overloaded="no">
- <autodoc>__init__(double x=0.0, double y=0.0) -> RealPoint</autodoc>
+ <autodoc>__init__(self, double x=0.0, double y=0.0) -> RealPoint</autodoc>
<docstring>Create a wx.RealPoint object</docstring>
<paramlist>
<param name="x" type="double" default="0.0"/>
</paramlist>
</constructor>
<destructor name="~wxRealPoint" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<property name="x" type="double" readonly="no"/>
<property name="y" type="double" readonly="no"/>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(RealPoint pt) -> bool</autodoc>
+ <autodoc>__eq__(self, RealPoint pt) -> bool</autodoc>
<docstring>Test for equality of wx.RealPoint objects.</docstring>
<paramlist>
<param name="pt" type="RealPoint" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(RealPoint pt) -> bool</autodoc>
+ <autodoc>__ne__(self, RealPoint pt) -> bool</autodoc>
<docstring>Test for inequality of wx.RealPoint objects.</docstring>
<paramlist>
<param name="pt" type="RealPoint" default=""/>
</paramlist>
</method>
<method name="__add__" type="RealPoint" overloaded="no">
- <autodoc>__add__(RealPoint pt) -> RealPoint</autodoc>
+ <autodoc>__add__(self, RealPoint pt) -> RealPoint</autodoc>
<docstring>Add pt's proprties to this and return the result.</docstring>
<paramlist>
<param name="pt" type="RealPoint" default=""/>
</paramlist>
</method>
<method name="__sub__" type="RealPoint" overloaded="no">
- <autodoc>__sub__(RealPoint pt) -> RealPoint</autodoc>
+ <autodoc>__sub__(self, RealPoint pt) -> RealPoint</autodoc>
<docstring>Subtract pt's proprties from this and return the result</docstring>
<paramlist>
<param name="pt" type="RealPoint" default=""/>
</paramlist>
</method>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(double x, double y)</autodoc>
+ <autodoc>Set(self, double x, double y)</autodoc>
<docstring>Set both the x and y properties</docstring>
<paramlist>
<param name="x" type="double" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Point" oldname="wxPoint" module="core">
- <docstring>A data structure for representing a point or position with integer x and y
-properties. Most places in wxPython that expect a wx.Point can also accept a
-(x,y) tuple.</docstring>
+ <class name="Point" oldname="wxPoint" module="_core">
+ <docstring>A data structure for representing a point or position with integer x
+and y properties. Most places in wxPython that expect a wx.Point can
+also accept a (x,y) tuple.</docstring>
<constructor name="Point" overloaded="no">
- <autodoc>__init__(int x=0, int y=0) -> Point</autodoc>
+ <autodoc>__init__(self, int x=0, int y=0) -> Point</autodoc>
<docstring>Create a wx.Point object</docstring>
<paramlist>
<param name="x" type="int" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxPoint" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<property name="x" type="int" readonly="no"/>
<property name="y" type="int" readonly="no"/>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(Point pt) -> bool</autodoc>
+ <autodoc>__eq__(self, Point pt) -> bool</autodoc>
<docstring>Test for equality of wx.Point objects.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(Point pt) -> bool</autodoc>
+ <autodoc>__ne__(self, Point pt) -> bool</autodoc>
<docstring>Test for inequality of wx.Point objects.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="__add__" type="Point" overloaded="no">
- <autodoc>__add__(Point pt) -> Point</autodoc>
+ <autodoc>__add__(self, Point pt) -> Point</autodoc>
<docstring>Add pt's proprties to this and return the result.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="__sub__" type="Point" overloaded="no">
- <autodoc>__sub__(Point pt) -> Point</autodoc>
+ <autodoc>__sub__(self, Point pt) -> Point</autodoc>
<docstring>Subtract pt's proprties from this and return the result</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="__iadd__" type="Point" overloaded="no">
- <autodoc>__iadd__(Point pt) -> Point</autodoc>
+ <autodoc>__iadd__(self, Point pt) -> Point</autodoc>
<docstring>Add pt to this object.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="__isub__" type="Point" overloaded="no">
- <autodoc>__isub__(Point pt) -> Point</autodoc>
+ <autodoc>__isub__(self, Point pt) -> Point</autodoc>
<docstring>Subtract pt from this object.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(long x, long y)</autodoc>
+ <autodoc>Set(self, long x, long y)</autodoc>
<docstring>Set both the x and y properties</docstring>
<paramlist>
<param name="x" type="long" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Rect" oldname="wxRect" module="core">
- <docstring>A class for representing and manipulating rectangles. It has x, y, width and
-height properties. In wxPython most palces that expect a wx.Rect can also
-accept a (x,y,width,height) tuple.</docstring>
+ <class name="Rect" oldname="wxRect" module="_core">
+ <docstring>A class for representing and manipulating rectangles. It has x, y,
+width and height properties. In wxPython most palces that expect a
+wx.Rect can also accept a (x,y,width,height) tuple.</docstring>
<constructor name="Rect" overloaded="no">
- <autodoc>__init__(int x=0, int y=0, int width=0, int height=0) -> Rect</autodoc>
+ <autodoc>__init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect</autodoc>
<docstring>Create a new Rect object.</docstring>
<paramlist>
<param name="x" type="int" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxRect" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetX" type="int" overloaded="no">
- <autodoc>GetX() -> int</autodoc>
+ <autodoc>GetX(self) -> int</autodoc>
</method>
<method name="SetX" type="" overloaded="no">
- <autodoc>SetX(int x)</autodoc>
+ <autodoc>SetX(self, int x)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="GetY" type="int" overloaded="no">
- <autodoc>GetY() -> int</autodoc>
+ <autodoc>GetY(self) -> int</autodoc>
</method>
<method name="SetY" type="" overloaded="no">
- <autodoc>SetY(int y)</autodoc>
+ <autodoc>SetY(self, int y)</autodoc>
<paramlist>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="GetWidth" type="int" overloaded="no">
- <autodoc>GetWidth() -> int</autodoc>
+ <autodoc>GetWidth(self) -> int</autodoc>
</method>
<method name="SetWidth" type="" overloaded="no">
- <autodoc>SetWidth(int w)</autodoc>
+ <autodoc>SetWidth(self, int w)</autodoc>
<paramlist>
<param name="w" type="int" default=""/>
</paramlist>
</method>
<method name="GetHeight" type="int" overloaded="no">
- <autodoc>GetHeight() -> int</autodoc>
+ <autodoc>GetHeight(self) -> int</autodoc>
</method>
<method name="SetHeight" type="" overloaded="no">
- <autodoc>SetHeight(int h)</autodoc>
+ <autodoc>SetHeight(self, int h)</autodoc>
<paramlist>
<param name="h" type="int" default=""/>
</paramlist>
</method>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
</method>
<method name="SetPosition" type="" overloaded="no">
- <autodoc>SetPosition(Point p)</autodoc>
+ <autodoc>SetPosition(self, Point p)</autodoc>
<paramlist>
<param name="p" type="Point" default=""/>
</paramlist>
</method>
<method name="GetSize" type="Size" overloaded="no">
- <autodoc>GetSize() -> Size</autodoc>
+ <autodoc>GetSize(self) -> Size</autodoc>
</method>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(Size s)</autodoc>
+ <autodoc>SetSize(self, Size s)</autodoc>
<paramlist>
<param name="s" type="Size" default=""/>
</paramlist>
</method>
<method name="GetTopLeft" type="Point" overloaded="no">
- <autodoc>GetTopLeft() -> Point</autodoc>
+ <autodoc>GetTopLeft(self) -> Point</autodoc>
</method>
<method name="SetTopLeft" type="" overloaded="no">
- <autodoc>SetTopLeft(Point p)</autodoc>
+ <autodoc>SetTopLeft(self, Point p)</autodoc>
<paramlist>
<param name="p" type="Point" default=""/>
</paramlist>
</method>
<method name="GetBottomRight" type="Point" overloaded="no">
- <autodoc>GetBottomRight() -> Point</autodoc>
+ <autodoc>GetBottomRight(self) -> Point</autodoc>
</method>
<method name="SetBottomRight" type="" overloaded="no">
- <autodoc>SetBottomRight(Point p)</autodoc>
+ <autodoc>SetBottomRight(self, Point p)</autodoc>
<paramlist>
<param name="p" type="Point" default=""/>
</paramlist>
</method>
<method name="GetLeft" type="int" overloaded="no">
- <autodoc>GetLeft() -> int</autodoc>
+ <autodoc>GetLeft(self) -> int</autodoc>
</method>
<method name="GetTop" type="int" overloaded="no">
- <autodoc>GetTop() -> int</autodoc>
+ <autodoc>GetTop(self) -> int</autodoc>
</method>
<method name="GetBottom" type="int" overloaded="no">
- <autodoc>GetBottom() -> int</autodoc>
+ <autodoc>GetBottom(self) -> int</autodoc>
</method>
<method name="GetRight" type="int" overloaded="no">
- <autodoc>GetRight() -> int</autodoc>
+ <autodoc>GetRight(self) -> int</autodoc>
</method>
<method name="SetLeft" type="" overloaded="no">
- <autodoc>SetLeft(int left)</autodoc>
+ <autodoc>SetLeft(self, int left)</autodoc>
<paramlist>
<param name="left" type="int" default=""/>
</paramlist>
</method>
<method name="SetRight" type="" overloaded="no">
- <autodoc>SetRight(int right)</autodoc>
+ <autodoc>SetRight(self, int right)</autodoc>
<paramlist>
<param name="right" type="int" default=""/>
</paramlist>
</method>
<method name="SetTop" type="" overloaded="no">
- <autodoc>SetTop(int top)</autodoc>
+ <autodoc>SetTop(self, int top)</autodoc>
<paramlist>
<param name="top" type="int" default=""/>
</paramlist>
</method>
<method name="SetBottom" type="" overloaded="no">
- <autodoc>SetBottom(int bottom)</autodoc>
+ <autodoc>SetBottom(self, int bottom)</autodoc>
<paramlist>
<param name="bottom" type="int" default=""/>
</paramlist>
</method>
<method name="Inflate" type="Rect" overloaded="no">
- <autodoc>Inflate(int dx, int dy) -> Rect</autodoc>
- <docstring>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.</docstring>
+ <autodoc>Inflate(self, int dx, int dy) -> Rect</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="dx" type="int" default=""/>
<param name="dy" type="int" default=""/>
</paramlist>
</method>
<method name="Deflate" type="Rect" overloaded="no">
- <autodoc>Deflate(int dx, int dy) -> Rect</autodoc>
- <docstring>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.</docstring>
+ <autodoc>Deflate(self, int dx, int dy) -> Rect</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="dx" type="int" default=""/>
<param name="dy" type="int" default=""/>
</paramlist>
</method>
<method name="OffsetXY" type="" overloaded="no">
- <autodoc>OffsetXY(int dx, int dy)</autodoc>
- <docstring>Moves the rectangle by the specified offset. If dx is positive, the rectangle
-is moved to the right, if dy is positive, it is moved to the bottom, otherwise
-it is moved to the left or top respectively.</docstring>
+ <autodoc>OffsetXY(self, int dx, int dy)</autodoc>
+ <docstring>Moves the rectangle by the specified offset. If dx is positive, the
+rectangle is moved to the right, if dy is positive, it is moved to the
+bottom, otherwise it is moved to the left or top respectively.</docstring>
<paramlist>
<param name="dx" type="int" default=""/>
<param name="dy" type="int" default=""/>
</paramlist>
</method>
<method name="Offset" type="" overloaded="no">
- <autodoc>Offset(Point pt)</autodoc>
+ <autodoc>Offset(self, Point pt)</autodoc>
<docstring>Same as OffsetXY but uses dx,dy from Point</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="Intersect" type="Rect" overloaded="no">
- <autodoc>Intersect(Rect rect) -> Rect</autodoc>
+ <autodoc>Intersect(self, Rect rect) -> Rect</autodoc>
<docstring>Return the intersectsion of this rectangle and rect.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="__add__" type="Rect" overloaded="no">
- <autodoc>__add__(Rect rect) -> Rect</autodoc>
+ <autodoc>__add__(self, Rect rect) -> Rect</autodoc>
<docstring>Add the properties of rect to this rectangle and return the result.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="__iadd__" type="Rect" overloaded="no">
- <autodoc>__iadd__(Rect rect) -> Rect</autodoc>
+ <autodoc>__iadd__(self, Rect rect) -> Rect</autodoc>
<docstring>Add the properties of rect to this rectangle, updating this rectangle.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(Rect rect) -> bool</autodoc>
+ <autodoc>__eq__(self, Rect rect) -> bool</autodoc>
<docstring>Test for equality.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(Rect rect) -> bool</autodoc>
+ <autodoc>__ne__(self, Rect rect) -> bool</autodoc>
<docstring>Test for inequality.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="InsideXY" type="bool" overloaded="no">
- <autodoc>InsideXY(int x, int y) -> bool</autodoc>
+ <autodoc>InsideXY(self, int x, int y) -> bool</autodoc>
<docstring>Return True if the point is (not strcitly) inside the rect.</docstring>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="Inside" type="bool" overloaded="no">
- <autodoc>Inside(Point pt) -> bool</autodoc>
+ <autodoc>Inside(self, Point pt) -> bool</autodoc>
<docstring>Return True if the point is (not strcitly) inside the rect.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="Intersects" type="bool" overloaded="no">
- <autodoc>Intersects(Rect rect) -> bool</autodoc>
+ <autodoc>Intersects(self, Rect rect) -> bool</autodoc>
<docstring>Returns True if the rectangles have a non empty intersection.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
<property name="width" type="int" readonly="no"/>
<property name="height" type="int" readonly="no"/>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(int x=0, int y=0, int width=0, int height=0)</autodoc>
+ <autodoc>Set(self, int x=0, int y=0, int width=0, int height=0)</autodoc>
<docstring>Set all rectangle properties.</docstring>
<paramlist>
<param name="x" type="int" default="0"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Point2D" oldname="wxPoint2D" module="core">
- <docstring>wx.Point2Ds represent a point or a vector in a 2d coordinate system with floating point values.</docstring>
+ <class name="Point2D" oldname="wxPoint2D" module="_core">
+ <docstring>wx.Point2Ds represent a point or a vector in a 2d coordinate system
+with floating point values.</docstring>
<constructor name="Point2D" overloaded="no">
- <autodoc>__init__(double x=0.0, double y=0.0) -> Point2D</autodoc>
+ <autodoc>__init__(self, double x=0.0, double y=0.0) -> Point2D</autodoc>
<docstring>Create a w.Point2D object.</docstring>
<paramlist>
<param name="x" type="double" default="0.0"/>
</constructor>
<method name="GetFloor" type="" overloaded="no">
<autodoc>GetFloor() -> (x,y)</autodoc>
- <docstring>Convert to integer</docstring>
<paramlist>
<param name="OUTPUT" type="int" default=""/>
<param name="OUTPUT" type="int" default=""/>
</method>
<method name="GetRounded" type="" overloaded="no">
<autodoc>GetRounded() -> (x,y)</autodoc>
- <docstring>Convert to integer</docstring>
<paramlist>
<param name="OUTPUT" type="int" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="GetVectorLength" type="double" overloaded="no">
- <autodoc>GetVectorLength() -> double</autodoc>
+ <autodoc>GetVectorLength(self) -> double</autodoc>
</method>
<method name="GetVectorAngle" type="double" overloaded="no">
- <autodoc>GetVectorAngle() -> double</autodoc>
+ <autodoc>GetVectorAngle(self) -> double</autodoc>
</method>
<method name="SetVectorLength" type="" overloaded="no">
- <autodoc>SetVectorLength(double length)</autodoc>
+ <autodoc>SetVectorLength(self, double length)</autodoc>
<paramlist>
<param name="length" type="double" default=""/>
</paramlist>
</method>
<method name="SetVectorAngle" type="" overloaded="no">
- <autodoc>SetVectorAngle(double degrees)</autodoc>
+ <autodoc>SetVectorAngle(self, double degrees)</autodoc>
<paramlist>
<param name="degrees" type="double" default=""/>
</paramlist>
</method>
<method name="GetDistance" type="double" overloaded="no">
- <autodoc>GetDistance(Point2D pt) -> double</autodoc>
+ <autodoc>GetDistance(self, Point2D pt) -> double</autodoc>
<paramlist>
<param name="pt" type="Point2D" default=""/>
</paramlist>
</method>
<method name="GetDistanceSquare" type="double" overloaded="no">
- <autodoc>GetDistanceSquare(Point2D pt) -> double</autodoc>
+ <autodoc>GetDistanceSquare(self, Point2D pt) -> double</autodoc>
<paramlist>
<param name="pt" type="Point2D" default=""/>
</paramlist>
</method>
<method name="GetDotProduct" type="double" overloaded="no">
- <autodoc>GetDotProduct(Point2D vec) -> double</autodoc>
+ <autodoc>GetDotProduct(self, Point2D vec) -> double</autodoc>
<paramlist>
<param name="vec" type="Point2D" default=""/>
</paramlist>
</method>
<method name="GetCrossProduct" type="double" overloaded="no">
- <autodoc>GetCrossProduct(Point2D vec) -> double</autodoc>
+ <autodoc>GetCrossProduct(self, Point2D vec) -> double</autodoc>
<paramlist>
<param name="vec" type="Point2D" default=""/>
</paramlist>
</method>
<method name="__neg__" type="Point2D" overloaded="no">
- <autodoc>__neg__() -> Point2D</autodoc>
+ <autodoc>__neg__(self) -> Point2D</autodoc>
<docstring>the reflection of this point</docstring>
</method>
<method name="__iadd__" type="Point2D" overloaded="no">
- <autodoc>__iadd__(Point2D pt) -> Point2D</autodoc>
+ <autodoc>__iadd__(self, Point2D pt) -> Point2D</autodoc>
<paramlist>
<param name="pt" type="Point2D" default=""/>
</paramlist>
</method>
<method name="__isub__" type="Point2D" overloaded="no">
- <autodoc>__isub__(Point2D pt) -> Point2D</autodoc>
+ <autodoc>__isub__(self, Point2D pt) -> Point2D</autodoc>
<paramlist>
<param name="pt" type="Point2D" default=""/>
</paramlist>
</method>
<method name="__imul__" type="Point2D" overloaded="no">
- <autodoc>__imul__(Point2D pt) -> Point2D</autodoc>
+ <autodoc>__imul__(self, Point2D pt) -> Point2D</autodoc>
<paramlist>
<param name="pt" type="Point2D" default=""/>
</paramlist>
</method>
<method name="__idiv__" type="Point2D" overloaded="no">
- <autodoc>__idiv__(Point2D pt) -> Point2D</autodoc>
+ <autodoc>__idiv__(self, Point2D pt) -> Point2D</autodoc>
<paramlist>
<param name="pt" type="Point2D" default=""/>
</paramlist>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(Point2D pt) -> bool</autodoc>
+ <autodoc>__eq__(self, Point2D pt) -> bool</autodoc>
<docstring>Test for equality</docstring>
<paramlist>
<param name="pt" type="Point2D" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(Point2D pt) -> bool</autodoc>
+ <autodoc>__ne__(self, Point2D pt) -> bool</autodoc>
<docstring>Test for inequality</docstring>
<paramlist>
<param name="pt" type="Point2D" default=""/>
<property name="x" type="double" readonly="no"/>
<property name="y" type="double" readonly="no"/>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(double x=0, double y=0)</autodoc>
+ <autodoc>Set(self, double x=0, double y=0)</autodoc>
<paramlist>
<param name="x" type="double" default="0"/>
<param name="y" type="double" default="0"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="InputStream" oldname="wxPyInputStream" module="core">
+ <class name="InputStream" oldname="wxPyInputStream" module="_core">
<constructor name="wxPyInputStream" overloaded="no">
- <autodoc>__init__(PyObject p) -> InputStream</autodoc>
+ <autodoc>__init__(self, PyObject p) -> InputStream</autodoc>
<paramlist>
<param name="p" type="PyObject" default=""/>
</paramlist>
</constructor>
<method name="close" type="" overloaded="no">
- <autodoc>close()</autodoc>
+ <autodoc>close(self)</autodoc>
</method>
<method name="flush" type="" overloaded="no">
- <autodoc>flush()</autodoc>
+ <autodoc>flush(self)</autodoc>
</method>
<method name="eof" type="bool" overloaded="no">
- <autodoc>eof() -> bool</autodoc>
+ <autodoc>eof(self) -> bool</autodoc>
</method>
<method name="read" type="PyObject" overloaded="no">
- <autodoc>read(int size=-1) -> PyObject</autodoc>
+ <autodoc>read(self, int size=-1) -> PyObject</autodoc>
<paramlist>
<param name="size" type="int" default="-1"/>
</paramlist>
</method>
<method name="readline" type="PyObject" overloaded="no">
- <autodoc>readline(int size=-1) -> PyObject</autodoc>
+ <autodoc>readline(self, int size=-1) -> PyObject</autodoc>
<paramlist>
<param name="size" type="int" default="-1"/>
</paramlist>
</method>
<method name="readlines" type="PyObject" overloaded="no">
- <autodoc>readlines(int sizehint=-1) -> PyObject</autodoc>
+ <autodoc>readlines(self, int sizehint=-1) -> PyObject</autodoc>
<paramlist>
<param name="sizehint" type="int" default="-1"/>
</paramlist>
</method>
<method name="seek" type="" overloaded="no">
- <autodoc>seek(int offset, int whence=0)</autodoc>
+ <autodoc>seek(self, int offset, int whence=0)</autodoc>
<paramlist>
<param name="offset" type="int" default=""/>
<param name="whence" type="int" default="0"/>
</paramlist>
</method>
<method name="tell" type="int" overloaded="no">
- <autodoc>tell() -> int</autodoc>
+ <autodoc>tell(self) -> int</autodoc>
</method>
<method name="Peek" type="char" overloaded="no">
- <autodoc>Peek() -> char</autodoc>
+ <autodoc>Peek(self) -> char</autodoc>
</method>
<method name="GetC" type="char" overloaded="no">
- <autodoc>GetC() -> char</autodoc>
+ <autodoc>GetC(self) -> char</autodoc>
</method>
<method name="LastRead" type="size_t" overloaded="no">
- <autodoc>LastRead() -> size_t</autodoc>
+ <autodoc>LastRead(self) -> size_t</autodoc>
</method>
<method name="CanRead" type="bool" overloaded="no">
- <autodoc>CanRead() -> bool</autodoc>
+ <autodoc>CanRead(self) -> bool</autodoc>
</method>
<method name="Eof" type="bool" overloaded="no">
- <autodoc>Eof() -> bool</autodoc>
+ <autodoc>Eof(self) -> bool</autodoc>
</method>
<method name="Ungetch" type="bool" overloaded="no">
- <autodoc>Ungetch(char c) -> bool</autodoc>
+ <autodoc>Ungetch(self, char c) -> bool</autodoc>
<paramlist>
<param name="c" type="char" default=""/>
</paramlist>
</method>
<method name="SeekI" type="long" overloaded="no">
- <autodoc>SeekI(long pos, int mode=FromStart) -> long</autodoc>
+ <autodoc>SeekI(self, long pos, int mode=FromStart) -> long</autodoc>
<paramlist>
<param name="pos" type="long" default=""/>
<param name="mode" type="wxSeekMode" default="wxFromStart"/>
</paramlist>
</method>
<method name="TellI" type="long" overloaded="no">
- <autodoc>TellI() -> long</autodoc>
+ <autodoc>TellI(self) -> long</autodoc>
</method>
</class>
- <class name="OutputStream" oldname="wxOutputStream" module="core">
+ <class name="OutputStream" oldname="wxOutputStream" module="_core">
<method name="write" type="" overloaded="no">
- <autodoc>write(PyObject obj)</autodoc>
+ <autodoc>write(self, PyObject obj)</autodoc>
<paramlist>
<param name="obj" type="PyObject" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="FSFile" oldname="wxFSFile" module="core">
+ <class name="FSFile" oldname="wxFSFile" module="_core">
<baseclass name="Object"/>
<constructor name="FSFile" overloaded="no">
- <autodoc>__init__(InputStream stream, String loc, String mimetype, String anchor,
+ <autodoc>__init__(self, InputStream stream, String loc, String mimetype, String anchor,
DateTime modif) -> FSFile</autodoc>
<paramlist>
<param name="stream" type="wxInputStream" default=""/>
</paramlist>
</constructor>
<destructor name="~wxFSFile" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetStream" type="wxInputStream" overloaded="no">
- <autodoc>GetStream() -> InputStream</autodoc>
+ <autodoc>GetStream(self) -> InputStream</autodoc>
</method>
<method name="GetMimeType" type="String" overloaded="no">
- <autodoc>GetMimeType() -> String</autodoc>
+ <autodoc>GetMimeType(self) -> String</autodoc>
</method>
<method name="GetLocation" type="String" overloaded="no">
- <autodoc>GetLocation() -> String</autodoc>
+ <autodoc>GetLocation(self) -> String</autodoc>
</method>
<method name="GetAnchor" type="String" overloaded="no">
- <autodoc>GetAnchor() -> String</autodoc>
+ <autodoc>GetAnchor(self) -> String</autodoc>
</method>
<method name="GetModificationTime" type="wxDateTime" overloaded="no">
- <autodoc>GetModificationTime() -> DateTime</autodoc>
+ <autodoc>GetModificationTime(self) -> DateTime</autodoc>
</method>
</class>
- <class name="CPPFileSystemHandler" oldname="wxFileSystemHandler" module="core"/>
- <class name="FileSystemHandler" oldname="wxPyFileSystemHandler" module="core">
+ <class name="CPPFileSystemHandler" oldname="wxFileSystemHandler" module="_core"/>
+ <class name="FileSystemHandler" oldname="wxPyFileSystemHandler" module="_core">
<baseclass name="CPPFileSystemHandler"/>
<constructor name="wxPyFileSystemHandler" overloaded="no">
- <autodoc>__init__() -> FileSystemHandler</autodoc>
+ <autodoc>__init__(self) -> FileSystemHandler</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="CanOpen" type="bool" overloaded="no">
- <autodoc>CanOpen(String location) -> bool</autodoc>
+ <autodoc>CanOpen(self, String location) -> bool</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="OpenFile" type="FSFile" overloaded="no">
- <autodoc>OpenFile(FileSystem fs, String location) -> FSFile</autodoc>
+ <autodoc>OpenFile(self, FileSystem fs, String location) -> FSFile</autodoc>
<paramlist>
<param name="fs" type="wxFileSystem" default=""/>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="FindFirst" type="String" overloaded="no">
- <autodoc>FindFirst(String spec, int flags=0) -> String</autodoc>
+ <autodoc>FindFirst(self, String spec, int flags=0) -> String</autodoc>
<paramlist>
<param name="spec" type="String" default=""/>
<param name="flags" type="int" default="0"/>
</paramlist>
</method>
<method name="FindNext" type="String" overloaded="no">
- <autodoc>FindNext() -> String</autodoc>
+ <autodoc>FindNext(self) -> String</autodoc>
</method>
<method name="GetProtocol" type="String" overloaded="no">
- <autodoc>GetProtocol(String location) -> String</autodoc>
+ <autodoc>GetProtocol(self, String location) -> String</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="GetLeftLocation" type="String" overloaded="no">
- <autodoc>GetLeftLocation(String location) -> String</autodoc>
+ <autodoc>GetLeftLocation(self, String location) -> String</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="GetAnchor" type="String" overloaded="no">
- <autodoc>GetAnchor(String location) -> String</autodoc>
+ <autodoc>GetAnchor(self, String location) -> String</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="GetRightLocation" type="String" overloaded="no">
- <autodoc>GetRightLocation(String location) -> String</autodoc>
+ <autodoc>GetRightLocation(self, String location) -> String</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="GetMimeTypeFromExt" type="String" overloaded="no">
- <autodoc>GetMimeTypeFromExt(String location) -> String</autodoc>
+ <autodoc>GetMimeTypeFromExt(self, String location) -> String</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="FileSystem" oldname="wxFileSystem" module="core">
+ <class name="FileSystem" oldname="wxFileSystem" module="_core">
<baseclass name="Object"/>
<constructor name="FileSystem" overloaded="no">
- <autodoc>__init__() -> FileSystem</autodoc>
+ <autodoc>__init__(self) -> FileSystem</autodoc>
</constructor>
<destructor name="~wxFileSystem" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="ChangePathTo" type="" overloaded="no">
- <autodoc>ChangePathTo(String location, bool is_dir=False)</autodoc>
+ <autodoc>ChangePathTo(self, String location, bool is_dir=False)</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
<param name="is_dir" type="bool" default="False"/>
</paramlist>
</method>
<method name="GetPath" type="String" overloaded="no">
- <autodoc>GetPath() -> String</autodoc>
+ <autodoc>GetPath(self) -> String</autodoc>
</method>
<method name="OpenFile" type="FSFile" overloaded="no">
- <autodoc>OpenFile(String location) -> FSFile</autodoc>
+ <autodoc>OpenFile(self, String location) -> FSFile</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="FindFirst" type="String" overloaded="no">
- <autodoc>FindFirst(String spec, int flags=0) -> String</autodoc>
+ <autodoc>FindFirst(self, String spec, int flags=0) -> String</autodoc>
<paramlist>
<param name="spec" type="String" default=""/>
<param name="flags" type="int" default="0"/>
</paramlist>
</method>
<method name="FindNext" type="String" overloaded="no">
- <autodoc>FindNext() -> String</autodoc>
+ <autodoc>FindNext(self) -> String</autodoc>
</method>
<staticmethod name="AddHandler" type="" overloaded="no">
<autodoc>AddHandler(CPPFileSystemHandler handler)</autodoc>
<param name="url" type="String" default=""/>
</paramlist>
</method>
- <class name="InternetFSHandler" oldname="wxInternetFSHandler" module="core">
+ <class name="InternetFSHandler" oldname="wxInternetFSHandler" module="_core">
<baseclass name="CPPFileSystemHandler"/>
<constructor name="InternetFSHandler" overloaded="no">
- <autodoc>__init__() -> InternetFSHandler</autodoc>
+ <autodoc>__init__(self) -> InternetFSHandler</autodoc>
</constructor>
<method name="CanOpen" type="bool" overloaded="no">
- <autodoc>CanOpen(String location) -> bool</autodoc>
+ <autodoc>CanOpen(self, String location) -> bool</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="OpenFile" type="FSFile" overloaded="no">
- <autodoc>OpenFile(FileSystem fs, String location) -> FSFile</autodoc>
+ <autodoc>OpenFile(self, FileSystem fs, String location) -> FSFile</autodoc>
<paramlist>
<param name="fs" type="FileSystem" default=""/>
<param name="location" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="ZipFSHandler" oldname="wxZipFSHandler" module="core">
+ <class name="ZipFSHandler" oldname="wxZipFSHandler" module="_core">
<baseclass name="CPPFileSystemHandler"/>
<constructor name="ZipFSHandler" overloaded="no">
- <autodoc>__init__() -> ZipFSHandler</autodoc>
+ <autodoc>__init__(self) -> ZipFSHandler</autodoc>
</constructor>
<method name="CanOpen" type="bool" overloaded="no">
- <autodoc>CanOpen(String location) -> bool</autodoc>
+ <autodoc>CanOpen(self, String location) -> bool</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="OpenFile" type="FSFile" overloaded="no">
- <autodoc>OpenFile(FileSystem fs, String location) -> FSFile</autodoc>
+ <autodoc>OpenFile(self, FileSystem fs, String location) -> FSFile</autodoc>
<paramlist>
<param name="fs" type="FileSystem" default=""/>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="FindFirst" type="String" overloaded="no">
- <autodoc>FindFirst(String spec, int flags=0) -> String</autodoc>
+ <autodoc>FindFirst(self, String spec, int flags=0) -> String</autodoc>
<paramlist>
<param name="spec" type="String" default=""/>
<param name="flags" type="int" default="0"/>
</paramlist>
</method>
<method name="FindNext" type="String" overloaded="no">
- <autodoc>FindNext() -> String</autodoc>
+ <autodoc>FindNext(self) -> String</autodoc>
</method>
</class>
<method name="__wxMemoryFSHandler_AddFile_wxImage" oldname="__wxMemoryFSHandler_AddFile_wxImage" type="" overloaded="no">
__wxMemoryFSHandler_AddFile_Data(filename, a)
else: raise TypeError, 'wx.Image, wx.Bitmap or string expected'
</pythoncode>
- <class name="MemoryFSHandler" oldname="wxMemoryFSHandler" module="core">
+ <class name="MemoryFSHandler" oldname="wxMemoryFSHandler" module="_core">
<baseclass name="CPPFileSystemHandler"/>
<constructor name="MemoryFSHandler" overloaded="no">
- <autodoc>__init__() -> MemoryFSHandler</autodoc>
+ <autodoc>__init__(self) -> MemoryFSHandler</autodoc>
</constructor>
<staticmethod name="RemoveFile" type="" overloaded="no">
<autodoc>RemoveFile(String filename)</autodoc>
</paramlist>
</staticmethod>
<method name="CanOpen" type="bool" overloaded="no">
- <autodoc>CanOpen(String location) -> bool</autodoc>
+ <autodoc>CanOpen(self, String location) -> bool</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="OpenFile" type="FSFile" overloaded="no">
- <autodoc>OpenFile(FileSystem fs, String location) -> FSFile</autodoc>
+ <autodoc>OpenFile(self, FileSystem fs, String location) -> FSFile</autodoc>
<paramlist>
<param name="fs" type="FileSystem" default=""/>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="FindFirst" type="String" overloaded="no">
- <autodoc>FindFirst(String spec, int flags=0) -> String</autodoc>
+ <autodoc>FindFirst(self, String spec, int flags=0) -> String</autodoc>
<paramlist>
<param name="spec" type="String" default=""/>
<param name="flags" type="int" default="0"/>
</paramlist>
</method>
<method name="FindNext" type="String" overloaded="no">
- <autodoc>FindNext() -> String</autodoc>
+ <autodoc>FindNext(self) -> String</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ImageHandler" oldname="wxImageHandler" module="core">
+ <class name="ImageHandler" oldname="wxImageHandler" module="_core">
<baseclass name="Object"/>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
+ <autodoc>GetName(self) -> String</autodoc>
</method>
<method name="GetExtension" type="String" overloaded="no">
- <autodoc>GetExtension() -> String</autodoc>
+ <autodoc>GetExtension(self) -> String</autodoc>
</method>
<method name="GetType" type="long" overloaded="no">
- <autodoc>GetType() -> long</autodoc>
+ <autodoc>GetType(self) -> long</autodoc>
</method>
<method name="GetMimeType" type="String" overloaded="no">
- <autodoc>GetMimeType() -> String</autodoc>
+ <autodoc>GetMimeType(self) -> String</autodoc>
</method>
<method name="CanRead" type="bool" overloaded="no">
- <autodoc>CanRead(String name) -> bool</autodoc>
+ <autodoc>CanRead(self, String name) -> bool</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="SetName" type="" overloaded="no">
- <autodoc>SetName(String name)</autodoc>
+ <autodoc>SetName(self, String name)</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="SetExtension" type="" overloaded="no">
- <autodoc>SetExtension(String extension)</autodoc>
+ <autodoc>SetExtension(self, String extension)</autodoc>
<paramlist>
<param name="extension" type="String" default=""/>
</paramlist>
</method>
<method name="SetType" type="" overloaded="no">
- <autodoc>SetType(long type)</autodoc>
+ <autodoc>SetType(self, long type)</autodoc>
<paramlist>
<param name="type" type="long" default=""/>
</paramlist>
</method>
<method name="SetMimeType" type="" overloaded="no">
- <autodoc>SetMimeType(String mimetype)</autodoc>
+ <autodoc>SetMimeType(self, String mimetype)</autodoc>
<paramlist>
<param name="mimetype" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="ImageHistogram" oldname="wxImageHistogram" module="core">
+ <class name="ImageHistogram" oldname="wxImageHistogram" module="_core">
<constructor name="ImageHistogram" overloaded="no">
- <autodoc>__init__() -> ImageHistogram</autodoc>
+ <autodoc>__init__(self) -> ImageHistogram</autodoc>
</constructor>
<staticmethod name="MakeKey" type="unsigned long" overloaded="no">
<autodoc>MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long</autodoc>
</staticmethod>
<method name="FindFirstUnusedColour" type="bool" overloaded="no">
<autodoc>FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)</autodoc>
- <docstring>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.</docstring>
<paramlist>
<param name="OUTPUT" type="unsigned char" default=""/>
<param name="OUTPUT" type="unsigned char" default=""/>
</paramlist>
</method>
</class>
- <class name="Image" oldname="wxImage" module="core">
+ <class name="Image" oldname="wxImage" module="_core">
<baseclass name="Object"/>
<constructor name="Image" overloaded="no">
- <autodoc>__init__(String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image</autodoc>
+ <autodoc>__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="type" type="long" default="wxBITMAP_TYPE_ANY"/>
</paramlist>
</constructor>
<destructor name="~wxImage" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Create" type="" overloaded="no">
- <autodoc>Create(int width, int height)</autodoc>
+ <autodoc>Create(self, int width, int height)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="Destroy" type="" overloaded="no">
- <autodoc>Destroy()</autodoc>
+ <autodoc>Destroy(self)</autodoc>
<docstring>Deletes the C++ object this Python object is a proxy for.</docstring>
</method>
<method name="Scale" type="Image" overloaded="no">
- <autodoc>Scale(int width, int height) -> Image</autodoc>
+ <autodoc>Scale(self, int width, int height) -> Image</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="ShrinkBy" type="Image" overloaded="no">
- <autodoc>ShrinkBy(int xFactor, int yFactor) -> Image</autodoc>
+ <autodoc>ShrinkBy(self, int xFactor, int yFactor) -> Image</autodoc>
<paramlist>
<param name="xFactor" type="int" default=""/>
<param name="yFactor" type="int" default=""/>
</paramlist>
</method>
<method name="Rescale" type="Image" overloaded="no">
- <autodoc>Rescale(int width, int height) -> Image</autodoc>
+ <autodoc>Rescale(self, int width, int height) -> Image</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="SetRGB" type="" overloaded="no">
- <autodoc>SetRGB(int x, int y, unsigned char r, unsigned char g, unsigned char b)</autodoc>
+ <autodoc>SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="GetRed" type="unsigned char" overloaded="no">
- <autodoc>GetRed(int x, int y) -> unsigned char</autodoc>
+ <autodoc>GetRed(self, int x, int y) -> unsigned char</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="GetGreen" type="unsigned char" overloaded="no">
- <autodoc>GetGreen(int x, int y) -> unsigned char</autodoc>
+ <autodoc>GetGreen(self, int x, int y) -> unsigned char</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="GetBlue" type="unsigned char" overloaded="no">
- <autodoc>GetBlue(int x, int y) -> unsigned char</autodoc>
+ <autodoc>GetBlue(self, int x, int y) -> unsigned char</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="SetAlpha" type="" overloaded="no">
- <autodoc>SetAlpha(int x, int y, unsigned char alpha)</autodoc>
+ <autodoc>SetAlpha(self, int x, int y, unsigned char alpha)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="GetAlpha" type="unsigned char" overloaded="no">
- <autodoc>GetAlpha(int x, int y) -> unsigned char</autodoc>
+ <autodoc>GetAlpha(self, int x, int y) -> unsigned char</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="HasAlpha" type="bool" overloaded="no">
- <autodoc>HasAlpha() -> bool</autodoc>
+ <autodoc>HasAlpha(self) -> bool</autodoc>
</method>
<method name="FindFirstUnusedColour" type="bool" overloaded="no">
<autodoc>FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)</autodoc>
- <docstring>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.</docstring>
<paramlist>
<param name="OUTPUT" type="byte" default=""/>
<param name="OUTPUT" type="byte" default=""/>
</paramlist>
</method>
<method name="SetMaskFromImage" type="bool" overloaded="no">
- <autodoc>SetMaskFromImage(Image mask, byte mr, byte mg, byte mb) -> bool</autodoc>
+ <autodoc>SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool</autodoc>
<paramlist>
<param name="mask" type="Image" default=""/>
<param name="mr" type="byte" default=""/>
</paramlist>
</staticmethod>
<method name="LoadFile" type="bool" overloaded="no">
- <autodoc>LoadFile(String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool</autodoc>
+ <autodoc>LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="type" type="long" default="wxBITMAP_TYPE_ANY"/>
</paramlist>
</method>
<method name="LoadMimeFile" type="bool" overloaded="no">
- <autodoc>LoadMimeFile(String name, String mimetype, int index=-1) -> bool</autodoc>
+ <autodoc>LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="mimetype" type="String" default=""/>
</paramlist>
</method>
<method name="SaveFile" type="bool" overloaded="no">
- <autodoc>SaveFile(String name, int type) -> bool</autodoc>
+ <autodoc>SaveFile(self, String name, int type) -> bool</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="type" type="int" default=""/>
</paramlist>
</method>
<method name="SaveMimeFile" type="bool" overloaded="no">
- <autodoc>SaveMimeFile(String name, String mimetype) -> bool</autodoc>
+ <autodoc>SaveMimeFile(self, String name, String mimetype) -> bool</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="mimetype" type="String" default=""/>
</paramlist>
</staticmethod>
<method name="LoadStream" type="bool" overloaded="no">
- <autodoc>LoadStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool</autodoc>
+ <autodoc>LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool</autodoc>
<paramlist>
<param name="stream" type="wxInputStream" default=""/>
<param name="type" type="long" default="wxBITMAP_TYPE_ANY"/>
</paramlist>
</method>
<method name="LoadMimeStream" type="bool" overloaded="no">
- <autodoc>LoadMimeStream(InputStream stream, String mimetype, int index=-1) -> bool</autodoc>
+ <autodoc>LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool</autodoc>
<paramlist>
<param name="stream" type="wxInputStream" default=""/>
<param name="mimetype" type="String" default=""/>
</paramlist>
</method>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
<method name="GetWidth" type="int" overloaded="no">
- <autodoc>GetWidth() -> int</autodoc>
+ <autodoc>GetWidth(self) -> int</autodoc>
</method>
<method name="GetHeight" type="int" overloaded="no">
- <autodoc>GetHeight() -> int</autodoc>
+ <autodoc>GetHeight(self) -> int</autodoc>
+ </method>
+ <method name="GetSize" type="Size" overloaded="no">
+ <autodoc>GetSize(self) -> Size</autodoc>
</method>
<method name="GetSubImage" type="Image" overloaded="no">
- <autodoc>GetSubImage(Rect rect) -> Image</autodoc>
+ <autodoc>GetSubImage(self, Rect rect) -> Image</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="Copy" type="Image" overloaded="no">
- <autodoc>Copy() -> Image</autodoc>
+ <autodoc>Copy(self) -> Image</autodoc>
</method>
<method name="Paste" type="" overloaded="no">
- <autodoc>Paste(Image image, int x, int y)</autodoc>
+ <autodoc>Paste(self, Image image, int x, int y)</autodoc>
<paramlist>
<param name="image" type="Image" default=""/>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="GetData" type="PyObject" overloaded="no">
- <autodoc>GetData() -> PyObject</autodoc>
+ <autodoc>GetData(self) -> PyObject</autodoc>
</method>
<method name="SetData" type="" overloaded="no">
- <autodoc>SetData(PyObject data)</autodoc>
+ <autodoc>SetData(self, PyObject data)</autodoc>
<paramlist>
<param name="data" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetDataBuffer" type="PyObject" overloaded="no">
- <autodoc>GetDataBuffer() -> PyObject</autodoc>
+ <autodoc>GetDataBuffer(self) -> PyObject</autodoc>
</method>
<method name="SetDataBuffer" type="" overloaded="no">
- <autodoc>SetDataBuffer(PyObject data)</autodoc>
+ <autodoc>SetDataBuffer(self, PyObject data)</autodoc>
<paramlist>
<param name="data" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetAlphaData" type="PyObject" overloaded="no">
- <autodoc>GetAlphaData() -> PyObject</autodoc>
+ <autodoc>GetAlphaData(self) -> PyObject</autodoc>
</method>
<method name="SetAlphaData" type="" overloaded="no">
- <autodoc>SetAlphaData(PyObject data)</autodoc>
+ <autodoc>SetAlphaData(self, PyObject data)</autodoc>
<paramlist>
<param name="data" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetAlphaBuffer" type="PyObject" overloaded="no">
- <autodoc>GetAlphaBuffer() -> PyObject</autodoc>
+ <autodoc>GetAlphaBuffer(self) -> PyObject</autodoc>
</method>
<method name="SetAlphaBuffer" type="" overloaded="no">
- <autodoc>SetAlphaBuffer(PyObject data)</autodoc>
+ <autodoc>SetAlphaBuffer(self, PyObject data)</autodoc>
<paramlist>
<param name="data" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetMaskColour" type="" overloaded="no">
- <autodoc>SetMaskColour(unsigned char r, unsigned char g, unsigned char b)</autodoc>
+ <autodoc>SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)</autodoc>
<paramlist>
<param name="r" type="unsigned char" default=""/>
<param name="g" type="unsigned char" default=""/>
</paramlist>
</method>
<method name="GetMaskRed" type="unsigned char" overloaded="no">
- <autodoc>GetMaskRed() -> unsigned char</autodoc>
+ <autodoc>GetMaskRed(self) -> unsigned char</autodoc>
</method>
<method name="GetMaskGreen" type="unsigned char" overloaded="no">
- <autodoc>GetMaskGreen() -> unsigned char</autodoc>
+ <autodoc>GetMaskGreen(self) -> unsigned char</autodoc>
</method>
<method name="GetMaskBlue" type="unsigned char" overloaded="no">
- <autodoc>GetMaskBlue() -> unsigned char</autodoc>
+ <autodoc>GetMaskBlue(self) -> unsigned char</autodoc>
</method>
<method name="SetMask" type="" overloaded="no">
- <autodoc>SetMask(bool mask=True)</autodoc>
+ <autodoc>SetMask(self, bool mask=True)</autodoc>
<paramlist>
<param name="mask" type="bool" default="True"/>
</paramlist>
</method>
<method name="HasMask" type="bool" overloaded="no">
- <autodoc>HasMask() -> bool</autodoc>
+ <autodoc>HasMask(self) -> bool</autodoc>
</method>
<method name="Rotate" type="Image" overloaded="no">
- <autodoc>Rotate(double angle, Point centre_of_rotation, bool interpolating=True,
+ <autodoc>Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
Point offset_after_rotation=None) -> Image</autodoc>
<paramlist>
<param name="angle" type="double" default=""/>
</paramlist>
</method>
<method name="Rotate90" type="Image" overloaded="no">
- <autodoc>Rotate90(bool clockwise=True) -> Image</autodoc>
+ <autodoc>Rotate90(self, bool clockwise=True) -> Image</autodoc>
<paramlist>
<param name="clockwise" type="bool" default="True"/>
</paramlist>
</method>
<method name="Mirror" type="Image" overloaded="no">
- <autodoc>Mirror(bool horizontally=True) -> Image</autodoc>
+ <autodoc>Mirror(self, bool horizontally=True) -> Image</autodoc>
<paramlist>
<param name="horizontally" type="bool" default="True"/>
</paramlist>
</method>
<method name="Replace" type="" overloaded="no">
- <autodoc>Replace(unsigned char r1, unsigned char g1, unsigned char b1,
+ <autodoc>Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
unsigned char r2, unsigned char g2, unsigned char b2)</autodoc>
<paramlist>
<param name="r1" type="unsigned char" default=""/>
</paramlist>
</method>
<method name="ConvertToMono" type="Image" overloaded="no">
- <autodoc>ConvertToMono(unsigned char r, unsigned char g, unsigned char b) -> Image</autodoc>
+ <autodoc>ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image</autodoc>
<paramlist>
<param name="r" type="unsigned char" default=""/>
<param name="g" type="unsigned char" default=""/>
</paramlist>
</method>
<method name="SetOption" type="" overloaded="no">
- <autodoc>SetOption(String name, String value)</autodoc>
+ <autodoc>SetOption(self, String name, String value)</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="value" type="String" default=""/>
</paramlist>
</method>
<method name="SetOptionInt" type="" overloaded="no">
- <autodoc>SetOptionInt(String name, int value)</autodoc>
+ <autodoc>SetOptionInt(self, String name, int value)</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="value" type="int" default=""/>
</paramlist>
</method>
<method name="GetOption" type="String" overloaded="no">
- <autodoc>GetOption(String name) -> String</autodoc>
+ <autodoc>GetOption(self, String name) -> String</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="GetOptionInt" type="int" overloaded="no">
- <autodoc>GetOptionInt(String name) -> int</autodoc>
+ <autodoc>GetOptionInt(self, String name) -> int</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="HasOption" type="bool" overloaded="no">
- <autodoc>HasOption(String name) -> bool</autodoc>
+ <autodoc>HasOption(self, String name) -> bool</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="CountColours" type="unsigned long" overloaded="no">
- <autodoc>CountColours(unsigned long stopafter=(unsigned long) -1) -> unsigned long</autodoc>
+ <autodoc>CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long</autodoc>
<paramlist>
<param name="stopafter" type="unsigned long" default="(unsigned long) -1"/>
</paramlist>
</method>
<method name="ComputeHistogram" type="unsigned long" overloaded="no">
- <autodoc>ComputeHistogram(ImageHistogram h) -> unsigned long</autodoc>
+ <autodoc>ComputeHistogram(self, ImageHistogram h) -> unsigned long</autodoc>
<paramlist>
<param name="h" type="ImageHistogram" default=""/>
</paramlist>
<autodoc>GetImageExtWildcard() -> String</autodoc>
</staticmethod>
<method name="ConvertToBitmap" type="wxBitmap" overloaded="no">
- <autodoc>ConvertToBitmap() -> Bitmap</autodoc>
+ <autodoc>ConvertToBitmap(self) -> Bitmap</autodoc>
</method>
<method name="ConvertToMonoBitmap" type="wxBitmap" overloaded="no">
- <autodoc>ConvertToMonoBitmap(unsigned char red, unsigned char green, unsigned char blue) -> Bitmap</autodoc>
+ <autodoc>ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap</autodoc>
<paramlist>
<param name="red" type="unsigned char" default=""/>
<param name="green" type="unsigned char" default=""/>
</paramlist>
</method>
</class>
- <method name="InitAllImageHandlers" oldname="wxInitAllImageHandlers" type="" overloaded="no">
- <autodoc>InitAllImageHandlers()</autodoc>
- </method>
- <class name="BMPHandler" oldname="wxBMPHandler" module="core">
+ <pythoncode>
+ def InitAllImageHandlers():
+ """
+ The former functionality of InitAllImageHanders is now done internal to
+ the _core_ extension module and so this function has become a simple NOP.
+ """
+ pass
+</pythoncode>
+ <class name="BMPHandler" oldname="wxBMPHandler" module="_core">
<baseclass name="ImageHandler"/>
<constructor name="BMPHandler" overloaded="no">
- <autodoc>__init__() -> BMPHandler</autodoc>
+ <autodoc>__init__(self) -> BMPHandler</autodoc>
</constructor>
</class>
- <class name="ICOHandler" oldname="wxICOHandler" module="core">
+ <class name="ICOHandler" oldname="wxICOHandler" module="_core">
<baseclass name="BMPHandler"/>
<constructor name="ICOHandler" overloaded="no">
- <autodoc>__init__() -> ICOHandler</autodoc>
+ <autodoc>__init__(self) -> ICOHandler</autodoc>
</constructor>
</class>
- <class name="CURHandler" oldname="wxCURHandler" module="core">
+ <class name="CURHandler" oldname="wxCURHandler" module="_core">
<baseclass name="ICOHandler"/>
<constructor name="CURHandler" overloaded="no">
- <autodoc>__init__() -> CURHandler</autodoc>
+ <autodoc>__init__(self) -> CURHandler</autodoc>
</constructor>
</class>
- <class name="ANIHandler" oldname="wxANIHandler" module="core">
+ <class name="ANIHandler" oldname="wxANIHandler" module="_core">
<baseclass name="CURHandler"/>
<constructor name="ANIHandler" overloaded="no">
- <autodoc>__init__() -> ANIHandler</autodoc>
+ <autodoc>__init__(self) -> ANIHandler</autodoc>
</constructor>
</class>
- <class name="PNGHandler" oldname="wxPNGHandler" module="core">
+ <class name="PNGHandler" oldname="wxPNGHandler" module="_core">
<baseclass name="ImageHandler"/>
<constructor name="PNGHandler" overloaded="no">
- <autodoc>__init__() -> PNGHandler</autodoc>
+ <autodoc>__init__(self) -> PNGHandler</autodoc>
</constructor>
</class>
- <class name="GIFHandler" oldname="wxGIFHandler" module="core">
+ <class name="GIFHandler" oldname="wxGIFHandler" module="_core">
<baseclass name="ImageHandler"/>
<constructor name="GIFHandler" overloaded="no">
- <autodoc>__init__() -> GIFHandler</autodoc>
+ <autodoc>__init__(self) -> GIFHandler</autodoc>
</constructor>
</class>
- <class name="PCXHandler" oldname="wxPCXHandler" module="core">
+ <class name="PCXHandler" oldname="wxPCXHandler" module="_core">
<baseclass name="ImageHandler"/>
<constructor name="PCXHandler" overloaded="no">
- <autodoc>__init__() -> PCXHandler</autodoc>
+ <autodoc>__init__(self) -> PCXHandler</autodoc>
</constructor>
</class>
- <class name="JPEGHandler" oldname="wxJPEGHandler" module="core">
+ <class name="JPEGHandler" oldname="wxJPEGHandler" module="_core">
<baseclass name="ImageHandler"/>
<constructor name="JPEGHandler" overloaded="no">
- <autodoc>__init__() -> JPEGHandler</autodoc>
+ <autodoc>__init__(self) -> JPEGHandler</autodoc>
</constructor>
</class>
- <class name="PNMHandler" oldname="wxPNMHandler" module="core">
+ <class name="PNMHandler" oldname="wxPNMHandler" module="_core">
<baseclass name="ImageHandler"/>
<constructor name="PNMHandler" overloaded="no">
- <autodoc>__init__() -> PNMHandler</autodoc>
+ <autodoc>__init__(self) -> PNMHandler</autodoc>
</constructor>
</class>
- <class name="XPMHandler" oldname="wxXPMHandler" module="core">
+ <class name="XPMHandler" oldname="wxXPMHandler" module="_core">
<baseclass name="ImageHandler"/>
<constructor name="XPMHandler" overloaded="no">
- <autodoc>__init__() -> XPMHandler</autodoc>
+ <autodoc>__init__(self) -> XPMHandler</autodoc>
</constructor>
</class>
- <class name="TIFFHandler" oldname="wxTIFFHandler" module="core">
+ <class name="TIFFHandler" oldname="wxTIFFHandler" module="_core">
<baseclass name="ImageHandler"/>
<constructor name="TIFFHandler" overloaded="no">
- <autodoc>__init__() -> TIFFHandler</autodoc>
+ <autodoc>__init__(self) -> TIFFHandler</autodoc>
</constructor>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="EvtHandler" oldname="wxEvtHandler" module="core">
+ <class name="EvtHandler" oldname="wxEvtHandler" module="_core">
<baseclass name="Object"/>
<constructor name="EvtHandler" overloaded="no">
- <autodoc>__init__() -> EvtHandler</autodoc>
+ <autodoc>__init__(self) -> EvtHandler</autodoc>
</constructor>
<method name="GetNextHandler" type="EvtHandler" overloaded="no">
- <autodoc>GetNextHandler() -> EvtHandler</autodoc>
+ <autodoc>GetNextHandler(self) -> EvtHandler</autodoc>
</method>
<method name="GetPreviousHandler" type="EvtHandler" overloaded="no">
- <autodoc>GetPreviousHandler() -> EvtHandler</autodoc>
+ <autodoc>GetPreviousHandler(self) -> EvtHandler</autodoc>
</method>
<method name="SetNextHandler" type="" overloaded="no">
- <autodoc>SetNextHandler(EvtHandler handler)</autodoc>
+ <autodoc>SetNextHandler(self, EvtHandler handler)</autodoc>
<paramlist>
<param name="handler" type="EvtHandler" default=""/>
</paramlist>
</method>
<method name="SetPreviousHandler" type="" overloaded="no">
- <autodoc>SetPreviousHandler(EvtHandler handler)</autodoc>
+ <autodoc>SetPreviousHandler(self, EvtHandler handler)</autodoc>
<paramlist>
<param name="handler" type="EvtHandler" default=""/>
</paramlist>
</method>
<method name="GetEvtHandlerEnabled" type="bool" overloaded="no">
- <autodoc>GetEvtHandlerEnabled() -> bool</autodoc>
+ <autodoc>GetEvtHandlerEnabled(self) -> bool</autodoc>
</method>
<method name="SetEvtHandlerEnabled" type="" overloaded="no">
- <autodoc>SetEvtHandlerEnabled(bool enabled)</autodoc>
+ <autodoc>SetEvtHandlerEnabled(self, bool enabled)</autodoc>
<paramlist>
<param name="enabled" type="bool" default=""/>
</paramlist>
</method>
<method name="ProcessEvent" type="bool" overloaded="no">
- <autodoc>ProcessEvent(Event event) -> bool</autodoc>
+ <autodoc>ProcessEvent(self, Event event) -> bool</autodoc>
<paramlist>
<param name="event" type="wxEvent" default=""/>
</paramlist>
</method>
<method name="AddPendingEvent" type="" overloaded="no">
- <autodoc>AddPendingEvent(Event event)</autodoc>
+ <autodoc>AddPendingEvent(self, Event event)</autodoc>
<paramlist>
<param name="event" type="wxEvent" default=""/>
</paramlist>
</method>
<method name="ProcessPendingEvents" type="" overloaded="no">
- <autodoc>ProcessPendingEvents()</autodoc>
+ <autodoc>ProcessPendingEvents(self)</autodoc>
</method>
<method name="Connect" type="" overloaded="no">
- <autodoc>Connect(int id, int lastId, int eventType, PyObject func)</autodoc>
+ <autodoc>Connect(self, int id, int lastId, int eventType, PyObject func)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="lastId" type="int" default=""/>
</paramlist>
</method>
<method name="Disconnect" type="bool" overloaded="no">
- <autodoc>Disconnect(int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool</autodoc>
+ <autodoc>Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="lastId" type="int" default="-1"/>
</paramlist>
</method>
<method name="_setOORInfo" type="" overloaded="no">
- <autodoc>_setOORInfo(PyObject _self)</autodoc>
+ <autodoc>_setOORInfo(self, PyObject _self)</autodoc>
<paramlist>
<param name="_self" type="PyObject" default=""/>
</paramlist>
for et in self.evtType:
target.Connect(id1, id2, et, function)
+
+ def Unbind(self, target, id1, id2):
+ """Remove an event binding."""
+ success = 0
+ for et in self.evtType:
+ success += target.Disconnect(id1, id2, et)
+ return success != 0
+
def __call__(self, *args):
"""
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Event" oldname="wxEvent" module="core">
+ <class name="Event" oldname="wxEvent" module="_core">
<baseclass name="Object"/>
<destructor name="~wxEvent" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetEventType" type="" overloaded="no">
- <autodoc>SetEventType(wxEventType typ)</autodoc>
+ <autodoc>SetEventType(self, wxEventType typ)</autodoc>
<paramlist>
<param name="typ" type="wxEventType" default=""/>
</paramlist>
</method>
<method name="GetEventType" type="wxEventType" overloaded="no">
- <autodoc>GetEventType() -> wxEventType</autodoc>
+ <autodoc>GetEventType(self) -> wxEventType</autodoc>
</method>
<method name="GetEventObject" type="Object" overloaded="no">
- <autodoc>GetEventObject() -> Object</autodoc>
+ <autodoc>GetEventObject(self) -> Object</autodoc>
</method>
<method name="SetEventObject" type="" overloaded="no">
- <autodoc>SetEventObject(Object obj)</autodoc>
+ <autodoc>SetEventObject(self, Object obj)</autodoc>
<paramlist>
<param name="obj" type="Object" default=""/>
</paramlist>
</method>
<method name="GetTimestamp" type="long" overloaded="no">
- <autodoc>GetTimestamp() -> long</autodoc>
+ <autodoc>GetTimestamp(self) -> long</autodoc>
</method>
<method name="SetTimestamp" type="" overloaded="no">
- <autodoc>SetTimestamp(long ts=0)</autodoc>
+ <autodoc>SetTimestamp(self, long ts=0)</autodoc>
<paramlist>
<param name="ts" type="long" default="0"/>
</paramlist>
</method>
<method name="GetId" type="int" overloaded="no">
- <autodoc>GetId() -> int</autodoc>
+ <autodoc>GetId(self) -> int</autodoc>
</method>
<method name="SetId" type="" overloaded="no">
- <autodoc>SetId(int Id)</autodoc>
+ <autodoc>SetId(self, int Id)</autodoc>
<paramlist>
<param name="Id" type="int" default=""/>
</paramlist>
</method>
<method name="IsCommandEvent" type="bool" overloaded="no">
- <autodoc>IsCommandEvent() -> bool</autodoc>
+ <autodoc>IsCommandEvent(self) -> bool</autodoc>
</method>
<method name="Skip" type="" overloaded="no">
- <autodoc>Skip(bool skip=True)</autodoc>
+ <autodoc>Skip(self, bool skip=True)</autodoc>
<paramlist>
<param name="skip" type="bool" default="True"/>
</paramlist>
</method>
<method name="GetSkipped" type="bool" overloaded="no">
- <autodoc>GetSkipped() -> bool</autodoc>
+ <autodoc>GetSkipped(self) -> bool</autodoc>
</method>
<method name="ShouldPropagate" type="bool" overloaded="no">
- <autodoc>ShouldPropagate() -> bool</autodoc>
+ <autodoc>ShouldPropagate(self) -> bool</autodoc>
</method>
<method name="StopPropagation" type="int" overloaded="no">
- <autodoc>StopPropagation() -> int</autodoc>
+ <autodoc>StopPropagation(self) -> int</autodoc>
</method>
<method name="ResumePropagation" type="" overloaded="no">
- <autodoc>ResumePropagation(int propagationLevel)</autodoc>
+ <autodoc>ResumePropagation(self, int propagationLevel)</autodoc>
<paramlist>
<param name="propagationLevel" type="int" default=""/>
</paramlist>
</method>
<method name="Clone" type="Event" overloaded="no">
- <autodoc>Clone() -> Event</autodoc>
+ <autodoc>Clone(self) -> Event</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PropagationDisabler" oldname="wxPropagationDisabler" module="core">
+ <class name="PropagationDisabler" oldname="wxPropagationDisabler" module="_core">
<constructor name="PropagationDisabler" overloaded="no">
- <autodoc>__init__(Event event) -> PropagationDisabler</autodoc>
+ <autodoc>__init__(self, Event event) -> PropagationDisabler</autodoc>
<paramlist>
<param name="event" type="Event" default=""/>
</paramlist>
</constructor>
<destructor name="~wxPropagationDisabler" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
</class>
- <class name="PropagateOnce" oldname="wxPropagateOnce" module="core">
+ <class name="PropagateOnce" oldname="wxPropagateOnce" module="_core">
<constructor name="PropagateOnce" overloaded="no">
- <autodoc>__init__(Event event) -> PropagateOnce</autodoc>
+ <autodoc>__init__(self, Event event) -> PropagateOnce</autodoc>
<paramlist>
<param name="event" type="Event" default=""/>
</paramlist>
</constructor>
<destructor name="~wxPropagateOnce" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="CommandEvent" oldname="wxCommandEvent" module="core">
+ <class name="CommandEvent" oldname="wxCommandEvent" module="_core">
<baseclass name="Event"/>
<constructor name="CommandEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent</autodoc>
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
<param name="winid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetSelection" type="int" overloaded="no">
- <autodoc>GetSelection() -> int</autodoc>
+ <autodoc>GetSelection(self) -> int</autodoc>
</method>
<method name="SetString" type="" overloaded="no">
- <autodoc>SetString(String s)</autodoc>
+ <autodoc>SetString(self, String s)</autodoc>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="GetString" type="String" overloaded="no">
- <autodoc>GetString() -> String</autodoc>
+ <autodoc>GetString(self) -> String</autodoc>
</method>
<method name="IsChecked" type="bool" overloaded="no">
- <autodoc>IsChecked() -> bool</autodoc>
+ <autodoc>IsChecked(self) -> bool</autodoc>
</method>
<method name="IsSelection" type="bool" overloaded="no">
- <autodoc>IsSelection() -> bool</autodoc>
+ <autodoc>IsSelection(self) -> bool</autodoc>
</method>
<method name="SetExtraLong" type="" overloaded="no">
- <autodoc>SetExtraLong(long extraLong)</autodoc>
+ <autodoc>SetExtraLong(self, long extraLong)</autodoc>
<paramlist>
<param name="extraLong" type="long" default=""/>
</paramlist>
</method>
<method name="GetExtraLong" type="long" overloaded="no">
- <autodoc>GetExtraLong() -> long</autodoc>
+ <autodoc>GetExtraLong(self) -> long</autodoc>
</method>
<method name="SetInt" type="" overloaded="no">
- <autodoc>SetInt(int i)</autodoc>
+ <autodoc>SetInt(self, int i)</autodoc>
<paramlist>
<param name="i" type="int" default=""/>
</paramlist>
</method>
<method name="GetInt" type="long" overloaded="no">
- <autodoc>GetInt() -> long</autodoc>
+ <autodoc>GetInt(self) -> long</autodoc>
</method>
<method name="Clone" type="Event" overloaded="no">
- <autodoc>Clone() -> Event</autodoc>
+ <autodoc>Clone(self) -> Event</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="NotifyEvent" oldname="wxNotifyEvent" module="core">
+ <class name="NotifyEvent" oldname="wxNotifyEvent" module="_core">
<baseclass name="CommandEvent"/>
<constructor name="NotifyEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent</autodoc>
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
<param name="winid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="Veto" type="" overloaded="no">
- <autodoc>Veto()</autodoc>
+ <autodoc>Veto(self)</autodoc>
</method>
<method name="Allow" type="" overloaded="no">
- <autodoc>Allow()</autodoc>
+ <autodoc>Allow(self)</autodoc>
</method>
<method name="IsAllowed" type="bool" overloaded="no">
- <autodoc>IsAllowed() -> bool</autodoc>
+ <autodoc>IsAllowed(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ScrollEvent" oldname="wxScrollEvent" module="core">
+ <class name="ScrollEvent" oldname="wxScrollEvent" module="_core">
<baseclass name="CommandEvent"/>
<constructor name="ScrollEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
int orient=0) -> ScrollEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
</paramlist>
</constructor>
<method name="GetOrientation" type="int" overloaded="no">
- <autodoc>GetOrientation() -> int</autodoc>
+ <autodoc>GetOrientation(self) -> int</autodoc>
</method>
<method name="GetPosition" type="int" overloaded="no">
- <autodoc>GetPosition() -> int</autodoc>
+ <autodoc>GetPosition(self) -> int</autodoc>
</method>
<method name="SetOrientation" type="" overloaded="no">
- <autodoc>SetOrientation(int orient)</autodoc>
+ <autodoc>SetOrientation(self, int orient)</autodoc>
<paramlist>
<param name="orient" type="int" default=""/>
</paramlist>
</method>
<method name="SetPosition" type="" overloaded="no">
- <autodoc>SetPosition(int pos)</autodoc>
+ <autodoc>SetPosition(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ScrollWinEvent" oldname="wxScrollWinEvent" module="core">
+ <class name="ScrollWinEvent" oldname="wxScrollWinEvent" module="_core">
<baseclass name="Event"/>
<constructor name="ScrollWinEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent</autodoc>
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
<param name="pos" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetOrientation" type="int" overloaded="no">
- <autodoc>GetOrientation() -> int</autodoc>
+ <autodoc>GetOrientation(self) -> int</autodoc>
</method>
<method name="GetPosition" type="int" overloaded="no">
- <autodoc>GetPosition() -> int</autodoc>
+ <autodoc>GetPosition(self) -> int</autodoc>
</method>
<method name="SetOrientation" type="" overloaded="no">
- <autodoc>SetOrientation(int orient)</autodoc>
+ <autodoc>SetOrientation(self, int orient)</autodoc>
<paramlist>
<param name="orient" type="int" default=""/>
</paramlist>
</method>
<method name="SetPosition" type="" overloaded="no">
- <autodoc>SetPosition(int pos)</autodoc>
+ <autodoc>SetPosition(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MouseEvent" oldname="wxMouseEvent" module="core">
+ <class name="MouseEvent" oldname="wxMouseEvent" module="_core">
<baseclass name="Event"/>
<constructor name="MouseEvent" overloaded="no">
- <autodoc>__init__(wxEventType mouseType=wxEVT_NULL) -> MouseEvent</autodoc>
+ <autodoc>__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent</autodoc>
<paramlist>
<param name="mouseType" type="wxEventType" default="wxEVT_NULL"/>
</paramlist>
</constructor>
<method name="IsButton" type="bool" overloaded="no">
- <autodoc>IsButton() -> bool</autodoc>
+ <autodoc>IsButton(self) -> bool</autodoc>
</method>
<method name="ButtonDown" type="bool" overloaded="no">
- <autodoc>ButtonDown(int but=MOUSE_BTN_ANY) -> bool</autodoc>
+ <autodoc>ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool</autodoc>
<paramlist>
<param name="but" type="int" default="wxMOUSE_BTN_ANY"/>
</paramlist>
</method>
<method name="ButtonDClick" type="bool" overloaded="no">
- <autodoc>ButtonDClick(int but=MOUSE_BTN_ANY) -> bool</autodoc>
+ <autodoc>ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool</autodoc>
<paramlist>
<param name="but" type="int" default="wxMOUSE_BTN_ANY"/>
</paramlist>
</method>
<method name="ButtonUp" type="bool" overloaded="no">
- <autodoc>ButtonUp(int but=MOUSE_BTN_ANY) -> bool</autodoc>
+ <autodoc>ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool</autodoc>
<paramlist>
<param name="but" type="int" default="wxMOUSE_BTN_ANY"/>
</paramlist>
</method>
<method name="Button" type="bool" overloaded="no">
- <autodoc>Button(int but) -> bool</autodoc>
+ <autodoc>Button(self, int but) -> bool</autodoc>
<paramlist>
<param name="but" type="int" default=""/>
</paramlist>
</method>
<method name="ButtonIsDown" type="bool" overloaded="no">
- <autodoc>ButtonIsDown(int but) -> bool</autodoc>
+ <autodoc>ButtonIsDown(self, int but) -> bool</autodoc>
<paramlist>
<param name="but" type="int" default=""/>
</paramlist>
</method>
<method name="GetButton" type="int" overloaded="no">
- <autodoc>GetButton() -> int</autodoc>
+ <autodoc>GetButton(self) -> int</autodoc>
</method>
<method name="ControlDown" type="bool" overloaded="no">
- <autodoc>ControlDown() -> bool</autodoc>
+ <autodoc>ControlDown(self) -> bool</autodoc>
</method>
<method name="MetaDown" type="bool" overloaded="no">
- <autodoc>MetaDown() -> bool</autodoc>
+ <autodoc>MetaDown(self) -> bool</autodoc>
</method>
<method name="AltDown" type="bool" overloaded="no">
- <autodoc>AltDown() -> bool</autodoc>
+ <autodoc>AltDown(self) -> bool</autodoc>
</method>
<method name="ShiftDown" type="bool" overloaded="no">
- <autodoc>ShiftDown() -> bool</autodoc>
+ <autodoc>ShiftDown(self) -> bool</autodoc>
</method>
<method name="LeftDown" type="bool" overloaded="no">
- <autodoc>LeftDown() -> bool</autodoc>
+ <autodoc>LeftDown(self) -> bool</autodoc>
</method>
<method name="MiddleDown" type="bool" overloaded="no">
- <autodoc>MiddleDown() -> bool</autodoc>
+ <autodoc>MiddleDown(self) -> bool</autodoc>
</method>
<method name="RightDown" type="bool" overloaded="no">
- <autodoc>RightDown() -> bool</autodoc>
+ <autodoc>RightDown(self) -> bool</autodoc>
</method>
<method name="LeftUp" type="bool" overloaded="no">
- <autodoc>LeftUp() -> bool</autodoc>
+ <autodoc>LeftUp(self) -> bool</autodoc>
</method>
<method name="MiddleUp" type="bool" overloaded="no">
- <autodoc>MiddleUp() -> bool</autodoc>
+ <autodoc>MiddleUp(self) -> bool</autodoc>
</method>
<method name="RightUp" type="bool" overloaded="no">
- <autodoc>RightUp() -> bool</autodoc>
+ <autodoc>RightUp(self) -> bool</autodoc>
</method>
<method name="LeftDClick" type="bool" overloaded="no">
- <autodoc>LeftDClick() -> bool</autodoc>
+ <autodoc>LeftDClick(self) -> bool</autodoc>
</method>
<method name="MiddleDClick" type="bool" overloaded="no">
- <autodoc>MiddleDClick() -> bool</autodoc>
+ <autodoc>MiddleDClick(self) -> bool</autodoc>
</method>
<method name="RightDClick" type="bool" overloaded="no">
- <autodoc>RightDClick() -> bool</autodoc>
+ <autodoc>RightDClick(self) -> bool</autodoc>
</method>
<method name="LeftIsDown" type="bool" overloaded="no">
- <autodoc>LeftIsDown() -> bool</autodoc>
+ <autodoc>LeftIsDown(self) -> bool</autodoc>
</method>
<method name="MiddleIsDown" type="bool" overloaded="no">
- <autodoc>MiddleIsDown() -> bool</autodoc>
+ <autodoc>MiddleIsDown(self) -> bool</autodoc>
</method>
<method name="RightIsDown" type="bool" overloaded="no">
- <autodoc>RightIsDown() -> bool</autodoc>
+ <autodoc>RightIsDown(self) -> bool</autodoc>
</method>
<method name="Dragging" type="bool" overloaded="no">
- <autodoc>Dragging() -> bool</autodoc>
+ <autodoc>Dragging(self) -> bool</autodoc>
</method>
<method name="Moving" type="bool" overloaded="no">
- <autodoc>Moving() -> bool</autodoc>
+ <autodoc>Moving(self) -> bool</autodoc>
</method>
<method name="Entering" type="bool" overloaded="no">
- <autodoc>Entering() -> bool</autodoc>
+ <autodoc>Entering(self) -> bool</autodoc>
</method>
<method name="Leaving" type="bool" overloaded="no">
- <autodoc>Leaving() -> bool</autodoc>
+ <autodoc>Leaving(self) -> bool</autodoc>
</method>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
- <docstring>Returns the position of the mouse in window coordinates when the event happened.</docstring>
+ <autodoc>GetPosition(self) -> Point</autodoc>
+ <docstring>Returns the position of the mouse in window coordinates when the event
+happened.</docstring>
</method>
<method name="GetPositionTuple" type="" overloaded="no">
<autodoc>GetPositionTuple() -> (x,y)</autodoc>
- <docstring>Returns the position of the mouse in window coordinates when the event happened.</docstring>
+ <docstring>Returns the position of the mouse in window coordinates when the event
+happened.</docstring>
<paramlist>
<param name="OUTPUT" type="long" default=""/>
<param name="OUTPUT" type="long" default=""/>
</paramlist>
</method>
<method name="GetLogicalPosition" type="Point" overloaded="no">
- <autodoc>GetLogicalPosition(DC dc) -> Point</autodoc>
+ <autodoc>GetLogicalPosition(self, DC dc) -> Point</autodoc>
<paramlist>
<param name="dc" type="wxDC" default=""/>
</paramlist>
</method>
<method name="GetX" type="int" overloaded="no">
- <autodoc>GetX() -> int</autodoc>
+ <autodoc>GetX(self) -> int</autodoc>
</method>
<method name="GetY" type="int" overloaded="no">
- <autodoc>GetY() -> int</autodoc>
+ <autodoc>GetY(self) -> int</autodoc>
</method>
<method name="GetWheelRotation" type="int" overloaded="no">
- <autodoc>GetWheelRotation() -> int</autodoc>
+ <autodoc>GetWheelRotation(self) -> int</autodoc>
</method>
<method name="GetWheelDelta" type="int" overloaded="no">
- <autodoc>GetWheelDelta() -> int</autodoc>
+ <autodoc>GetWheelDelta(self) -> int</autodoc>
</method>
<method name="GetLinesPerAction" type="int" overloaded="no">
- <autodoc>GetLinesPerAction() -> int</autodoc>
+ <autodoc>GetLinesPerAction(self) -> int</autodoc>
</method>
<method name="IsPageScroll" type="bool" overloaded="no">
- <autodoc>IsPageScroll() -> bool</autodoc>
+ <autodoc>IsPageScroll(self) -> bool</autodoc>
</method>
<property name="m_x" type="int" readonly="no"/>
<property name="m_y" type="int" readonly="no"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="SetCursorEvent" oldname="wxSetCursorEvent" module="core">
+ <class name="SetCursorEvent" oldname="wxSetCursorEvent" module="_core">
<baseclass name="Event"/>
<constructor name="SetCursorEvent" overloaded="no">
- <autodoc>__init__(int x=0, int y=0) -> SetCursorEvent</autodoc>
+ <autodoc>__init__(self, int x=0, int y=0) -> SetCursorEvent</autodoc>
<paramlist>
<param name="x" type="int" default="0"/>
<param name="y" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetX" type="int" overloaded="no">
- <autodoc>GetX() -> int</autodoc>
+ <autodoc>GetX(self) -> int</autodoc>
</method>
<method name="GetY" type="int" overloaded="no">
- <autodoc>GetY() -> int</autodoc>
+ <autodoc>GetY(self) -> int</autodoc>
</method>
<method name="SetCursor" type="" overloaded="no">
- <autodoc>SetCursor(Cursor cursor)</autodoc>
+ <autodoc>SetCursor(self, Cursor cursor)</autodoc>
<paramlist>
<param name="cursor" type="wxCursor" default=""/>
</paramlist>
</method>
<method name="GetCursor" type="wxCursor" overloaded="no">
- <autodoc>GetCursor() -> Cursor</autodoc>
+ <autodoc>GetCursor(self) -> Cursor</autodoc>
</method>
<method name="HasCursor" type="bool" overloaded="no">
- <autodoc>HasCursor() -> bool</autodoc>
+ <autodoc>HasCursor(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="KeyEvent" oldname="wxKeyEvent" module="core">
+ <class name="KeyEvent" oldname="wxKeyEvent" module="_core">
<baseclass name="Event"/>
<constructor name="KeyEvent" overloaded="no">
- <autodoc>__init__(wxEventType keyType=wxEVT_NULL) -> KeyEvent</autodoc>
+ <autodoc>__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent</autodoc>
<paramlist>
<param name="keyType" type="wxEventType" default="wxEVT_NULL"/>
</paramlist>
</constructor>
<method name="ControlDown" type="bool" overloaded="no">
- <autodoc>ControlDown() -> bool</autodoc>
+ <autodoc>ControlDown(self) -> bool</autodoc>
</method>
<method name="MetaDown" type="bool" overloaded="no">
- <autodoc>MetaDown() -> bool</autodoc>
+ <autodoc>MetaDown(self) -> bool</autodoc>
</method>
<method name="AltDown" type="bool" overloaded="no">
- <autodoc>AltDown() -> bool</autodoc>
+ <autodoc>AltDown(self) -> bool</autodoc>
</method>
<method name="ShiftDown" type="bool" overloaded="no">
- <autodoc>ShiftDown() -> bool</autodoc>
+ <autodoc>ShiftDown(self) -> bool</autodoc>
</method>
<method name="HasModifiers" type="bool" overloaded="no">
- <autodoc>HasModifiers() -> bool</autodoc>
+ <autodoc>HasModifiers(self) -> bool</autodoc>
</method>
<method name="GetKeyCode" type="int" overloaded="no">
- <autodoc>GetKeyCode() -> int</autodoc>
+ <autodoc>GetKeyCode(self) -> int</autodoc>
</method>
<method name="GetUniChar" type="int" overloaded="no">
- <autodoc>GetUniChar() -> int</autodoc>
+ <autodoc>GetUniChar(self) -> int</autodoc>
</method>
<method name="GetRawKeyCode" type="unsigned int" overloaded="no">
- <autodoc>GetRawKeyCode() -> unsigned int</autodoc>
+ <autodoc>GetRawKeyCode(self) -> unsigned int</autodoc>
</method>
<method name="GetRawKeyFlags" type="unsigned int" overloaded="no">
- <autodoc>GetRawKeyFlags() -> unsigned int</autodoc>
+ <autodoc>GetRawKeyFlags(self) -> unsigned int</autodoc>
</method>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
<docstring>Find the position of the event.</docstring>
</method>
<method name="GetPositionTuple" type="" overloaded="no">
</paramlist>
</method>
<method name="GetX" type="int" overloaded="no">
- <autodoc>GetX() -> int</autodoc>
+ <autodoc>GetX(self) -> int</autodoc>
</method>
<method name="GetY" type="int" overloaded="no">
- <autodoc>GetY() -> int</autodoc>
+ <autodoc>GetY(self) -> int</autodoc>
</method>
<property name="m_x" type="int" readonly="no"/>
<property name="m_y" type="int" readonly="no"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="SizeEvent" oldname="wxSizeEvent" module="core">
+ <class name="SizeEvent" oldname="wxSizeEvent" module="_core">
<baseclass name="Event"/>
<constructor name="SizeEvent" overloaded="no">
- <autodoc>__init__(Size sz=DefaultSize, int winid=0) -> SizeEvent</autodoc>
+ <autodoc>__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent</autodoc>
<paramlist>
<param name="sz" type="Size" default="wxDefaultSize"/>
<param name="winid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetSize" type="Size" overloaded="no">
- <autodoc>GetSize() -> Size</autodoc>
+ <autodoc>GetSize(self) -> Size</autodoc>
</method>
<method name="GetRect" type="Rect" overloaded="no">
- <autodoc>GetRect() -> Rect</autodoc>
+ <autodoc>GetRect(self) -> Rect</autodoc>
</method>
<method name="SetRect" type="" overloaded="no">
- <autodoc>SetRect(Rect rect)</autodoc>
+ <autodoc>SetRect(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(Size size)</autodoc>
+ <autodoc>SetSize(self, Size size)</autodoc>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MoveEvent" oldname="wxMoveEvent" module="core">
+ <class name="MoveEvent" oldname="wxMoveEvent" module="_core">
<baseclass name="Event"/>
<constructor name="MoveEvent" overloaded="no">
- <autodoc>__init__(Point pos=DefaultPosition, int winid=0) -> MoveEvent</autodoc>
+ <autodoc>__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent</autodoc>
<paramlist>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="winid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
</method>
<method name="GetRect" type="Rect" overloaded="no">
- <autodoc>GetRect() -> Rect</autodoc>
+ <autodoc>GetRect(self) -> Rect</autodoc>
</method>
<method name="SetRect" type="" overloaded="no">
- <autodoc>SetRect(Rect rect)</autodoc>
+ <autodoc>SetRect(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="SetPosition" type="" overloaded="no">
- <autodoc>SetPosition(Point pos)</autodoc>
+ <autodoc>SetPosition(self, Point pos)</autodoc>
<paramlist>
<param name="pos" type="Point" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PaintEvent" oldname="wxPaintEvent" module="core">
+ <class name="PaintEvent" oldname="wxPaintEvent" module="_core">
<baseclass name="Event"/>
<constructor name="PaintEvent" overloaded="no">
- <autodoc>__init__(int Id=0) -> PaintEvent</autodoc>
+ <autodoc>__init__(self, int Id=0) -> PaintEvent</autodoc>
<paramlist>
<param name="Id" type="int" default="0"/>
</paramlist>
</constructor>
</class>
- <class name="NcPaintEvent" oldname="wxNcPaintEvent" module="core">
+ <class name="NcPaintEvent" oldname="wxNcPaintEvent" module="_core">
<baseclass name="Event"/>
<constructor name="NcPaintEvent" overloaded="no">
- <autodoc>__init__(int winid=0) -> NcPaintEvent</autodoc>
+ <autodoc>__init__(self, int winid=0) -> NcPaintEvent</autodoc>
<paramlist>
<param name="winid" type="int" default="0"/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="EraseEvent" oldname="wxEraseEvent" module="core">
+ <class name="EraseEvent" oldname="wxEraseEvent" module="_core">
<baseclass name="Event"/>
<constructor name="EraseEvent" overloaded="no">
- <autodoc>__init__(int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent</autodoc>
+ <autodoc>__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent</autodoc>
<paramlist>
<param name="Id" type="int" default="0"/>
<param name="dc" type="wxDC" default="(wxDC *) NULL"/>
</paramlist>
</constructor>
<method name="GetDC" type="wxDC" overloaded="no">
- <autodoc>GetDC() -> DC</autodoc>
+ <autodoc>GetDC(self) -> DC</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="FocusEvent" oldname="wxFocusEvent" module="core">
+ <class name="FocusEvent" oldname="wxFocusEvent" module="_core">
<baseclass name="Event"/>
<constructor name="FocusEvent" overloaded="no">
- <autodoc>__init__(wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent</autodoc>
+ <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent</autodoc>
<paramlist>
<param name="type" type="wxEventType" default="wxEVT_NULL"/>
<param name="winid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetWindow" type="wxWindow" overloaded="no">
- <autodoc>GetWindow() -> Window</autodoc>
+ <autodoc>GetWindow(self) -> Window</autodoc>
</method>
<method name="SetWindow" type="" overloaded="no">
- <autodoc>SetWindow(Window win)</autodoc>
+ <autodoc>SetWindow(self, Window win)</autodoc>
<paramlist>
<param name="win" type="wxWindow" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ChildFocusEvent" oldname="wxChildFocusEvent" module="core">
+ <class name="ChildFocusEvent" oldname="wxChildFocusEvent" module="_core">
<baseclass name="CommandEvent"/>
<constructor name="ChildFocusEvent" overloaded="no">
- <autodoc>__init__(Window win=None) -> ChildFocusEvent</autodoc>
+ <autodoc>__init__(self, Window win=None) -> ChildFocusEvent</autodoc>
<paramlist>
<param name="win" type="wxWindow" default="NULL"/>
</paramlist>
</constructor>
<method name="GetWindow" type="wxWindow" overloaded="no">
- <autodoc>GetWindow() -> Window</autodoc>
+ <autodoc>GetWindow(self) -> Window</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ActivateEvent" oldname="wxActivateEvent" module="core">
+ <class name="ActivateEvent" oldname="wxActivateEvent" module="_core">
<baseclass name="Event"/>
<constructor name="ActivateEvent" overloaded="no">
- <autodoc>__init__(wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent</autodoc>
+ <autodoc>__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent</autodoc>
<paramlist>
<param name="type" type="wxEventType" default="wxEVT_NULL"/>
<param name="active" type="bool" default="True"/>
</paramlist>
</constructor>
<method name="GetActive" type="bool" overloaded="no">
- <autodoc>GetActive() -> bool</autodoc>
+ <autodoc>GetActive(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="InitDialogEvent" oldname="wxInitDialogEvent" module="core">
+ <class name="InitDialogEvent" oldname="wxInitDialogEvent" module="_core">
<baseclass name="Event"/>
<constructor name="InitDialogEvent" overloaded="no">
- <autodoc>__init__(int Id=0) -> InitDialogEvent</autodoc>
+ <autodoc>__init__(self, int Id=0) -> InitDialogEvent</autodoc>
<paramlist>
<param name="Id" type="int" default="0"/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MenuEvent" oldname="wxMenuEvent" module="core">
+ <class name="MenuEvent" oldname="wxMenuEvent" module="_core">
<baseclass name="Event"/>
<constructor name="MenuEvent" overloaded="no">
- <autodoc>__init__(wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent</autodoc>
+ <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent</autodoc>
<paramlist>
<param name="type" type="wxEventType" default="wxEVT_NULL"/>
<param name="winid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetMenuId" type="int" overloaded="no">
- <autodoc>GetMenuId() -> int</autodoc>
+ <autodoc>GetMenuId(self) -> int</autodoc>
</method>
<method name="IsPopup" type="bool" overloaded="no">
- <autodoc>IsPopup() -> bool</autodoc>
+ <autodoc>IsPopup(self) -> bool</autodoc>
</method>
<method name="GetMenu" type="wxMenu" overloaded="no">
- <autodoc>GetMenu() -> Menu</autodoc>
+ <autodoc>GetMenu(self) -> Menu</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="CloseEvent" oldname="wxCloseEvent" module="core">
+ <class name="CloseEvent" oldname="wxCloseEvent" module="_core">
<baseclass name="Event"/>
<constructor name="CloseEvent" overloaded="no">
- <autodoc>__init__(wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent</autodoc>
+ <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent</autodoc>
<paramlist>
<param name="type" type="wxEventType" default="wxEVT_NULL"/>
<param name="winid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="SetLoggingOff" type="" overloaded="no">
- <autodoc>SetLoggingOff(bool logOff)</autodoc>
+ <autodoc>SetLoggingOff(self, bool logOff)</autodoc>
<paramlist>
<param name="logOff" type="bool" default=""/>
</paramlist>
</method>
<method name="GetLoggingOff" type="bool" overloaded="no">
- <autodoc>GetLoggingOff() -> bool</autodoc>
+ <autodoc>GetLoggingOff(self) -> bool</autodoc>
</method>
<method name="Veto" type="" overloaded="no">
- <autodoc>Veto(bool veto=True)</autodoc>
+ <autodoc>Veto(self, bool veto=True)</autodoc>
<paramlist>
<param name="veto" type="bool" default="True"/>
</paramlist>
</method>
<method name="SetCanVeto" type="" overloaded="no">
- <autodoc>SetCanVeto(bool canVeto)</autodoc>
+ <autodoc>SetCanVeto(self, bool canVeto)</autodoc>
<paramlist>
<param name="canVeto" type="bool" default=""/>
</paramlist>
</method>
<method name="CanVeto" type="bool" overloaded="no">
- <autodoc>CanVeto() -> bool</autodoc>
+ <autodoc>CanVeto(self) -> bool</autodoc>
</method>
<method name="GetVeto" type="bool" overloaded="no">
- <autodoc>GetVeto() -> bool</autodoc>
+ <autodoc>GetVeto(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ShowEvent" oldname="wxShowEvent" module="core">
+ <class name="ShowEvent" oldname="wxShowEvent" module="_core">
<baseclass name="Event"/>
<constructor name="ShowEvent" overloaded="no">
- <autodoc>__init__(int winid=0, bool show=False) -> ShowEvent</autodoc>
+ <autodoc>__init__(self, int winid=0, bool show=False) -> ShowEvent</autodoc>
<paramlist>
<param name="winid" type="int" default="0"/>
<param name="show" type="bool" default="False"/>
</paramlist>
</constructor>
<method name="SetShow" type="" overloaded="no">
- <autodoc>SetShow(bool show)</autodoc>
+ <autodoc>SetShow(self, bool show)</autodoc>
<paramlist>
<param name="show" type="bool" default=""/>
</paramlist>
</method>
<method name="GetShow" type="bool" overloaded="no">
- <autodoc>GetShow() -> bool</autodoc>
+ <autodoc>GetShow(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="IconizeEvent" oldname="wxIconizeEvent" module="core">
+ <class name="IconizeEvent" oldname="wxIconizeEvent" module="_core">
<baseclass name="Event"/>
<constructor name="IconizeEvent" overloaded="no">
- <autodoc>__init__(int id=0, bool iconized=True) -> IconizeEvent</autodoc>
+ <autodoc>__init__(self, int id=0, bool iconized=True) -> IconizeEvent</autodoc>
<paramlist>
<param name="id" type="int" default="0"/>
<param name="iconized" type="bool" default="True"/>
</paramlist>
</constructor>
<method name="Iconized" type="bool" overloaded="no">
- <autodoc>Iconized() -> bool</autodoc>
+ <autodoc>Iconized(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MaximizeEvent" oldname="wxMaximizeEvent" module="core">
+ <class name="MaximizeEvent" oldname="wxMaximizeEvent" module="_core">
<baseclass name="Event"/>
<constructor name="MaximizeEvent" overloaded="no">
- <autodoc>__init__(int id=0) -> MaximizeEvent</autodoc>
+ <autodoc>__init__(self, int id=0) -> MaximizeEvent</autodoc>
<paramlist>
<param name="id" type="int" default="0"/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="DropFilesEvent" oldname="wxDropFilesEvent" module="core">
+ <class name="DropFilesEvent" oldname="wxDropFilesEvent" module="_core">
<baseclass name="Event"/>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
</method>
<method name="GetNumberOfFiles" type="int" overloaded="no">
- <autodoc>GetNumberOfFiles() -> int</autodoc>
+ <autodoc>GetNumberOfFiles(self) -> int</autodoc>
</method>
<method name="GetFiles" type="PyObject" overloaded="no">
- <autodoc>GetFiles() -> PyObject</autodoc>
+ <autodoc>GetFiles(self) -> PyObject</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="UpdateUIEvent" oldname="wxUpdateUIEvent" module="core">
+ <class name="UpdateUIEvent" oldname="wxUpdateUIEvent" module="_core">
<baseclass name="CommandEvent"/>
<constructor name="UpdateUIEvent" overloaded="no">
- <autodoc>__init__(int commandId=0) -> UpdateUIEvent</autodoc>
+ <autodoc>__init__(self, int commandId=0) -> UpdateUIEvent</autodoc>
<paramlist>
<param name="commandId" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetChecked" type="bool" overloaded="no">
- <autodoc>GetChecked() -> bool</autodoc>
+ <autodoc>GetChecked(self) -> bool</autodoc>
</method>
<method name="GetEnabled" type="bool" overloaded="no">
- <autodoc>GetEnabled() -> bool</autodoc>
+ <autodoc>GetEnabled(self) -> bool</autodoc>
</method>
<method name="GetText" type="String" overloaded="no">
- <autodoc>GetText() -> String</autodoc>
+ <autodoc>GetText(self) -> String</autodoc>
</method>
<method name="GetSetText" type="bool" overloaded="no">
- <autodoc>GetSetText() -> bool</autodoc>
+ <autodoc>GetSetText(self) -> bool</autodoc>
</method>
<method name="GetSetChecked" type="bool" overloaded="no">
- <autodoc>GetSetChecked() -> bool</autodoc>
+ <autodoc>GetSetChecked(self) -> bool</autodoc>
</method>
<method name="GetSetEnabled" type="bool" overloaded="no">
- <autodoc>GetSetEnabled() -> bool</autodoc>
+ <autodoc>GetSetEnabled(self) -> bool</autodoc>
</method>
<method name="Check" type="" overloaded="no">
- <autodoc>Check(bool check)</autodoc>
+ <autodoc>Check(self, bool check)</autodoc>
<paramlist>
<param name="check" type="bool" default=""/>
</paramlist>
</method>
<method name="Enable" type="" overloaded="no">
- <autodoc>Enable(bool enable)</autodoc>
+ <autodoc>Enable(self, bool enable)</autodoc>
<paramlist>
<param name="enable" type="bool" default=""/>
</paramlist>
</method>
<method name="SetText" type="" overloaded="no">
- <autodoc>SetText(String text)</autodoc>
+ <autodoc>SetText(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="SysColourChangedEvent" oldname="wxSysColourChangedEvent" module="core">
+ <class name="SysColourChangedEvent" oldname="wxSysColourChangedEvent" module="_core">
<baseclass name="Event"/>
<constructor name="SysColourChangedEvent" overloaded="no">
- <autodoc>__init__() -> SysColourChangedEvent</autodoc>
+ <autodoc>__init__(self) -> SysColourChangedEvent</autodoc>
</constructor>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MouseCaptureChangedEvent" oldname="wxMouseCaptureChangedEvent" module="core">
+ <class name="MouseCaptureChangedEvent" oldname="wxMouseCaptureChangedEvent" module="_core">
<baseclass name="Event"/>
<constructor name="MouseCaptureChangedEvent" overloaded="no">
- <autodoc>__init__(int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent</autodoc>
+ <autodoc>__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent</autodoc>
<paramlist>
<param name="winid" type="int" default="0"/>
<param name="gainedCapture" type="wxWindow" default="NULL"/>
</paramlist>
</constructor>
<method name="GetCapturedWindow" type="wxWindow" overloaded="no">
- <autodoc>GetCapturedWindow() -> Window</autodoc>
+ <autodoc>GetCapturedWindow(self) -> Window</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="DisplayChangedEvent" oldname="wxDisplayChangedEvent" module="core">
+ <class name="DisplayChangedEvent" oldname="wxDisplayChangedEvent" module="_core">
<baseclass name="Event"/>
<constructor name="DisplayChangedEvent" overloaded="no">
- <autodoc>__init__() -> DisplayChangedEvent</autodoc>
+ <autodoc>__init__(self) -> DisplayChangedEvent</autodoc>
</constructor>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PaletteChangedEvent" oldname="wxPaletteChangedEvent" module="core">
+ <class name="PaletteChangedEvent" oldname="wxPaletteChangedEvent" module="_core">
<baseclass name="Event"/>
<constructor name="PaletteChangedEvent" overloaded="no">
- <autodoc>__init__(int id=0) -> PaletteChangedEvent</autodoc>
+ <autodoc>__init__(self, int id=0) -> PaletteChangedEvent</autodoc>
<paramlist>
<param name="id" type="int" default="0"/>
</paramlist>
</constructor>
<method name="SetChangedWindow" type="" overloaded="no">
- <autodoc>SetChangedWindow(Window win)</autodoc>
+ <autodoc>SetChangedWindow(self, Window win)</autodoc>
<paramlist>
<param name="win" type="wxWindow" default=""/>
</paramlist>
</method>
<method name="GetChangedWindow" type="wxWindow" overloaded="no">
- <autodoc>GetChangedWindow() -> Window</autodoc>
+ <autodoc>GetChangedWindow(self) -> Window</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="QueryNewPaletteEvent" oldname="wxQueryNewPaletteEvent" module="core">
+ <class name="QueryNewPaletteEvent" oldname="wxQueryNewPaletteEvent" module="_core">
<baseclass name="Event"/>
<constructor name="QueryNewPaletteEvent" overloaded="no">
- <autodoc>__init__(int winid=0) -> QueryNewPaletteEvent</autodoc>
+ <autodoc>__init__(self, int winid=0) -> QueryNewPaletteEvent</autodoc>
<paramlist>
<param name="winid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="SetPaletteRealized" type="" overloaded="no">
- <autodoc>SetPaletteRealized(bool realized)</autodoc>
+ <autodoc>SetPaletteRealized(self, bool realized)</autodoc>
<paramlist>
<param name="realized" type="bool" default=""/>
</paramlist>
</method>
<method name="GetPaletteRealized" type="bool" overloaded="no">
- <autodoc>GetPaletteRealized() -> bool</autodoc>
+ <autodoc>GetPaletteRealized(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="NavigationKeyEvent" oldname="wxNavigationKeyEvent" module="core">
+ <class name="NavigationKeyEvent" oldname="wxNavigationKeyEvent" module="_core">
<baseclass name="Event"/>
<constructor name="NavigationKeyEvent" overloaded="no">
- <autodoc>__init__() -> NavigationKeyEvent</autodoc>
+ <autodoc>__init__(self) -> NavigationKeyEvent</autodoc>
</constructor>
<method name="GetDirection" type="bool" overloaded="no">
- <autodoc>GetDirection() -> bool</autodoc>
+ <autodoc>GetDirection(self) -> bool</autodoc>
</method>
<method name="SetDirection" type="" overloaded="no">
- <autodoc>SetDirection(bool bForward)</autodoc>
+ <autodoc>SetDirection(self, bool bForward)</autodoc>
<paramlist>
<param name="bForward" type="bool" default=""/>
</paramlist>
</method>
<method name="IsWindowChange" type="bool" overloaded="no">
- <autodoc>IsWindowChange() -> bool</autodoc>
+ <autodoc>IsWindowChange(self) -> bool</autodoc>
</method>
<method name="SetWindowChange" type="" overloaded="no">
- <autodoc>SetWindowChange(bool bIs)</autodoc>
+ <autodoc>SetWindowChange(self, bool bIs)</autodoc>
<paramlist>
<param name="bIs" type="bool" default=""/>
</paramlist>
</method>
<method name="GetCurrentFocus" type="wxWindow" overloaded="no">
- <autodoc>GetCurrentFocus() -> Window</autodoc>
+ <autodoc>GetCurrentFocus(self) -> Window</autodoc>
</method>
<method name="SetCurrentFocus" type="" overloaded="no">
- <autodoc>SetCurrentFocus(Window win)</autodoc>
+ <autodoc>SetCurrentFocus(self, Window win)</autodoc>
<paramlist>
<param name="win" type="wxWindow" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="WindowCreateEvent" oldname="wxWindowCreateEvent" module="core">
+ <class name="WindowCreateEvent" oldname="wxWindowCreateEvent" module="_core">
<baseclass name="CommandEvent"/>
<constructor name="WindowCreateEvent" overloaded="no">
- <autodoc>__init__(Window win=None) -> WindowCreateEvent</autodoc>
+ <autodoc>__init__(self, Window win=None) -> WindowCreateEvent</autodoc>
<paramlist>
<param name="win" type="wxWindow" default="NULL"/>
</paramlist>
</constructor>
<method name="GetWindow" type="wxWindow" overloaded="no">
- <autodoc>GetWindow() -> Window</autodoc>
+ <autodoc>GetWindow(self) -> Window</autodoc>
</method>
</class>
- <class name="WindowDestroyEvent" oldname="wxWindowDestroyEvent" module="core">
+ <class name="WindowDestroyEvent" oldname="wxWindowDestroyEvent" module="_core">
<baseclass name="CommandEvent"/>
<constructor name="WindowDestroyEvent" overloaded="no">
- <autodoc>__init__(Window win=None) -> WindowDestroyEvent</autodoc>
+ <autodoc>__init__(self, Window win=None) -> WindowDestroyEvent</autodoc>
<paramlist>
<param name="win" type="wxWindow" default="NULL"/>
</paramlist>
</constructor>
<method name="GetWindow" type="wxWindow" overloaded="no">
- <autodoc>GetWindow() -> Window</autodoc>
+ <autodoc>GetWindow(self) -> Window</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ContextMenuEvent" oldname="wxContextMenuEvent" module="core">
+ <class name="ContextMenuEvent" oldname="wxContextMenuEvent" module="_core">
<baseclass name="CommandEvent"/>
<constructor name="ContextMenuEvent" overloaded="no">
- <autodoc>__init__(wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent</autodoc>
+ <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent</autodoc>
<paramlist>
<param name="type" type="wxEventType" default="wxEVT_NULL"/>
<param name="winid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
</method>
<method name="SetPosition" type="" overloaded="no">
- <autodoc>SetPosition(Point pos)</autodoc>
+ <autodoc>SetPosition(self, Point pos)</autodoc>
<paramlist>
<param name="pos" type="Point" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="IdleEvent" oldname="wxIdleEvent" module="core">
+ <class name="IdleEvent" oldname="wxIdleEvent" module="_core">
<baseclass name="Event"/>
<constructor name="IdleEvent" overloaded="no">
- <autodoc>__init__() -> IdleEvent</autodoc>
+ <autodoc>__init__(self) -> IdleEvent</autodoc>
</constructor>
<method name="RequestMore" type="" overloaded="no">
- <autodoc>RequestMore(bool needMore=True)</autodoc>
+ <autodoc>RequestMore(self, bool needMore=True)</autodoc>
<paramlist>
<param name="needMore" type="bool" default="True"/>
</paramlist>
</method>
<method name="MoreRequested" type="bool" overloaded="no">
- <autodoc>MoreRequested() -> bool</autodoc>
+ <autodoc>MoreRequested(self) -> bool</autodoc>
</method>
<staticmethod name="SetMode" type="" overloaded="no">
<autodoc>SetMode(int mode)</autodoc>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PyEvent" oldname="wxPyEvent" module="core">
+ <class name="PyEvent" oldname="wxPyEvent" module="_core">
<baseclass name="Event"/>
<constructor name="PyEvent" overloaded="no">
- <autodoc>__init__(int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent</autodoc>
+ <autodoc>__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent</autodoc>
<paramlist>
<param name="winid" type="int" default="0"/>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
</paramlist>
</constructor>
<destructor name="~wxPyEvent" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetSelf" type="" overloaded="no">
- <autodoc>SetSelf(PyObject self)</autodoc>
+ <autodoc>SetSelf(self, PyObject self)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetSelf" type="PyObject" overloaded="no">
- <autodoc>GetSelf() -> PyObject</autodoc>
+ <autodoc>GetSelf(self) -> PyObject</autodoc>
</method>
</class>
- <class name="PyCommandEvent" oldname="wxPyCommandEvent" module="core">
+ <class name="PyCommandEvent" oldname="wxPyCommandEvent" module="_core">
<baseclass name="CommandEvent"/>
<constructor name="PyCommandEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent</autodoc>
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
<param name="id" type="int" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxPyCommandEvent" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetSelf" type="" overloaded="no">
- <autodoc>SetSelf(PyObject self)</autodoc>
+ <autodoc>SetSelf(self, PyObject self)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetSelf" type="PyObject" overloaded="no">
- <autodoc>GetSelf() -> PyObject</autodoc>
+ <autodoc>GetSelf(self) -> PyObject</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PyApp" oldname="wxPyApp" module="core">
+ <class name="PyApp" oldname="wxPyApp" module="_core">
+ <docstring>The ``wx.PyApp`` class is an *implementation detail*, please use the
+`wx.App` class (or some other derived class) instead.</docstring>
<baseclass name="EvtHandler"/>
<constructor name="PyApp" overloaded="no">
- <autodoc>__init__() -> PyApp</autodoc>
+ <autodoc>__init__(self) -> PyApp</autodoc>
<docstring>Create a new application object, starting the bootstrap process.</docstring>
</constructor>
<destructor name="~wxPyApp" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetAppName" type="String" overloaded="no">
- <autodoc>GetAppName() -> String</autodoc>
+ <autodoc>GetAppName(self) -> String</autodoc>
<docstring>Get the application name.</docstring>
</method>
<method name="SetAppName" type="" overloaded="no">
- <autodoc>SetAppName(String name)</autodoc>
- <docstring>Set the application name. This value may be used automatically
-by wx.Config and such.</docstring>
+ <autodoc>SetAppName(self, String name)</autodoc>
+ <docstring>Set the application name. This value may be used automatically by
+`wx.Config` and such.</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="GetClassName" type="String" overloaded="no">
- <autodoc>GetClassName() -> String</autodoc>
+ <autodoc>GetClassName(self) -> String</autodoc>
<docstring>Get the application's class name.</docstring>
</method>
<method name="SetClassName" type="" overloaded="no">
- <autodoc>SetClassName(String name)</autodoc>
- <docstring>Set the application's class name. This value may be used for X-resources if
-applicable for the platform</docstring>
+ <autodoc>SetClassName(self, String name)</autodoc>
+ <docstring>Set the application's class name. This value may be used for
+X-resources if applicable for the platform</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="GetVendorName" type="String" overloaded="no">
- <autodoc>GetVendorName() -> String</autodoc>
+ <autodoc>GetVendorName(self) -> String</autodoc>
<docstring>Get the application's vendor name.</docstring>
</method>
<method name="SetVendorName" type="" overloaded="no">
- <autodoc>SetVendorName(String name)</autodoc>
- <docstring>Set the application's vendor name. This value may be used automatically
-by wx.Config and such.</docstring>
+ <autodoc>SetVendorName(self, String name)</autodoc>
+ <docstring>Set the application's vendor name. This value may be used
+automatically by `wx.Config` and such.</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="GetTraits" type="wxAppTraits" overloaded="no">
- <autodoc>GetTraits() -> wxAppTraits</autodoc>
- <docstring>Create the app traits object to which we delegate for everything which either
-should be configurable by the user (then he can change the default behaviour
-simply by overriding CreateTraits() and returning his own traits object) or
-which is GUI/console dependent as then wx.AppTraits allows us to abstract the
-differences behind the common facade</docstring>
+ <autodoc>GetTraits(self) -> wxAppTraits</autodoc>
+ <docstring>Return (and create if necessary) the app traits object to which we
+delegate for everything which either should be configurable by the
+user (then he can change the default behaviour simply by overriding
+CreateTraits() and returning his own traits object) or which is
+GUI/console dependent as then wx.AppTraits allows us to abstract the
+differences behind the common facade.
+
+:todo: Add support for overriding CreateAppTraits in wxPython.</docstring>
</method>
<method name="ProcessPendingEvents" type="" overloaded="no">
- <autodoc>ProcessPendingEvents()</autodoc>
- <docstring>Process all events in the Pending Events list -- it is necessary to call this
-function to process posted events. This happens during each event loop
-iteration.</docstring>
+ <autodoc>ProcessPendingEvents(self)</autodoc>
+ <docstring>Process all events in the Pending Events list -- it is necessary to
+call this function to process posted events. This normally happens
+during each event loop iteration.</docstring>
</method>
<method name="Yield" type="bool" overloaded="no">
- <autodoc>Yield(bool onlyIfNeeded=False) -> bool</autodoc>
- <docstring>Process all currently pending events right now, instead of waiting until
-return to the event loop. It is an error to call Yield() recursively unless
-the value of onlyIfNeeded is True.
-
-WARNING: This function is dangerous as it can lead to unexpected
- reentrancies (i.e. when called from an event handler it
- may result in calling the same event handler again), use
- with _extreme_ care or, better, don't use at all!
+ <autodoc>Yield(self, bool onlyIfNeeded=False) -> bool</autodoc>
+ <docstring>Process all currently pending events right now, instead of waiting
+until return to the event loop. It is an error to call ``Yield``
+recursively unless the value of ``onlyIfNeeded`` is True.
+
+:warning: This function is dangerous as it can lead to unexpected
+ reentrancies (i.e. when called from an event handler it may
+ result in calling the same event handler again), use with
+ extreme care or, better, don't use at all!
+
+:see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
</docstring>
<paramlist>
<param name="onlyIfNeeded" type="bool" default="False"/>
</paramlist>
</method>
<method name="WakeUpIdle" type="" overloaded="no">
- <autodoc>WakeUpIdle()</autodoc>
- <docstring>Make sure that idle events are sent again</docstring>
+ <autodoc>WakeUpIdle(self)</autodoc>
+ <docstring>Make sure that idle events are sent again.
+:see: `wx.WakeUpIdle`</docstring>
</method>
<method name="MainLoop" type="int" overloaded="no">
- <autodoc>MainLoop() -> int</autodoc>
- <docstring>Execute the main GUI loop, the function returns when the loop ends.</docstring>
+ <autodoc>MainLoop(self) -> int</autodoc>
+ <docstring>Execute the main GUI loop, the function doesn't normally return until
+all top level windows have been closed and destroyed.</docstring>
</method>
<method name="Exit" type="" overloaded="no">
- <autodoc>Exit()</autodoc>
- <docstring>Exit the main loop thus terminating the application.</docstring>
+ <autodoc>Exit(self)</autodoc>
+ <docstring>Exit the main loop thus terminating the application.
+:see: `wx.Exit`</docstring>
</method>
<method name="ExitMainLoop" type="" overloaded="no">
- <autodoc>ExitMainLoop()</autodoc>
- <docstring>Exit the main GUI loop during the next iteration (i.e. it does not
-stop the program immediately!)</docstring>
+ <autodoc>ExitMainLoop(self)</autodoc>
+ <docstring>Exit the main GUI loop during the next iteration of the main
+loop, (i.e. it does not stop the program immediately!)</docstring>
</method>
<method name="Pending" type="bool" overloaded="no">
- <autodoc>Pending() -> bool</autodoc>
+ <autodoc>Pending(self) -> bool</autodoc>
<docstring>Returns True if there are unprocessed events in the event queue.</docstring>
</method>
<method name="Dispatch" type="bool" overloaded="no">
- <autodoc>Dispatch() -> bool</autodoc>
+ <autodoc>Dispatch(self) -> bool</autodoc>
<docstring>Process the first event in the event queue (blocks until an event
appears if there are none currently)</docstring>
</method>
<method name="ProcessIdle" type="bool" overloaded="no">
- <autodoc>ProcessIdle() -> bool</autodoc>
- <docstring>Called from the MainLoop when the application becomes idle and sends an
-IdleEvent to all interested parties. Returns True is more idle events are
-needed, False if not.</docstring>
+ <autodoc>ProcessIdle(self) -> bool</autodoc>
+ <docstring>Called from the MainLoop when the application becomes idle (there are
+no pending events) and sends a `wx.IdleEvent` to all interested
+parties. Returns True if more idle events are needed, False if not.</docstring>
</method>
<method name="SendIdleEvents" type="bool" overloaded="no">
- <autodoc>SendIdleEvents(Window win, IdleEvent event) -> bool</autodoc>
- <docstring>Send idle event to window and all subwindows. Returns True if more idle time
-is requested.</docstring>
+ <autodoc>SendIdleEvents(self, Window win, IdleEvent event) -> bool</autodoc>
+ <docstring>Send idle event to window and all subwindows. Returns True if more
+idle time is requested.</docstring>
<paramlist>
<param name="win" type="wxWindow" default=""/>
<param name="event" type="IdleEvent" default=""/>
</paramlist>
</method>
<method name="IsActive" type="bool" overloaded="no">
- <autodoc>IsActive() -> bool</autodoc>
+ <autodoc>IsActive(self) -> bool</autodoc>
<docstring>Return True if our app has focus.</docstring>
</method>
<method name="SetTopWindow" type="" overloaded="no">
- <autodoc>SetTopWindow(Window win)</autodoc>
- <docstring>Set the "main" top level window</docstring>
+ <autodoc>SetTopWindow(self, Window win)</autodoc>
+ <docstring>Set the *main* top level window</docstring>
<paramlist>
<param name="win" type="wxWindow" default=""/>
</paramlist>
</method>
<method name="GetTopWindow" type="wxWindow" overloaded="no">
- <autodoc>GetTopWindow() -> Window</autodoc>
- <docstring>Return the "main" top level window (if it hadn't been set previously with
-SetTopWindow(), will return just some top level window and, if there not any,
-will return None)</docstring>
+ <autodoc>GetTopWindow(self) -> Window</autodoc>
+ <docstring>Return the *main* top level window (if it hadn't been set previously
+with SetTopWindow(), will return just some top level window and, if
+there not any, will return None)</docstring>
</method>
<method name="SetExitOnFrameDelete" type="" overloaded="no">
- <autodoc>SetExitOnFrameDelete(bool flag)</autodoc>
- <docstring>Control the exit behaviour: by default, the program will exit the main loop
-(and so, usually, terminate) when the last top-level program window is
-deleted. Beware that if you disable this behaviour (with
-SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop() explicitly
-from somewhere.
-</docstring>
+ <autodoc>SetExitOnFrameDelete(self, bool flag)</autodoc>
+ <docstring>Control the exit behaviour: by default, the program will exit the main
+loop (and so, usually, terminate) when the last top-level program
+window is deleted. Beware that if you disable this behaviour (with
+SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
+explicitly from somewhere.</docstring>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="GetExitOnFrameDelete" type="bool" overloaded="no">
- <autodoc>GetExitOnFrameDelete() -> bool</autodoc>
+ <autodoc>GetExitOnFrameDelete(self) -> bool</autodoc>
<docstring>Get the current exit behaviour setting.</docstring>
</method>
<method name="SetUseBestVisual" type="" overloaded="no">
- <autodoc>SetUseBestVisual(bool flag)</autodoc>
- <docstring>Set whether the app should try to use the best available visual on systems
-where more than one is available, (Sun, SGI, XFree86 4, etc.)</docstring>
+ <autodoc>SetUseBestVisual(self, bool flag)</autodoc>
+ <docstring>Set whether the app should try to use the best available visual on
+systems where more than one is available, (Sun, SGI, XFree86 4, etc.)</docstring>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="GetUseBestVisual" type="bool" overloaded="no">
- <autodoc>GetUseBestVisual() -> bool</autodoc>
+ <autodoc>GetUseBestVisual(self) -> bool</autodoc>
<docstring>Get current UseBestVisual setting.</docstring>
</method>
<method name="SetPrintMode" type="" overloaded="no">
- <autodoc>SetPrintMode(int mode)</autodoc>
+ <autodoc>SetPrintMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="GetPrintMode" type="int" overloaded="no">
- <autodoc>GetPrintMode() -> int</autodoc>
+ <autodoc>GetPrintMode(self) -> int</autodoc>
</method>
<method name="SetAssertMode" type="" overloaded="no">
- <autodoc>SetAssertMode(int mode)</autodoc>
- <docstring>Set the OnAssert behaviour for debug and hybrid builds. The following flags
-may be or'd together:
-
- wx.PYAPP_ASSERT_SUPPRESS Don't do anything
- wx.PYAPP_ASSERT_EXCEPTION Turn it into a Python exception if possible (default)
- wx.PYAPP_ASSERT_DIALOG Display a message dialog
- wx.PYAPP_ASSERT_LOG Write the assertion info to the wx.Log
-</docstring>
+ <autodoc>SetAssertMode(self, int mode)</autodoc>
+ <docstring>Set the OnAssert behaviour for debug and hybrid builds.</docstring>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="GetAssertMode" type="int" overloaded="no">
- <autodoc>GetAssertMode() -> int</autodoc>
+ <autodoc>GetAssertMode(self) -> int</autodoc>
<docstring>Get the current OnAssert behaviour setting.</docstring>
</method>
<staticmethod name="GetMacSupportPCMenuShortcuts" type="bool" overloaded="no">
</paramlist>
</staticmethod>
<method name="_BootstrapApp" type="" overloaded="no">
- <autodoc>_BootstrapApp()</autodoc>
+ <autodoc>_BootstrapApp(self)</autodoc>
<docstring>For internal use only</docstring>
</method>
<staticmethod name="GetComCtl32Version" type="int" overloaded="no">
<autodoc>GetComCtl32Version() -> int</autodoc>
- <docstring>Returns 400, 470, 471 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.</docstring>
+ <docstring>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.</docstring>
</staticmethod>
</class>
<pythoncode>
</method>
<method name="SafeYield" oldname="wxSafeYield" type="bool" overloaded="no">
<autodoc>SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool</autodoc>
- <docstring>This function is similar to wx.Yield, except that it disables the user input
-to all program windows before calling wx.Yield and re-enables it again
-afterwards. If win is not None, this window will remain enabled, allowing the
-implementation of some limited user interaction.
+ <docstring>This function is similar to `wx.Yield`, except that it disables the
+user input to all program windows before calling `wx.Yield` and
+re-enables it again afterwards. If ``win`` is not None, this window
+will remain enabled, allowing the implementation of some limited user
+interaction.
-Returns the result of the call to wx.Yield.</docstring>
+:Returns: the result of the call to `wx.Yield`.</docstring>
<paramlist>
<param name="win" type="wxWindow" default="NULL"/>
<param name="onlyIfNeeded" type="bool" default="False"/>
</method>
<method name="WakeUpIdle" oldname="wxWakeUpIdle" type="" overloaded="no">
<autodoc>WakeUpIdle()</autodoc>
- <docstring>Cause the message queue to become empty again, so idle events will be sent.</docstring>
+ <docstring>Cause the message queue to become empty again, so idle events will be
+sent.</docstring>
</method>
<method name="PostEvent" oldname="wxPostEvent" type="" overloaded="no">
<autodoc>PostEvent(EvtHandler dest, Event event)</autodoc>
- <docstring>Send an event to a window or other wx.EvtHandler to be processed later.</docstring>
+ <docstring>Send an event to a window or other wx.EvtHandler to be processed
+later.</docstring>
<paramlist>
<param name="dest" type="EvtHandler" default=""/>
<param name="event" type="Event" default=""/>
</method>
<method name="App_CleanUp" oldname="wxApp_CleanUp" type="" overloaded="no">
<autodoc>App_CleanUp()</autodoc>
- <docstring>For internal use only, it is used to cleanup after wxWindows when Python shuts down.</docstring>
+ <docstring>For internal use only, it is used to cleanup after wxWidgets when
+Python shuts down.</docstring>
</method>
- <method name="GetApp" oldname="wxGetApp" type="PyApp" overloaded="no">
+ <method name="GetApp" oldname="wxPyGetApp" type="PyApp" overloaded="no">
<autodoc>GetApp() -> PyApp</autodoc>
<docstring>Return a reference to the current wx.App object.</docstring>
</method>
class App(wx.PyApp):
"""
- The main application class. Derive from this and implement an OnInit
- method that creates a frame and then calls self.SetTopWindow(frame)
+ The ``wx.App`` class represents the application and is used to:
+
+ * bootstrap the wxPython system and initialize the underlying
+ gui toolkit
+ * set and get application-wide properties
+ * implement the windowing system main message or event loop,
+ and to dispatch events to window instances
+ * etc.
+
+ Every application must have a ``wx.App`` instance, and all
+ creation of UI objects should be delayed until after the
+ ``wx.App`` object has been created in order to ensure that the gui
+ platform and wxWidgets have been fully initialized.
+
+ Normally you would derive from this class and implement an
+ ``OnInit`` method that creates a frame and then calls
+ ``self.SetTopWindow(frame)``.
+
+ :see: `wx.PySimpleApp` for a simpler app class that can be used
+ directly.
"""
+
outputWindowClass = PyOnDemandOutputWindow
- def __init__(self, redirect=_defRedirect, filename=None, useBestVisual=False):
+ def __init__(self, redirect=_defRedirect, filename=None,
+ useBestVisual=False, clearSigInt=True):
+ """
+ Construct a ``wx.App`` object.
+
+ :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
+ redirected? Defaults to True on Windows and Mac, False
+ otherwise. If `filename` is None then output will be
+ redirected to a window that pops up as needed. (You can
+ control what kind of window is created for the output by
+ resetting the class variable ``outputWindowClass`` to a
+ class of your choosing.)
+
+ :param filename: The name of a file to redirect output to, if
+ redirect is True.
+
+ :param useBestVisual: Should the app try to use the best
+ available visual provided by the system (only relevant on
+ systems that have more than one visual.) This parameter
+ must be used instead of calling `SetUseBestVisual` later
+ on because it must be set before the underlying GUI
+ toolkit is initialized.
+
+ :param clearSigInt: Should SIGINT be cleared? This allows the
+ app to terminate upon a Ctrl-C in the console like other
+ GUI apps will.
+
+ :note: You should override OnInit to do applicaition
+ initialization to ensure that the system, toolkit and
+ wxWidgets are fully initialized.
+ """
wx.PyApp.__init__(self)
if wx.Platform == "__WXMAC__":
not 'python', and only when you are logged in on the main display of
your Mac."""
_sys.exit(1)
+ except SystemExit:
+ raise
except:
pass
# KeyboardInterrupt???) but will later segfault on exit. By
# setting the default handler then the app will exit, as
# expected (depending on platform.)
- try:
- import signal
- signal.signal(signal.SIGINT, signal.SIG_DFL)
- except:
- pass
+ if clearSigInt:
+ try:
+ import signal
+ signal.signal(signal.SIGINT, signal.SIG_DFL)
+ except:
+ pass
# Save and redirect the stdio to a window?
self.stdioWin = None
-# change from wxPyApp_ to wxApp_
-App_GetMacSupportPCMenuShortcuts = _core.PyApp_GetMacSupportPCMenuShortcuts
-App_GetMacAboutMenuItemId = _core.PyApp_GetMacAboutMenuItemId
-App_GetMacPreferencesMenuItemId = _core.PyApp_GetMacPreferencesMenuItemId
-App_GetMacExitMenuItemId = _core.PyApp_GetMacExitMenuItemId
-App_GetMacHelpMenuTitleName = _core.PyApp_GetMacHelpMenuTitleName
-App_SetMacSupportPCMenuShortcuts = _core.PyApp_SetMacSupportPCMenuShortcuts
-App_SetMacAboutMenuItemId = _core.PyApp_SetMacAboutMenuItemId
-App_SetMacPreferencesMenuItemId = _core.PyApp_SetMacPreferencesMenuItemId
-App_SetMacExitMenuItemId = _core.PyApp_SetMacExitMenuItemId
-App_SetMacHelpMenuTitleName = _core.PyApp_SetMacHelpMenuTitleName
-App_GetComCtl32Version = _core.PyApp_GetComCtl32Version
+# change from wx.PyApp_XX to wx.App_XX
+App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
+App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
+App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
+App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
+App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
+App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
+App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
+App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
+App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
+App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
+App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
#----------------------------------------------------------------------------
"""
A simple application class. You can just create one of these and
then then make your top level windows later, and not have to worry
- about OnInit."""
+ about OnInit. For example::
+
+ app = wx.PySimpleApp()
+ frame = wx.Frame(None, title='Hello World')
+ frame.Show()
+ app.MainLoop()
+
+ :see: `wx.App`
+ """
- def __init__(self, redirect=False, filename=None, useBestVisual=False):
- wx.App.__init__(self, redirect, filename, useBestVisual)
+ def __init__(self, redirect=False, filename=None,
+ useBestVisual=False, clearSigInt=True):
+ """
+ :see: `wx.App.__init__`
+ """
+ wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
def OnInit(self):
- wx.InitAllImageHandlers()
return True
+
# Is anybody using this one?
class PyWidgetTester(wx.App):
def __init__(self, size = (250, 100)):
self.SetTopWindow(self.frame)
return True
- def SetWidget(self, widgetClass, *args):
- w = widgetClass(self.frame, *args)
+ def SetWidget(self, widgetClass, *args, **kwargs):
+ w = widgetClass(self.frame, *args, **kwargs)
self.frame.Show(True)
#----------------------------------------------------------------------------
# DO NOT hold any other references to this object. This is how we
-# know when to cleanup system resources that wxWin is holding. When
+# know when to cleanup system resources that wxWidgets is holding. When
# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
-# goes to zero and it calls the wxApp_CleanUp function.
+# goes to zero and it calls the wx.App_CleanUp function.
class __wxPyCleanup:
def __init__(self):
- self.cleanup = _core.App_CleanUp
+ self.cleanup = _core_.App_CleanUp
def __del__(self):
self.cleanup()
_sys.__wxPythonCleanup = __wxPyCleanup()
## # another possible solution, but it gets called too early...
-## if sys.version[0] == '2':
-## import atexit
-## atexit.register(_core.wxApp_CleanUp)
-## else:
-## sys.exitfunc = _core.wxApp_CleanUp
+## import atexit
+## atexit.register(_core_.wxApp_CleanUp)
#----------------------------------------------------------------------------
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="AcceleratorEntry" oldname="wxAcceleratorEntry" module="core">
+ <class name="AcceleratorEntry" oldname="wxAcceleratorEntry" module="_core">
+ <docstring>A class used to define items in an `wx.AcceleratorTable`. wxPython
+programs can choose to use wx.AcceleratorEntry objects, but using a
+list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
+as well. See `__init__` for of the tuple values.
+
+:see: `wx.AcceleratorTable`</docstring>
<constructor name="AcceleratorEntry" overloaded="no">
- <autodoc>__init__(int flags=0, int keyCode=0, int cmd=0, MenuItem item=None) -> AcceleratorEntry</autodoc>
+ <autodoc>__init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry</autodoc>
+ <docstring>Construct a wx.AcceleratorEntry.</docstring>
<paramlist>
<param name="flags" type="int" default="0"/>
<param name="keyCode" type="int" default="0"/>
- <param name="cmd" type="int" default="0"/>
- <param name="item" type="wxMenuItem" default="NULL"/>
+ <param name="cmdID" type="int" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxAcceleratorEntry" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(int flags, int keyCode, int cmd, MenuItem item=None)</autodoc>
+ <autodoc>Set(self, int flags, int keyCode, int cmd)</autodoc>
+ <docstring>(Re)set the attributes of a wx.AcceleratorEntry.
+:see `__init__`</docstring>
<paramlist>
<param name="flags" type="int" default=""/>
<param name="keyCode" type="int" default=""/>
<param name="cmd" type="int" default=""/>
- <param name="item" type="wxMenuItem" default="NULL"/>
- </paramlist>
- </method>
- <method name="SetMenuItem" type="" overloaded="no">
- <autodoc>SetMenuItem(MenuItem item)</autodoc>
- <paramlist>
- <param name="item" type="wxMenuItem" default=""/>
</paramlist>
</method>
- <method name="GetMenuItem" type="wxMenuItem" overloaded="no">
- <autodoc>GetMenuItem() -> MenuItem</autodoc>
- </method>
<method name="GetFlags" type="int" overloaded="no">
- <autodoc>GetFlags() -> int</autodoc>
+ <autodoc>GetFlags(self) -> int</autodoc>
+ <docstring>Get the AcceleratorEntry's flags.</docstring>
</method>
<method name="GetKeyCode" type="int" overloaded="no">
- <autodoc>GetKeyCode() -> int</autodoc>
+ <autodoc>GetKeyCode(self) -> int</autodoc>
+ <docstring>Get the AcceleratorEntry's keycode.</docstring>
</method>
<method name="GetCommand" type="int" overloaded="no">
- <autodoc>GetCommand() -> int</autodoc>
+ <autodoc>GetCommand(self) -> int</autodoc>
+ <docstring>Get the AcceleratorEntry's command ID.</docstring>
</method>
</class>
- <class name="AcceleratorTable" oldname="wxAcceleratorTable" module="core">
+ <class name="AcceleratorTable" oldname="wxAcceleratorTable" module="_core">
+ <docstring>An accelerator table allows the application to specify a table of
+keyboard shortcuts for menus or other commands. On Windows, menu or
+button commands are supported; on GTK, only menu commands are
+supported.</docstring>
<baseclass name="Object"/>
<constructor name="AcceleratorTable" overloaded="no">
<autodoc>__init__(entries) -> AcceleratorTable</autodoc>
- <docstring>Construct an AcceleratorTable from a list of AcceleratorEntry items or
-3-tuples (flags, keyCode, cmdID)</docstring>
+ <docstring>Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
+items or or of 3-tuples (flags, keyCode, cmdID)
+
+:see: `wx.AcceleratorEntry`</docstring>
<paramlist>
<param name="n" type="int" default=""/>
<param name="entries" type="AcceleratorEntry" default=""/>
</paramlist>
</constructor>
<destructor name="~wxAcceleratorTable" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
</class>
<method name="GetAccelFromString" oldname="wxGetAccelFromString" type="AcceleratorEntry" overloaded="no">
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Window" oldname="wxWindow" module="core">
- <docstring>
-wx.Window is the base class for all windows and represents any visible
+ <class name="VisualAttributes" oldname="wxVisualAttributes" module="_core">
+ <docstring>struct containing all the visual attributes of a control</docstring>
+ <constructor name="VisualAttributes" overloaded="no">
+ <autodoc>__init__(self) -> VisualAttributes</autodoc>
+ <docstring>struct containing all the visual attributes of a control</docstring>
+ </constructor>
+ <destructor name="~wxVisualAttributes" overloaded="no">
+ <autodoc>__del__(self)</autodoc>
+ </destructor>
+ <property name="font" type="wxFont" readonly="no"/>
+ <property name="colFg" type="wxColour" readonly="no"/>
+ <property name="colBg" type="wxColour" readonly="no"/>
+ </class>
+ <class name="Window" oldname="wxWindow" module="_core">
+ <docstring>wx.Window is the base class for all windows and represents any visible
object on the screen. All controls, top level windows and so on are
wx.Windows. Sizers and device contexts are not however, as they don't
appear on screen themselves.
</docstring>
- <refdoc>
- Styles
-
- wx.SIMPLE_BORDER: Displays a thin border around the window.
-
- wx.DOUBLE_BORDER: Displays a double border. Windows and Mac only.
-
- wx.SUNKEN_BORDER: Displays a sunken border.
-
- wx.RAISED_BORDER: Displays a raised border.
-
- wx.STATIC_BORDER: Displays a border suitable for a static
- control. Windows only.
-
- wx.NO_BORDER: Displays no border, overriding the default
- border style for the window.
-
- wx.TRANSPARENT_WINDOW: The window is transparent, that is, it
- will not receive paint events. Windows only.
-
- wx.TAB_TRAVERSAL: Use this to enable tab traversal for
- non-dialog windows.
-
- wx.WANTS_CHARS: Use this to indicate that the window
- wants to get all char/key events for
- all keys - even for keys like TAB or
- ENTER which are usually used for
- dialog navigation and which wouldn't
- be generated without this style. If
- you need to use this style in order to
- get the arrows or etc., but would
- still like to have normal keyboard
- navigation take place, you should
- create and send a wxNavigationKeyEvent
- in response to the key events for Tab
- and Shift-Tab.
-
- wx.NO_FULL_REPAINT_ON_RESIZE: Disables repainting the window
- completely when its size is changed
- - you will have to repaint the new
- window area manually if you use this
- style. As of version 2.5.1 this
- style is on by default. Use
- wx.FULL_REPAINT_ON_RESIZE to
- deactivate it.
-
- wx.VSCROLL: Use this style to enable a vertical scrollbar.
-
- wx.HSCROLL: Use this style to enable a horizontal scrollbar.
-
- wx.ALWAYS_SHOW_SB: If a window has scrollbars, disable them
- instead of hiding them when they are
- not needed (i.e. when the size of the
- window is big enough to not require
- the scrollbars to navigate it). This
- style is currently only implemented
- for wxMSW and wxUniversal and does
- nothing on the other platforms.
-
- wx.CLIP_CHILDREN: Use this style to eliminate flicker caused by
- the background being repainted, then
- children being painted over
- them. Windows only.
-
- wx.FULL_REPAINT_ON_RESIZE: Use this style to force a complete
- redraw of the window whenever it is
- resized instead of redrawing just the
- part of the window affected by
- resizing. Note that this was the
- behaviour by default before 2.5.1
- release and that if you experience
- redraw problems with the code which
- previously used to work you may want
- to try this.
-
- Extra Styles
-
- wx.WS_EX_VALIDATE_RECURSIVELY: By default,
- Validate/TransferDataTo/FromWindow()
- only work on direct children of
- the window (compatible
- behaviour). Set this flag to make
- them recursively descend into all
- subwindows.
-
- wx.WS_EX_BLOCK_EVENTS: wx.CommandEvents and the objects of the
- derived classes are forwarded to
- the parent window and so on
- recursively by default. Using this
- flag for the given window allows
- to block this propagation at this
- window, i.e. prevent the events
- from being propagated further
- upwards. Dialogs have this flag on
- by default.
-
- wx.WS_EX_TRANSIENT Don't use this window as an implicit parent for
- the other windows: this must be
- used with transient windows as
- otherwise there is the risk of
- creating a dialog/frame with this
- window as a parent which would
- lead to a crash if the parent is
- destroyed before the child.
-
- wx.WS_EX_PROCESS_IDLE: This window should always process idle
- events, even if the mode set by
- wx.IdleEvent.SetMode is
- wx.IDLE_PROCESS_SPECIFIED.
-
- wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI
- update events, even if the mode
- set by wxUpdateUIEvent::SetMode is
- wxUPDATE_UI_PROCESS_SPECIFIED.
-
-</refdoc>
<baseclass name="EvtHandler"/>
<constructor name="Window" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, String name=PanelNameStr) -> Window</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window</autodoc>
<docstring>Construct and show a generic Window.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<docstring>Precreate a Window for 2-phase creation.</docstring>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, String name=PanelNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool</autodoc>
<docstring>Create the GUI part of the Window for 2-phase creation mode.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
</paramlist>
</method>
<method name="Close" type="bool" overloaded="no">
- <autodoc>Close(bool force=False) -> bool</autodoc>
+ <autodoc>Close(self, bool force=False) -> bool</autodoc>
<docstring>This function simply generates a EVT_CLOSE event whose handler usually
tries to close the window. It doesn't close the window itself,
however. If force is False (the default) then the window's close
-handler will be allowed to veto the destruction of the window.
-
-Usually Close is only used with the top level windows (wx.Frame and
-wx.Dialog classes) as the others are not supposed to have any special
-EVT_CLOSE logic.
-
-The close handler should check whether the window is being deleted
-forcibly, using wx.CloseEvent.GetForce, in which case it should
-destroy the window using wx.Window.Destroy.
-
-Note that calling Close does not guarantee that the window will be
-destroyed; but it provides a way to simulate a manual close of a
-window, which may or may not be implemented by destroying the
-window. The default EVT_CLOSE handler for wx.Dialog does not
-necessarily delete the dialog, since it will simply simulate an
-wxID_CANCEL event which is handled by the appropriate button event
-handler and may do anything at all.
-
-To guarantee that the window will be destroyed, call wx.Window.Destroy
-instead.</docstring>
+handler will be allowed to veto the destruction of the window.</docstring>
<paramlist>
<param name="force" type="bool" default="False"/>
</paramlist>
</method>
<method name="Destroy" type="bool" overloaded="no">
- <autodoc>Destroy() -> bool</autodoc>
+ <autodoc>Destroy(self) -> bool</autodoc>
<docstring>Destroys the window safely. Frames and dialogs are not destroyed
immediately when this function is called -- they are added to a list
of windows to be deleted on idle time, when all the window's events
has been added to the list of windows pending real deletion.</docstring>
</method>
<method name="DestroyChildren" type="bool" overloaded="no">
- <autodoc>DestroyChildren() -> bool</autodoc>
- <docstring>Destroys all children of a window. Called automatically by the destructor.</docstring>
+ <autodoc>DestroyChildren(self) -> bool</autodoc>
+ <docstring>Destroys all children of a window. Called automatically by the
+destructor.</docstring>
</method>
<method name="IsBeingDeleted" type="bool" overloaded="no">
- <autodoc>IsBeingDeleted() -> bool</autodoc>
+ <autodoc>IsBeingDeleted(self) -> bool</autodoc>
<docstring>Is the window in the process of being deleted?</docstring>
</method>
<method name="SetTitle" type="" overloaded="no">
- <autodoc>SetTitle(String title)</autodoc>
+ <autodoc>SetTitle(self, String title)</autodoc>
<docstring>Sets the window's title. Applicable only to frames and dialogs.</docstring>
<paramlist>
<param name="title" type="String" default=""/>
</paramlist>
</method>
<method name="GetTitle" type="String" overloaded="no">
- <autodoc>GetTitle() -> String</autodoc>
+ <autodoc>GetTitle(self) -> String</autodoc>
<docstring>Gets the window's title. Applicable only to frames and dialogs.</docstring>
</method>
<method name="SetLabel" type="" overloaded="no">
- <autodoc>SetLabel(String label)</autodoc>
+ <autodoc>SetLabel(self, String label)</autodoc>
<docstring>Set the text which the window shows in its label if applicable.</docstring>
<paramlist>
<param name="label" type="String" default=""/>
</paramlist>
</method>
<method name="GetLabel" type="String" overloaded="no">
- <autodoc>GetLabel() -> String</autodoc>
- <docstring>Generic way of getting a label from any window, for
-identification purposes. The interpretation of this function
-differs from class to class. For frames and dialogs, the value
-returned is the title. For buttons or static text controls, it is
-the button text. This function can be useful for meta-programs
-(such as testing tools or special-needs access programs) which
-need to identify windows by name.</docstring>
+ <autodoc>GetLabel(self) -> String</autodoc>
+ <docstring>Generic way of getting a label from any window, for identification
+purposes. The interpretation of this function differs from class to
+class. For frames and dialogs, the value returned is the title. For
+buttons or static text controls, it is the button text. This function
+can be useful for meta-programs such as testing tools or special-needs
+access programs)which need to identify windows by name.</docstring>
</method>
<method name="SetName" type="" overloaded="no">
- <autodoc>SetName(String name)</autodoc>
- <docstring>Sets the window's name. The window name is used for ressource
-setting in X, it is not the same as the window title/label</docstring>
+ <autodoc>SetName(self, String name)</autodoc>
+ <docstring>Sets the window's name. The window name is used for ressource setting
+in X, it is not the same as the window title/label</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
- <docstring>Returns the window's name. This name is not guaranteed to be
-unique; it is up to the programmer to supply an appropriate name
-in the window constructor or via wx.Window.SetName.</docstring>
+ <autodoc>GetName(self) -> String</autodoc>
+ <docstring>Returns the windows name. This name is not guaranteed to be unique;
+it is up to the programmer to supply an appropriate name in the window
+constructor or via wx.Window.SetName.</docstring>
</method>
<method name="SetWindowVariant" type="" overloaded="no">
- <autodoc>SetWindowVariant(int variant)</autodoc>
- <docstring>Sets the variant of the window/font size to use for this window,
-if the platform supports variants, (for example, wxMac.)</docstring>
+ <autodoc>SetWindowVariant(self, int variant)</autodoc>
+ <docstring>Sets the variant of the window/font size to use for this window, if
+the platform supports variants, for example, wxMac.</docstring>
<paramlist>
<param name="variant" type="wxWindowVariant" default=""/>
</paramlist>
</method>
<method name="GetWindowVariant" type="wxWindowVariant" overloaded="no">
- <autodoc>GetWindowVariant() -> int</autodoc>
+ <autodoc>GetWindowVariant(self) -> int</autodoc>
</method>
<method name="SetId" type="" overloaded="no">
- <autodoc>SetId(int winid)</autodoc>
+ <autodoc>SetId(self, int winid)</autodoc>
<docstring>Sets the identifier of the window. Each window has an integer
identifier. If the application has not provided one, an identifier
will be generated. Normally, the identifier should be provided on
</paramlist>
</method>
<method name="GetId" type="int" overloaded="no">
- <autodoc>GetId() -> int</autodoc>
+ <autodoc>GetId(self) -> int</autodoc>
<docstring>Returns the identifier of the window. Each window has an integer
identifier. If the application has not provided one (or the default Id
-1 is used) then an unique identifier with a negative value will be
<staticmethod name="NextControlId" type="int" overloaded="no">
<autodoc>NextControlId(int winid) -> int</autodoc>
<docstring>Get the id of the control following the one with the given
-(autogenerated) id</docstring>
+autogenerated) id</docstring>
<paramlist>
<param name="winid" type="int" default=""/>
</paramlist>
<staticmethod name="PrevControlId" type="int" overloaded="no">
<autodoc>PrevControlId(int winid) -> int</autodoc>
<docstring>Get the id of the control preceding the one with the given
-(autogenerated) id</docstring>
+autogenerated) id</docstring>
<paramlist>
<param name="winid" type="int" default=""/>
</paramlist>
</staticmethod>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(Size size)</autodoc>
+ <autodoc>SetSize(self, Size size)</autodoc>
<docstring>Sets the size of the window in pixels.</docstring>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="SetDimensions" type="" overloaded="no">
- <autodoc>SetDimensions(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
+ <autodoc>SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
<docstring>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
</paramlist>
</method>
<method name="SetRect" type="" overloaded="no">
- <autodoc>SetRect(Rect rect, int sizeFlags=SIZE_AUTO)</autodoc>
+ <autodoc>SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)</autodoc>
<docstring>Sets the position and size of the window in pixels using a wx.Rect.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="SetSizeWH" type="" overloaded="no">
- <autodoc>SetSizeWH(int width, int height)</autodoc>
+ <autodoc>SetSizeWH(self, int width, int height)</autodoc>
<docstring>Sets the size of the window in pixels.</docstring>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="Move" type="" overloaded="no">
- <autodoc>Move(Point pt, int flags=SIZE_USE_EXISTING)</autodoc>
+ <autodoc>Move(self, Point pt, int flags=SIZE_USE_EXISTING)</autodoc>
<docstring>Moves the window to the given position.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="MoveXY" type="" overloaded="no">
- <autodoc>MoveXY(int x, int y, int flags=SIZE_USE_EXISTING)</autodoc>
+ <autodoc>MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)</autodoc>
<docstring>Moves the window to the given position.</docstring>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="Raise" type="" overloaded="no">
- <autodoc>Raise()</autodoc>
+ <autodoc>Raise(self)</autodoc>
<docstring>Raises the window to the top of the window hierarchy if it is a
managed window (dialog or frame).</docstring>
</method>
<method name="Lower" type="" overloaded="no">
- <autodoc>Lower()</autodoc>
+ <autodoc>Lower(self)</autodoc>
<docstring>Lowers the window to the bottom of the window hierarchy if it is a
managed window (dialog or frame).</docstring>
</method>
<method name="SetClientSize" type="" overloaded="no">
- <autodoc>SetClientSize(Size size)</autodoc>
+ <autodoc>SetClientSize(self, Size size)</autodoc>
<docstring>This sets the size of the window client area in pixels. Using this
function to size a window tends to be more device-independent than
wx.Window.SetSize, since the application need not worry about what
</paramlist>
</method>
<method name="SetClientSizeWH" type="" overloaded="no">
- <autodoc>SetClientSizeWH(int width, int height)</autodoc>
+ <autodoc>SetClientSizeWH(self, int width, int height)</autodoc>
<docstring>This sets the size of the window client area in pixels. Using this
function to size a window tends to be more device-independent than
wx.Window.SetSize, since the application need not worry about what
</paramlist>
</method>
<method name="SetClientRect" type="" overloaded="no">
- <autodoc>SetClientRect(Rect rect)</autodoc>
+ <autodoc>SetClientRect(self, Rect rect)</autodoc>
<docstring>This sets the size of the window client area in pixels. Using this
function to size a window tends to be more device-independent than
wx.Window.SetSize, since the application need not worry about what
</paramlist>
</method>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
<docstring>Get the window's position.</docstring>
</method>
<method name="GetPositionTuple" type="" overloaded="no">
</paramlist>
</method>
<method name="GetSize" type="Size" overloaded="no">
- <autodoc>GetSize() -> Size</autodoc>
+ <autodoc>GetSize(self) -> Size</autodoc>
<docstring>Get the window size.</docstring>
</method>
<method name="GetSizeTuple" type="" overloaded="no">
</paramlist>
</method>
<method name="GetRect" type="Rect" overloaded="no">
- <autodoc>GetRect() -> Rect</autodoc>
+ <autodoc>GetRect(self) -> Rect</autodoc>
<docstring>Returns the size and position of the window as a wx.Rect object.</docstring>
</method>
<method name="GetClientSize" type="Size" overloaded="no">
- <autodoc>GetClientSize() -> Size</autodoc>
+ <autodoc>GetClientSize(self) -> Size</autodoc>
<docstring>This gets the size of the window's 'client area' in pixels. The client
area is the area which may be drawn on by the programmer, excluding
title bar, border, scrollbars, etc.</docstring>
</paramlist>
</method>
<method name="GetClientAreaOrigin" type="Point" overloaded="no">
- <autodoc>GetClientAreaOrigin() -> Point</autodoc>
+ <autodoc>GetClientAreaOrigin(self) -> Point</autodoc>
<docstring>Get the origin of the client area of the window relative to the
window's top left corner (the client area may be shifted because of
the borders, scrollbars, other decorations...)</docstring>
</method>
<method name="GetClientRect" type="Rect" overloaded="no">
- <autodoc>GetClientRect() -> Rect</autodoc>
- <docstring>Get the client area position and size as a wx.Rect object.</docstring>
+ <autodoc>GetClientRect(self) -> Rect</autodoc>
+ <docstring>Get the client area position and size as a `wx.Rect` object.</docstring>
</method>
<method name="GetBestSize" type="Size" overloaded="no">
- <autodoc>GetBestSize() -> Size</autodoc>
- <docstring>This functions 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 this function will be the same as the size the window would have
-had after calling Fit.</docstring>
+ <autodoc>GetBestSize(self) -> Size</autodoc>
+ <docstring>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
+this function will be the same as the size the window would have had
+after calling Fit.</docstring>
</method>
<method name="GetBestSizeTuple" type="" overloaded="no">
<autodoc>GetBestSizeTuple() -> (width, height)</autodoc>
- <docstring>This functions 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 this function will be the same as the size the window would have
-had after calling Fit.</docstring>
+ <docstring>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
+this function will be the same as the size the window would have had
+after calling Fit.</docstring>
<paramlist>
<param name="OUTPUT" type="int" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="GetAdjustedBestSize" type="Size" overloaded="no">
- <autodoc>GetAdjustedBestSize() -> Size</autodoc>
+ <autodoc>GetAdjustedBestSize(self) -> Size</autodoc>
<docstring>This method is similar to GetBestSize, except in one
thing. GetBestSize should return the minimum untruncated size of the
window, while this method will return the largest of BestSize and any
tolerate.</docstring>
</method>
<method name="Center" type="" overloaded="no">
- <autodoc>Center(int direction=BOTH)</autodoc>
+ <autodoc>Center(self, int direction=BOTH)</autodoc>
<docstring>Centers the window. The parameter specifies the direction for
cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
also include wx.CENTER_ON_SCREEN flag if you want to center the window
</paramlist>
</method>
<method name="CenterOnScreen" type="" overloaded="no">
- <autodoc>CenterOnScreen(int dir=BOTH)</autodoc>
+ <autodoc>CenterOnScreen(self, int dir=BOTH)</autodoc>
<docstring>Center on screen (only works for top level windows)</docstring>
<paramlist>
<param name="dir" type="int" default="wxBOTH"/>
</paramlist>
</method>
<method name="CenterOnParent" type="" overloaded="no">
- <autodoc>CenterOnParent(int dir=BOTH)</autodoc>
+ <autodoc>CenterOnParent(self, int dir=BOTH)</autodoc>
<docstring>Center with respect to the the parent window</docstring>
<paramlist>
<param name="dir" type="int" default="wxBOTH"/>
</paramlist>
</method>
<method name="Fit" type="" overloaded="no">
- <autodoc>Fit()</autodoc>
+ <autodoc>Fit(self)</autodoc>
<docstring>Sizes the window so that it fits around its subwindows. This function
won't do anything if there are no subwindows and will only really work
correctly if sizers are used for the subwindows layout. Also, if the
instead of calling Fit.</docstring>
</method>
<method name="FitInside" type="" overloaded="no">
- <autodoc>FitInside()</autodoc>
+ <autodoc>FitInside(self)</autodoc>
<docstring>Similar to Fit, but sizes the interior (virtual) size of a
window. Mainly useful with scrolled windows to reset scrollbars after
sizing changes that do not trigger a size event, and/or scrolled
windows without an interior sizer. This function similarly won't do
anything if there are no subwindows.</docstring>
</method>
- <method name="SetSizeHints" type="" overloaded="no">
- <autodoc>SetSizeHints(int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
- int incH=-1)</autodoc>
+ <method name="SetSizeHints" type="" overloaded="yes">
<docstring>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
<param name="incH" type="int" default="-1"/>
</paramlist>
</method>
- <method name="SetVirtualSizeHints" type="" overloaded="no">
- <autodoc>SetVirtualSizeHints(int minW, int minH, int maxW=-1, int maxH=-1)</autodoc>
+ <method name="SetSizeHints" type="" overloaded="yes">
+ <autodoc>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)</autodoc>
+ <docstring>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.</docstring>
+ <paramlist>
+ <param name="minSize" type="Size" default=""/>
+ <param name="maxSize" type="Size" default="wxDefaultSize"/>
+ <param name="incSize" type="Size" default="wxDefaultSize"/>
+ </paramlist>
+ </method>
+ <method name="SetVirtualSizeHints" type="" overloaded="yes">
<docstring>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
<param name="maxH" type="int" default="-1"/>
</paramlist>
</method>
+ <method name="SetVirtualSizeHints" type="" overloaded="yes">
+ <autodoc>SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
+SetVirtualSizeHints(self, Size minSize, Size maxSize=DefaultSize)</autodoc>
+ <docstring>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.</docstring>
+ <paramlist>
+ <param name="minSize" type="Size" default=""/>
+ <param name="maxSize" type="Size" default="wxDefaultSize"/>
+ </paramlist>
+ </method>
<method name="GetMinWidth" type="int" overloaded="no">
- <autodoc>GetMinWidth() -> int</autodoc>
+ <autodoc>GetMinWidth(self) -> int</autodoc>
</method>
<method name="GetMinHeight" type="int" overloaded="no">
- <autodoc>GetMinHeight() -> int</autodoc>
+ <autodoc>GetMinHeight(self) -> int</autodoc>
</method>
<method name="GetMaxWidth" type="int" overloaded="no">
- <autodoc>GetMaxWidth() -> int</autodoc>
+ <autodoc>GetMaxWidth(self) -> int</autodoc>
</method>
<method name="GetMaxHeight" type="int" overloaded="no">
- <autodoc>GetMaxHeight() -> int</autodoc>
+ <autodoc>GetMaxHeight(self) -> int</autodoc>
</method>
<method name="GetMaxSize" type="Size" overloaded="no">
- <autodoc>GetMaxSize() -> Size</autodoc>
+ <autodoc>GetMaxSize(self) -> Size</autodoc>
+ </method>
+ <method name="GetMinSize" type="Size" overloaded="no">
+ <autodoc>GetMinSize(self) -> Size</autodoc>
</method>
<method name="SetVirtualSize" type="" overloaded="no">
- <autodoc>SetVirtualSize(Size size)</autodoc>
+ <autodoc>SetVirtualSize(self, Size size)</autodoc>
<docstring>Set the the virtual size of a window in pixels. For most windows this
is just the client area of the window, but for some like scrolled
windows it is more or less independent of the screen window size.</docstring>
</paramlist>
</method>
<method name="SetVirtualSizeWH" type="" overloaded="no">
- <autodoc>SetVirtualSizeWH(int w, int h)</autodoc>
+ <autodoc>SetVirtualSizeWH(self, int w, int h)</autodoc>
<docstring>Set the the virtual size of a window in pixels. For most windows this
is just the client area of the window, but for some like scrolled
windows it is more or less independent of the screen window size.</docstring>
</paramlist>
</method>
<method name="GetVirtualSize" type="Size" overloaded="no">
- <autodoc>GetVirtualSize() -> Size</autodoc>
+ <autodoc>GetVirtualSize(self) -> Size</autodoc>
<docstring>Get the the virtual size of the window in pixels. For most windows
this is just the client area of the window, but for some like scrolled
windows it is more or less independent of the screen window size.</docstring>
</paramlist>
</method>
<method name="GetBestVirtualSize" type="Size" overloaded="no">
- <autodoc>GetBestVirtualSize() -> Size</autodoc>
+ <autodoc>GetBestVirtualSize(self) -> Size</autodoc>
<docstring>Return the largest of ClientSize and BestSize (as determined by a
sizer, interior children, or other means)</docstring>
</method>
<method name="Show" type="bool" overloaded="no">
- <autodoc>Show(bool show=True) -> bool</autodoc>
+ <autodoc>Show(self, bool show=True) -> bool</autodoc>
<docstring>Shows or hides the window. You may need to call Raise for a top level
window if you want to bring it to top, although this is not needed if
Show is called immediately after the frame creation. Returns True if
</paramlist>
</method>
<method name="Hide" type="bool" overloaded="no">
- <autodoc>Hide() -> bool</autodoc>
+ <autodoc>Hide(self) -> bool</autodoc>
<docstring>Equivalent to calling Show(False).</docstring>
</method>
<method name="Enable" type="bool" overloaded="no">
- <autodoc>Enable(bool enable=True) -> bool</autodoc>
+ <autodoc>Enable(self, bool enable=True) -> bool</autodoc>
<docstring>Enable or disable the window for user input. Note that when a parent
window is disabled, all of its children are disabled as well and they
are reenabled again when the parent is. Returns true if the window
</paramlist>
</method>
<method name="Disable" type="bool" overloaded="no">
- <autodoc>Disable() -> bool</autodoc>
+ <autodoc>Disable(self) -> bool</autodoc>
<docstring>Disables the window, same as Enable(false).</docstring>
</method>
<method name="IsShown" type="bool" overloaded="no">
- <autodoc>IsShown() -> bool</autodoc>
+ <autodoc>IsShown(self) -> bool</autodoc>
<docstring>Returns true if the window is shown, false if it has been hidden.</docstring>
</method>
<method name="IsEnabled" type="bool" overloaded="no">
- <autodoc>IsEnabled() -> bool</autodoc>
+ <autodoc>IsEnabled(self) -> bool</autodoc>
<docstring>Returns true if the window is enabled for input, false otherwise.</docstring>
</method>
<method name="SetWindowStyleFlag" type="" overloaded="no">
- <autodoc>SetWindowStyleFlag(long style)</autodoc>
+ <autodoc>SetWindowStyleFlag(self, long style)</autodoc>
<docstring>Sets the style of the window. Please note that some styles cannot be
-changed after the window creation and that Refresh() might be called
-after changing the others for the change to take place immediately.</docstring>
+changed after the window creation and that Refresh() might need to be
+called after changing the others for the change to take place
+immediately.</docstring>
<paramlist>
<param name="style" type="long" default=""/>
</paramlist>
</method>
<method name="GetWindowStyleFlag" type="long" overloaded="no">
- <autodoc>GetWindowStyleFlag() -> long</autodoc>
+ <autodoc>GetWindowStyleFlag(self) -> long</autodoc>
<docstring>Gets the window style that was passed to the constructor or Create
method.</docstring>
</method>
<method name="HasFlag" type="bool" overloaded="no">
- <autodoc>HasFlag(int flag) -> bool</autodoc>
+ <autodoc>HasFlag(self, int flag) -> bool</autodoc>
<docstring>Test if the given style is set for this window.</docstring>
<paramlist>
<param name="flag" type="int" default=""/>
</paramlist>
</method>
<method name="IsRetained" type="bool" overloaded="no">
- <autodoc>IsRetained() -> bool</autodoc>
+ <autodoc>IsRetained(self) -> bool</autodoc>
<docstring>Returns true if the window is retained, false otherwise. Retained
windows are only available on X platforms.</docstring>
</method>
<method name="SetExtraStyle" type="" overloaded="no">
- <autodoc>SetExtraStyle(long exStyle)</autodoc>
+ <autodoc>SetExtraStyle(self, long exStyle)</autodoc>
<docstring>Sets the extra style bits for the window. Extra styles are the less
often used style bits which can't be set with the constructor or with
SetWindowStyleFlag()</docstring>
</paramlist>
</method>
<method name="GetExtraStyle" type="long" overloaded="no">
- <autodoc>GetExtraStyle() -> long</autodoc>
+ <autodoc>GetExtraStyle(self) -> long</autodoc>
<docstring>Returns the extra style bits for the window.</docstring>
</method>
<method name="MakeModal" type="" overloaded="no">
- <autodoc>MakeModal(bool modal=True)</autodoc>
+ <autodoc>MakeModal(self, bool modal=True)</autodoc>
<docstring>Disables all other windows in the application so that the user can
only interact with this window. Passing False will reverse this
effect.</docstring>
</paramlist>
</method>
<method name="SetThemeEnabled" type="" overloaded="no">
- <autodoc>SetThemeEnabled(bool enableTheme)</autodoc>
+ <autodoc>SetThemeEnabled(self, bool enableTheme)</autodoc>
<docstring>This function tells a window if it should use the system's "theme"
code to draw the windows' background instead if its own background
drawing code. This will only have an effect on platforms that support
</paramlist>
</method>
<method name="GetThemeEnabled" type="bool" overloaded="no">
- <autodoc>GetThemeEnabled() -> bool</autodoc>
+ <autodoc>GetThemeEnabled(self) -> bool</autodoc>
<docstring>Return the themeEnabled flag.</docstring>
</method>
<method name="SetFocus" type="" overloaded="no">
- <autodoc>SetFocus()</autodoc>
+ <autodoc>SetFocus(self)</autodoc>
<docstring>Set's the focus to this window, allowing it to receive keyboard input.</docstring>
</method>
<method name="SetFocusFromKbd" type="" overloaded="no">
- <autodoc>SetFocusFromKbd()</autodoc>
+ <autodoc>SetFocusFromKbd(self)</autodoc>
<docstring>Set focus to this window as the result of a keyboard action. Normally
only called internally.</docstring>
</method>
or None.</docstring>
</staticmethod>
<method name="AcceptsFocus" type="bool" overloaded="no">
- <autodoc>AcceptsFocus() -> bool</autodoc>
+ <autodoc>AcceptsFocus(self) -> bool</autodoc>
<docstring>Can this window have focus?</docstring>
</method>
<method name="AcceptsFocusFromKeyboard" type="bool" overloaded="no">
- <autodoc>AcceptsFocusFromKeyboard() -> bool</autodoc>
+ <autodoc>AcceptsFocusFromKeyboard(self) -> bool</autodoc>
<docstring>Can this window be given focus by keyboard navigation? if not, the
only way to give it focus (provided it accepts it at all) is to click
it.</docstring>
</method>
<method name="GetDefaultItem" type="Window" overloaded="no">
- <autodoc>GetDefaultItem() -> Window</autodoc>
+ <autodoc>GetDefaultItem(self) -> Window</autodoc>
<docstring>Get the default child of this parent, i.e. the one which is activated
by pressing <Enter> such as the OK button on a wx.Dialog.</docstring>
</method>
<method name="SetDefaultItem" type="Window" overloaded="no">
- <autodoc>SetDefaultItem(Window child) -> Window</autodoc>
+ <autodoc>SetDefaultItem(self, Window child) -> Window</autodoc>
<docstring>Set this child as default, return the old default.</docstring>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
<method name="SetTmpDefaultItem" type="" overloaded="no">
- <autodoc>SetTmpDefaultItem(Window win)</autodoc>
+ <autodoc>SetTmpDefaultItem(self, Window win)</autodoc>
<docstring>Set this child as temporary default</docstring>
<paramlist>
<param name="win" type="Window" default=""/>
</paramlist>
</method>
<method name="GetChildren" type="PyObject" overloaded="no">
- <autodoc>GetChildren() -> PyObject</autodoc>
+ <autodoc>GetChildren(self) -> PyObject</autodoc>
<docstring>Returns a list of the window's children. NOTE: Currently this is a
copy of the child window list maintained by the window, so the return
value of this function is only valid as long as the window's children
do not change.</docstring>
</method>
<method name="GetParent" type="Window" overloaded="no">
- <autodoc>GetParent() -> Window</autodoc>
+ <autodoc>GetParent(self) -> Window</autodoc>
<docstring>Returns the parent window of this window, or None if there isn't one.</docstring>
</method>
<method name="GetGrandParent" type="Window" overloaded="no">
- <autodoc>GetGrandParent() -> Window</autodoc>
- <docstring>Returns the parent of the parent of this window, or None if there isn't one.</docstring>
+ <autodoc>GetGrandParent(self) -> Window</autodoc>
+ <docstring>Returns the parent of the parent of this window, or None if there
+isn't one.</docstring>
</method>
<method name="IsTopLevel" type="bool" overloaded="no">
- <autodoc>IsTopLevel() -> bool</autodoc>
+ <autodoc>IsTopLevel(self) -> bool</autodoc>
<docstring>Returns true if the given window is a top-level one. Currently all
frames and dialogs are always considered to be top-level windows (even
if they have a parent window).</docstring>
</method>
<method name="Reparent" type="bool" overloaded="no">
- <autodoc>Reparent(Window newParent) -> bool</autodoc>
+ <autodoc>Reparent(self, Window newParent) -> bool</autodoc>
<docstring>Reparents the window, i.e the window will be removed from its current
parent window (e.g. a non-standard toolbar in a wxFrame) and then
re-inserted into another. Available on Windows and GTK. Returns True
</paramlist>
</method>
<method name="AddChild" type="" overloaded="no">
- <autodoc>AddChild(Window child)</autodoc>
+ <autodoc>AddChild(self, Window child)</autodoc>
<docstring>Adds a child window. This is called automatically by window creation
functions so should not be required by the application programmer.</docstring>
<paramlist>
</paramlist>
</method>
<method name="RemoveChild" type="" overloaded="no">
- <autodoc>RemoveChild(Window child)</autodoc>
+ <autodoc>RemoveChild(self, Window child)</autodoc>
<docstring>Removes a child window. This is called automatically by window
deletion functions so should not be required by the application
programmer.</docstring>
</paramlist>
</method>
<method name="FindWindowById" type="Window" overloaded="no">
- <autodoc>FindWindowById(long winid) -> Window</autodoc>
+ <autodoc>FindWindowById(self, long winid) -> Window</autodoc>
<docstring>Find a chld of this window by window ID</docstring>
<paramlist>
<param name="winid" type="long" default=""/>
</paramlist>
</method>
<method name="FindWindowByName" type="Window" overloaded="no">
- <autodoc>FindWindowByName(String name) -> Window</autodoc>
+ <autodoc>FindWindowByName(self, String name) -> Window</autodoc>
<docstring>Find a child of this window by name</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="GetEventHandler" type="EvtHandler" overloaded="no">
- <autodoc>GetEventHandler() -> EvtHandler</autodoc>
+ <autodoc>GetEventHandler(self) -> EvtHandler</autodoc>
<docstring>Returns the event handler for this window. By default, the window is
its own event handler.</docstring>
</method>
<method name="SetEventHandler" type="" overloaded="no">
- <autodoc>SetEventHandler(EvtHandler handler)</autodoc>
+ <autodoc>SetEventHandler(self, EvtHandler handler)</autodoc>
<docstring>Sets the event handler for this window. An event handler is an object
that is capable of processing the events sent to a window. By default,
the window is its own event handler, but an application may wish to
substitute another, for example to allow central implementation of
event-handling for a variety of different window classes.
-It is usually better to use wx.Window.PushEventHandler since this sets
+It is usually better to use `wx.Window.PushEventHandler` since this sets
up a chain of event handlers, where an event not handled by one event
handler is handed to the next one in the chain.</docstring>
<paramlist>
</paramlist>
</method>
<method name="PushEventHandler" type="" overloaded="no">
- <autodoc>PushEventHandler(EvtHandler handler)</autodoc>
+ <autodoc>PushEventHandler(self, EvtHandler handler)</autodoc>
<docstring>Pushes this event handler onto the event handler stack for the window.
An event handler is an object that is capable of processing the events
sent to a window. By default, the window is its own event handler, but
wx.Window.PushEventHandler allows an application to set up a chain of
event handlers, where an event not handled by one event handler is
-handed to the next one in the chain. Use wx.Window.PopEventHandler to
+handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
remove the event handler.</docstring>
<paramlist>
<param name="handler" type="EvtHandler" default=""/>
</paramlist>
</method>
<method name="PopEventHandler" type="EvtHandler" overloaded="no">
- <autodoc>PopEventHandler(bool deleteHandler=False) -> EvtHandler</autodoc>
+ <autodoc>PopEventHandler(self, bool deleteHandler=False) -> EvtHandler</autodoc>
<docstring>Removes and returns the top-most event handler on the event handler
stack. If deleteHandler is True then the wx.EvtHandler object will be
destroyed after it is popped.</docstring>
</paramlist>
</method>
<method name="RemoveEventHandler" type="bool" overloaded="no">
- <autodoc>RemoveEventHandler(EvtHandler handler) -> bool</autodoc>
- <docstring>Find the given handler in the event handler chain and remove (but
-not delete) it from the event handler chain, return True if it was
-found and False otherwise (this also results in an assert failure so
-this function should only be called when the handler is supposed to
-be there.)</docstring>
+ <autodoc>RemoveEventHandler(self, EvtHandler handler) -> bool</autodoc>
+ <docstring>Find the given handler in the event handler chain and remove (but not
+delete) it from the event handler chain, return True if it was found
+and False otherwise (this also results in an assert failure so this
+function should only be called when the handler is supposed to be
+there.)</docstring>
<paramlist>
<param name="handler" type="EvtHandler" default=""/>
</paramlist>
</method>
<method name="SetValidator" type="" overloaded="no">
- <autodoc>SetValidator(Validator validator)</autodoc>
+ <autodoc>SetValidator(self, Validator validator)</autodoc>
<docstring>Deletes the current validator (if any) and sets the window validator,
having called wx.Validator.Clone to create a new validator of this
type.</docstring>
</paramlist>
</method>
<method name="GetValidator" type="wxValidator" overloaded="no">
- <autodoc>GetValidator() -> Validator</autodoc>
+ <autodoc>GetValidator(self) -> Validator</autodoc>
<docstring>Returns a pointer to the current validator for the window, or None if
there is none.</docstring>
+ </method>
+ <method name="Validate" type="bool" overloaded="no">
+ <autodoc>Validate(self) -> bool</autodoc>
+ <docstring>Validates the current values of the child controls using their
+validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
+style flag set, the method will also call Validate() of all child
+windows. Returns false if any of the validations failed.</docstring>
+ </method>
+ <method name="TransferDataToWindow" type="bool" overloaded="no">
+ <autodoc>TransferDataToWindow(self) -> bool</autodoc>
+ <docstring>Transfers values to child controls from data areas specified by their
+validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
+style flag set, the method will also call TransferDataToWindow() of
+all child windows.</docstring>
+ </method>
+ <method name="TransferDataFromWindow" type="bool" overloaded="no">
+ <autodoc>TransferDataFromWindow(self) -> bool</autodoc>
+ <docstring>Transfers values from child controls to data areas specified by their
+validators. Returns false if a transfer failed. If the window has
+wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
+also call TransferDataFromWindow() of all child windows.</docstring>
+ </method>
+ <method name="InitDialog" type="" overloaded="no">
+ <autodoc>InitDialog(self)</autodoc>
+ <docstring>Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
+to the dialog via validators.</docstring>
</method>
<method name="SetAcceleratorTable" type="" overloaded="no">
- <autodoc>SetAcceleratorTable(AcceleratorTable accel)</autodoc>
+ <autodoc>SetAcceleratorTable(self, AcceleratorTable accel)</autodoc>
<docstring>Sets the accelerator table for this window.</docstring>
<paramlist>
<param name="accel" type="AcceleratorTable" default=""/>
</paramlist>
</method>
<method name="GetAcceleratorTable" type="AcceleratorTable" overloaded="no">
- <autodoc>GetAcceleratorTable() -> AcceleratorTable</autodoc>
+ <autodoc>GetAcceleratorTable(self) -> AcceleratorTable</autodoc>
<docstring>Gets the accelerator table for this window.</docstring>
</method>
<method name="RegisterHotKey" type="bool" overloaded="no">
- <autodoc>RegisterHotKey(int hotkeyId, int modifiers, int keycode) -> bool</autodoc>
+ <autodoc>RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool</autodoc>
<docstring>Registers a system wide hotkey. Every time the user presses the hotkey
registered here, this window will receive a hotkey event. It will
receive the event even if the application is in the background and
</paramlist>
</method>
<method name="UnregisterHotKey" type="bool" overloaded="no">
- <autodoc>UnregisterHotKey(int hotkeyId) -> bool</autodoc>
+ <autodoc>UnregisterHotKey(self, int hotkeyId) -> bool</autodoc>
<docstring>Unregisters a system wide hotkey.</docstring>
<paramlist>
<param name="hotkeyId" type="int" default=""/>
</paramlist>
</method>
<method name="ConvertDialogPointToPixels" type="Point" overloaded="no">
- <autodoc>ConvertDialogPointToPixels(Point pt) -> Point</autodoc>
+ <autodoc>ConvertDialogPointToPixels(self, Point pt) -> Point</autodoc>
<docstring>Converts a point or size from dialog units to pixels. Dialog units
are used for maintaining a dialog's proportions even if the font
changes. For the x dimension, the dialog units are multiplied by the
</paramlist>
</method>
<method name="ConvertDialogSizeToPixels" type="Size" overloaded="no">
- <autodoc>ConvertDialogSizeToPixels(Size sz) -> Size</autodoc>
+ <autodoc>ConvertDialogSizeToPixels(self, Size sz) -> Size</autodoc>
<docstring>Converts a point or size from dialog units to pixels. Dialog units
are used for maintaining a dialog's proportions even if the font
changes. For the x dimension, the dialog units are multiplied by the
</paramlist>
</method>
<method name="DLG_PNT" type="Point" overloaded="no">
- <autodoc>DLG_PNT(Point pt) -> Point</autodoc>
+ <autodoc>DLG_PNT(self, Point pt) -> Point</autodoc>
<docstring>Converts a point or size from dialog units to pixels. Dialog units
are used for maintaining a dialog's proportions even if the font
changes. For the x dimension, the dialog units are multiplied by the
</paramlist>
</method>
<method name="DLG_SZE" type="Size" overloaded="no">
- <autodoc>DLG_SZE(Size sz) -> Size</autodoc>
+ <autodoc>DLG_SZE(self, Size sz) -> Size</autodoc>
<docstring>Converts a point or size from dialog units to pixels. Dialog units
are used for maintaining a dialog's proportions even if the font
changes. For the x dimension, the dialog units are multiplied by the
</paramlist>
</method>
<method name="ConvertPixelPointToDialog" type="Point" overloaded="no">
- <autodoc>ConvertPixelPointToDialog(Point pt) -> Point</autodoc>
+ <autodoc>ConvertPixelPointToDialog(self, Point pt) -> Point</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="ConvertPixelSizeToDialog" type="Size" overloaded="no">
- <autodoc>ConvertPixelSizeToDialog(Size sz) -> Size</autodoc>
+ <autodoc>ConvertPixelSizeToDialog(self, Size sz) -> Size</autodoc>
<paramlist>
<param name="sz" type="Size" default=""/>
</paramlist>
</method>
<method name="WarpPointer" type="" overloaded="no">
- <autodoc>WarpPointer(int x, int y)</autodoc>
+ <autodoc>WarpPointer(self, int x, int y)</autodoc>
<docstring>Moves the pointer to the given position on the window.
NOTE: This function is not supported under Mac because Apple Human
</paramlist>
</method>
<method name="CaptureMouse" type="" overloaded="no">
- <autodoc>CaptureMouse()</autodoc>
+ <autodoc>CaptureMouse(self)</autodoc>
<docstring>Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
release the capture.
release the mouse as many times as you capture it.</docstring>
</method>
<method name="ReleaseMouse" type="" overloaded="no">
- <autodoc>ReleaseMouse()</autodoc>
+ <autodoc>ReleaseMouse(self)</autodoc>
<docstring>Releases mouse input captured with wx.Window.CaptureMouse.</docstring>
</method>
<staticmethod name="GetCapture" type="Window" overloaded="no">
<docstring>Returns the window which currently captures the mouse or None</docstring>
</staticmethod>
<method name="HasCapture" type="bool" overloaded="no">
- <autodoc>HasCapture() -> bool</autodoc>
+ <autodoc>HasCapture(self) -> bool</autodoc>
<docstring>Returns true if this window has the current mouse capture.</docstring>
</method>
<method name="Refresh" type="" overloaded="no">
- <autodoc>Refresh(bool eraseBackground=True, Rect rect=None)</autodoc>
+ <autodoc>Refresh(self, bool eraseBackground=True, Rect rect=None)</autodoc>
<docstring>Mark the specified rectangle (or the whole window) as "dirty" so it
will be repainted. Causes an EVT_PAINT event to be generated and sent
to the window.</docstring>
</paramlist>
</method>
<method name="RefreshRect" type="" overloaded="no">
- <autodoc>RefreshRect(Rect rect)</autodoc>
+ <autodoc>RefreshRect(self, Rect rect)</autodoc>
<docstring>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.</docstring>
<paramlist>
</paramlist>
</method>
<method name="Update" type="" overloaded="no">
- <autodoc>Update()</autodoc>
+ <autodoc>Update(self)</autodoc>
<docstring>Calling this method immediately repaints the invalidated area of the
window instead of waiting for the EVT_PAINT event to happen, (normally
this would usually only happen when the flow of control returns to the
it) unconditionally.</docstring>
</method>
<method name="ClearBackground" type="" overloaded="no">
- <autodoc>ClearBackground()</autodoc>
+ <autodoc>ClearBackground(self)</autodoc>
<docstring>Clears the window by filling it with the current background
colour. Does not cause an erase background event to be generated.</docstring>
</method>
<method name="Freeze" type="" overloaded="no">
- <autodoc>Freeze()</autodoc>
- <docstring>Freezes the window or, in other words, prevents any updates from taking place
-on screen, the window is not redrawn at all. Thaw must be called to reenable
-window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw
-being delayed until all the nesting has been undone.
+ <autodoc>Freeze(self)</autodoc>
+ <docstring>Freezes the window or, in other words, prevents any updates from
+taking place on screen, the window is not redrawn at all. Thaw must be
+called to reenable window redrawing. Calls to Freeze/Thaw may be
+nested, with the actual Thaw being delayed until all the nesting has
+been undone.
This method is useful for visual appearance optimization (for example,
it is a good idea to use it before inserting large amount of text into
mandatory directive.</docstring>
</method>
<method name="Thaw" type="" overloaded="no">
- <autodoc>Thaw()</autodoc>
+ <autodoc>Thaw(self)</autodoc>
<docstring>Reenables window updating after a previous call to Freeze. Calls to
-Freeze/Thaw may be nested, so Thaw must be called the same number of times
-that Freeze was before the window will be updated.</docstring>
+Freeze/Thaw may be nested, so Thaw must be called the same number of
+times that Freeze was before the window will be updated.</docstring>
</method>
<method name="PrepareDC" type="" overloaded="no">
- <autodoc>PrepareDC(DC dc)</autodoc>
+ <autodoc>PrepareDC(self, DC dc)</autodoc>
<docstring>Call this function to prepare the device context for drawing a
scrolled image. It sets the device origin according to the current
scroll position.</docstring>
</paramlist>
</method>
<method name="GetUpdateRegion" type="wxRegion" overloaded="no">
- <autodoc>GetUpdateRegion() -> Region</autodoc>
+ <autodoc>GetUpdateRegion(self) -> Region</autodoc>
<docstring>Returns the region specifying which parts of the window have been
damaged. Should only be called within an EVT_PAINT handler.</docstring>
</method>
<method name="GetUpdateClientRect" type="Rect" overloaded="no">
- <autodoc>GetUpdateClientRect() -> Rect</autodoc>
+ <autodoc>GetUpdateClientRect(self) -> Rect</autodoc>
<docstring>Get the update rectangle region bounding box in client coords.</docstring>
</method>
<method name="IsExposed" type="bool" overloaded="no">
- <autodoc>IsExposed(int x, int y, int w=1, int h=1) -> bool</autodoc>
+ <autodoc>IsExposed(self, int x, int y, int w=1, int h=1) -> bool</autodoc>
<docstring>Returns true if the given point or rectangle area has been exposed
since the last repaint. Call this in an paint event handler to
optimize redrawing by only redrawing those areas, which have been
</paramlist>
</method>
<method name="IsExposedPoint" type="bool" overloaded="no">
- <autodoc>IsExposedPoint(Point pt) -> bool</autodoc>
+ <autodoc>IsExposedPoint(self, Point pt) -> bool</autodoc>
<docstring>Returns true if the given point or rectangle area has been exposed
since the last repaint. Call this in an paint event handler to
optimize redrawing by only redrawing those areas, which have been
</paramlist>
</method>
<method name="IsExposedRect" type="bool" overloaded="no">
- <autodoc>IsExposedRect(Rect rect) -> bool</autodoc>
+ <autodoc>IsExposedRect(self, Rect rect) -> bool</autodoc>
<docstring>Returns true if the given point or rectangle area has been exposed
since the last repaint. Call this in an paint event handler to
optimize redrawing by only redrawing those areas, which have been
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
+ <method name="GetDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetDefaultAttributes(self) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for an instance of this class. This is
+useful if you want to use the same font or colour in your own control
+as in a standard control -- which is a much better idea than hard
+coding specific colours or fonts which might look completely out of
+place on the user's system, especially if it uses themes.</docstring>
+ </method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
<method name="SetBackgroundColour" type="bool" overloaded="no">
- <autodoc>SetBackgroundColour(Colour colour) -> bool</autodoc>
+ <autodoc>SetBackgroundColour(self, Colour colour) -> bool</autodoc>
<docstring>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.
-Note that setting the background colour does not cause an immediate
+Note that setting the background colour may not cause an immediate
refresh, so you may wish to call ClearBackground or Refresh after
calling this function.
<param name="colour" type="wxColour" default=""/>
</paramlist>
</method>
+ <method name="SetDefaultBackgroundColour" type="" overloaded="no">
+ <autodoc>SetDefaultBackgroundColour(self, Colour colour)</autodoc>
+ <paramlist>
+ <param name="colour" type="wxColour" default=""/>
+ </paramlist>
+ </method>
<method name="SetForegroundColour" type="bool" overloaded="no">
- <autodoc>SetForegroundColour(Colour colour) -> bool</autodoc>
+ <autodoc>SetForegroundColour(self, Colour colour) -> bool</autodoc>
<docstring>Sets the foreground colour of the window. Returns True is the colour
was changed. The interpretation of foreground colour is dependent on
the window class; it may be the text colour or other colour, or it may
<param name="colour" type="wxColour" default=""/>
</paramlist>
</method>
+ <method name="SetDefaultForegroundColour" type="" overloaded="no">
+ <autodoc>SetDefaultForegroundColour(self, Colour colour)</autodoc>
+ <paramlist>
+ <param name="colour" type="wxColour" default=""/>
+ </paramlist>
+ </method>
<method name="GetBackgroundColour" type="wxColour" overloaded="no">
- <autodoc>GetBackgroundColour() -> Colour</autodoc>
+ <autodoc>GetBackgroundColour(self) -> Colour</autodoc>
<docstring>Returns the background colour of the window.</docstring>
</method>
<method name="GetForegroundColour" type="wxColour" overloaded="no">
- <autodoc>GetForegroundColour() -> Colour</autodoc>
+ <autodoc>GetForegroundColour(self) -> Colour</autodoc>
<docstring>Returns the foreground colour of the window. The interpretation of
foreground colour is dependent on the window class; it may be the text
colour or other colour, or it may not be used at all.</docstring>
</method>
<method name="SetCursor" type="bool" overloaded="no">
- <autodoc>SetCursor(Cursor cursor) -> bool</autodoc>
+ <autodoc>SetCursor(self, Cursor cursor) -> bool</autodoc>
<docstring>Sets the window's cursor. Notice that the window cursor also sets it
for the children of the window implicitly.
</paramlist>
</method>
<method name="GetCursor" type="wxCursor" overloaded="no">
- <autodoc>GetCursor() -> Cursor</autodoc>
+ <autodoc>GetCursor(self) -> Cursor</autodoc>
<docstring>Return the cursor associated with this window.</docstring>
</method>
<method name="SetFont" type="bool" overloaded="no">
- <autodoc>SetFont(Font font) -> bool</autodoc>
+ <autodoc>SetFont(self, Font font) -> bool</autodoc>
<docstring>Sets the font for this window.</docstring>
<paramlist>
<param name="font" type="wxFont" default=""/>
</paramlist>
</method>
+ <method name="SetDefaultFont" type="" overloaded="no">
+ <autodoc>SetDefaultFont(self, Font font)</autodoc>
+ <paramlist>
+ <param name="font" type="wxFont" default=""/>
+ </paramlist>
+ </method>
<method name="GetFont" type="wxFont" overloaded="no">
- <autodoc>GetFont() -> Font</autodoc>
+ <autodoc>GetFont(self) -> Font</autodoc>
<docstring>Returns the default font used for this window.</docstring>
</method>
<method name="SetCaret" type="" overloaded="no">
- <autodoc>SetCaret(Caret caret)</autodoc>
+ <autodoc>SetCaret(self, Caret caret)</autodoc>
<docstring>Sets the caret associated with the window.</docstring>
<paramlist>
<param name="caret" type="wxCaret" default=""/>
</paramlist>
</method>
<method name="GetCaret" type="wxCaret" overloaded="no">
- <autodoc>GetCaret() -> Caret</autodoc>
+ <autodoc>GetCaret(self) -> Caret</autodoc>
<docstring>Returns the caret associated with the window.</docstring>
</method>
<method name="GetCharHeight" type="int" overloaded="no">
- <autodoc>GetCharHeight() -> int</autodoc>
+ <autodoc>GetCharHeight(self) -> int</autodoc>
<docstring>Get the (average) character size for the current font.</docstring>
</method>
<method name="GetCharWidth" type="int" overloaded="no">
- <autodoc>GetCharWidth() -> int</autodoc>
+ <autodoc>GetCharWidth(self) -> int</autodoc>
<docstring>Get the (average) character size for the current font.</docstring>
</method>
<method name="GetTextExtent" type="" overloaded="no">
<autodoc>GetTextExtent(String string) -> (width, height)</autodoc>
- <docstring>Get the width and height of the text using the current font.</docstring>
<paramlist>
<param name="string" type="String" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="ClientToScreen" type="Point" overloaded="no">
- <autodoc>ClientToScreen(Point pt) -> Point</autodoc>
+ <autodoc>ClientToScreen(self, Point pt) -> Point</autodoc>
<docstring>Converts to screen coordinates from coordinates relative to this window.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="ScreenToClient" type="Point" overloaded="no">
- <autodoc>ScreenToClient(Point pt) -> Point</autodoc>
+ <autodoc>ScreenToClient(self, Point pt) -> Point</autodoc>
<docstring>Converts from screen to client window coordinates.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="HitTestXY" type="wxHitTest" overloaded="no">
- <autodoc>HitTestXY(int x, int y) -> int</autodoc>
+ <autodoc>HitTestXY(self, int x, int y) -> int</autodoc>
<docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="HitTest" type="wxHitTest" overloaded="no">
- <autodoc>HitTest(Point pt) -> int</autodoc>
+ <autodoc>HitTest(self, Point pt) -> int</autodoc>
<docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="GetBorder" type="wxBorder" overloaded="yes">
- <autodoc>GetBorder(long flags) -> int
-GetBorder() -> int</autodoc>
+ <autodoc>GetBorder(self, long flags) -> int
+GetBorder(self) -> int</autodoc>
<docstring>Get border for the flags of this window</docstring>
</method>
<method name="UpdateWindowUI" type="" overloaded="no">
- <autodoc>UpdateWindowUI(long flags=UPDATE_UI_NONE)</autodoc>
+ <autodoc>UpdateWindowUI(self, long flags=UPDATE_UI_NONE)</autodoc>
<docstring>This function sends EVT_UPDATE_UI events to the window. The particular
implementation depends on the window; for example a wx.ToolBar will
send an update UI event for each toolbar button, and a wx.Frame will
concerned). This may be necessary if you have called
wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
limit the overhead that wxWindows incurs by sending update UI events
-in idle time.
-
-The flags should be a bitlist of one or more of the following values:
-
- wx.UPDATE_UI_NONE No particular value
- wx.UPDATE_UI_RECURSE Call the function for descendants
- wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
-
-If you are calling this function from an OnIdle function, make sure
-you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window to
-only update the UI elements that need to be updated in idle time. Some
-windows update their elements only when necessary, for example when a
-menu is about to be shown. The following is an example of how to call
-UpdateWindowUI from an idle function.
-
- def OnIdle(self, evt):
- if wx.UpdateUIEvent.CanUpdate(self):
- self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
-</docstring>
+in idle time.</docstring>
<paramlist>
<param name="flags" type="long" default="wxUPDATE_UI_NONE"/>
</paramlist>
</method>
<method name="PopupMenuXY" type="bool" overloaded="no">
- <autodoc>PopupMenuXY(Menu menu, int x, int y) -> bool</autodoc>
+ <autodoc>PopupMenuXY(self, Menu menu, int x, int y) -> bool</autodoc>
<docstring>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
</paramlist>
</method>
<method name="PopupMenu" type="bool" overloaded="no">
- <autodoc>PopupMenu(Menu menu, Point pos) -> bool</autodoc>
+ <autodoc>PopupMenu(self, Menu menu, Point pos) -> bool</autodoc>
<docstring>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
</paramlist>
</method>
<method name="GetHandle" type="long" overloaded="no">
- <autodoc>GetHandle() -> long</autodoc>
+ <autodoc>GetHandle(self) -> long</autodoc>
<docstring>Returns the platform-specific handle (as a long integer) of the
physical window. Currently on wxMac it returns the handle of the
toplevel parent of the window.</docstring>
</method>
<method name="HasScrollbar" type="bool" overloaded="no">
- <autodoc>HasScrollbar(int orient) -> bool</autodoc>
+ <autodoc>HasScrollbar(self, int orient) -> bool</autodoc>
<docstring>Does the window have the scrollbar for this orientation?</docstring>
<paramlist>
<param name="orient" type="int" default=""/>
</paramlist>
</method>
<method name="SetScrollbar" type="" overloaded="no">
- <autodoc>SetScrollbar(int orientation, int pos, int thumbvisible, int range,
+ <autodoc>SetScrollbar(self, int orientation, int position, int thumbSize, int range,
bool refresh=True)</autodoc>
- <docstring>Sets the scrollbar properties of a built-in scrollbar.
-
- orientation: Determines the scrollbar whose page size is to be
- set. May be wx.HORIZONTAL or wx.VERTICAL.
-
- position: The position of the scrollbar in scroll units.
-
- thumbSize: The size of the thumb, or visible portion of the
- scrollbar, in scroll units.
-
- range: The maximum position of the scrollbar.
-
- refresh: True to redraw the scrollbar, false otherwise.</docstring>
+ <docstring>Sets the scrollbar properties of a built-in scrollbar.</docstring>
<paramlist>
<param name="orientation" type="int" default=""/>
- <param name="pos" type="int" default=""/>
- <param name="thumbvisible" type="int" default=""/>
+ <param name="position" type="int" default=""/>
+ <param name="thumbSize" type="int" default=""/>
<param name="range" type="int" default=""/>
<param name="refresh" type="bool" default="True"/>
</paramlist>
</method>
<method name="SetScrollPos" type="" overloaded="no">
- <autodoc>SetScrollPos(int orientation, int pos, bool refresh=True)</autodoc>
+ <autodoc>SetScrollPos(self, int orientation, int pos, bool refresh=True)</autodoc>
<docstring>Sets the position of one of the built-in scrollbars.</docstring>
<paramlist>
<param name="orientation" type="int" default=""/>
</paramlist>
</method>
<method name="GetScrollPos" type="int" overloaded="no">
- <autodoc>GetScrollPos(int orientation) -> int</autodoc>
+ <autodoc>GetScrollPos(self, int orientation) -> int</autodoc>
<docstring>Returns the built-in scrollbar position.</docstring>
<paramlist>
<param name="orientation" type="int" default=""/>
</paramlist>
</method>
<method name="GetScrollThumb" type="int" overloaded="no">
- <autodoc>GetScrollThumb(int orientation) -> int</autodoc>
+ <autodoc>GetScrollThumb(self, int orientation) -> int</autodoc>
<docstring>Returns the built-in scrollbar thumb size.</docstring>
<paramlist>
<param name="orientation" type="int" default=""/>
</paramlist>
</method>
<method name="GetScrollRange" type="int" overloaded="no">
- <autodoc>GetScrollRange(int orientation) -> int</autodoc>
+ <autodoc>GetScrollRange(self, int orientation) -> int</autodoc>
<docstring>Returns the built-in scrollbar range.</docstring>
<paramlist>
<param name="orientation" type="int" default=""/>
</paramlist>
</method>
<method name="ScrollWindow" type="" overloaded="no">
- <autodoc>ScrollWindow(int dx, int dy, Rect rect=None)</autodoc>
+ <autodoc>ScrollWindow(self, int dx, int dy, Rect rect=None)</autodoc>
<docstring>Physically scrolls the pixels in the window and move child windows
accordingly. Use this function to optimise your scrolling
implementations, to minimise the area that must be redrawn. Note that
-it is rarely required to call this function from a user program.
-
- dx: Amount to scroll horizontally.
-
- dy: Amount to scroll vertically.
-
- rect: Rectangle to invalidate. If this is None, the whole window
- is invalidated. If you pass a rectangle corresponding to the
- area of the window exposed by the scroll, your painting
- handler can optimize painting by checking for the
- invalidated region.</docstring>
+it is rarely required to call this function from a user program.</docstring>
<paramlist>
<param name="dx" type="int" default=""/>
<param name="dy" type="int" default=""/>
</paramlist>
</method>
<method name="ScrollLines" type="bool" overloaded="no">
- <autodoc>ScrollLines(int lines) -> bool</autodoc>
+ <autodoc>ScrollLines(self, int lines) -> bool</autodoc>
<docstring>If the platform and window class supports it, scrolls the window by
the given number of lines down, if lines is positive, or up if lines
is negative. Returns True if the window was scrolled, False if it was
</paramlist>
</method>
<method name="ScrollPages" type="bool" overloaded="no">
- <autodoc>ScrollPages(int pages) -> bool</autodoc>
- <docstring>If the platform and window class supports it, scrolls the window by
+ <autodoc>ScrollPages(self, int pages) -> bool</autodoc>
+ <docstring>If the platform and window class supports it, scrolls the window by
the given number of pages down, if pages is positive, or up if pages
is negative. Returns True if the window was scrolled, False if it was
already on top/bottom and nothing was done.</docstring>
</paramlist>
</method>
<method name="LineUp" type="bool" overloaded="no">
- <autodoc>LineUp() -> bool</autodoc>
+ <autodoc>LineUp(self) -> bool</autodoc>
<docstring>This is just a wrapper for ScrollLines(-1).</docstring>
</method>
<method name="LineDown" type="bool" overloaded="no">
- <autodoc>LineDown() -> bool</autodoc>
+ <autodoc>LineDown(self) -> bool</autodoc>
<docstring>This is just a wrapper for ScrollLines(1).</docstring>
</method>
<method name="PageUp" type="bool" overloaded="no">
- <autodoc>PageUp() -> bool</autodoc>
+ <autodoc>PageUp(self) -> bool</autodoc>
<docstring>This is just a wrapper for ScrollPages(-1).</docstring>
</method>
<method name="PageDown" type="bool" overloaded="no">
- <autodoc>PageDown() -> bool</autodoc>
+ <autodoc>PageDown(self) -> bool</autodoc>
<docstring>This is just a wrapper for ScrollPages(1).</docstring>
</method>
<method name="SetHelpText" type="" overloaded="no">
- <autodoc>SetHelpText(String text)</autodoc>
+ <autodoc>SetHelpText(self, String text)</autodoc>
<docstring>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.</docstring>
</paramlist>
</method>
<method name="SetHelpTextForId" type="" overloaded="no">
- <autodoc>SetHelpTextForId(String text)</autodoc>
+ <autodoc>SetHelpTextForId(self, String text)</autodoc>
<docstring>Associate this help text with all windows with the same id as this
one.</docstring>
<paramlist>
</paramlist>
</method>
<method name="GetHelpText" type="String" overloaded="no">
- <autodoc>GetHelpText() -> String</autodoc>
+ <autodoc>GetHelpText(self) -> String</autodoc>
<docstring>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.</docstring>
</method>
<method name="SetToolTipString" type="" overloaded="no">
- <autodoc>SetToolTipString(String tip)</autodoc>
+ <autodoc>SetToolTipString(self, String tip)</autodoc>
<docstring>Attach a tooltip to the window.</docstring>
<paramlist>
<param name="tip" type="String" default=""/>
</paramlist>
</method>
<method name="SetToolTip" type="" overloaded="no">
- <autodoc>SetToolTip(ToolTip tip)</autodoc>
+ <autodoc>SetToolTip(self, ToolTip tip)</autodoc>
<docstring>Attach a tooltip to the window.</docstring>
<paramlist>
<param name="tip" type="wxToolTip" default=""/>
</paramlist>
</method>
<method name="GetToolTip" type="wxToolTip" overloaded="no">
- <autodoc>GetToolTip() -> ToolTip</autodoc>
+ <autodoc>GetToolTip(self) -> ToolTip</autodoc>
<docstring>get the associated tooltip or None if none</docstring>
</method>
<method name="SetDropTarget" type="" overloaded="no">
- <autodoc>SetDropTarget(DropTarget dropTarget)</autodoc>
+ <autodoc>SetDropTarget(self, DropTarget dropTarget)</autodoc>
<docstring>Associates a drop target with this window. If the window already has
a drop target, it is deleted.</docstring>
<paramlist>
</paramlist>
</method>
<method name="GetDropTarget" type="wxPyDropTarget" overloaded="no">
- <autodoc>GetDropTarget() -> DropTarget</autodoc>
+ <autodoc>GetDropTarget(self) -> DropTarget</autodoc>
<docstring>Returns the associated drop target, which may be None.</docstring>
</method>
<method name="SetConstraints" type="" overloaded="no">
- <autodoc>SetConstraints(LayoutConstraints constraints)</autodoc>
+ <autodoc>SetConstraints(self, LayoutConstraints constraints)</autodoc>
<docstring>Sets the window to have the given layout constraints. If an existing
layout constraints object is already owned by the window, it will be
deleted. Pass None to disassociate and delete the window's current
</paramlist>
</method>
<method name="GetConstraints" type="wxLayoutConstraints" overloaded="no">
- <autodoc>GetConstraints() -> LayoutConstraints</autodoc>
+ <autodoc>GetConstraints(self) -> LayoutConstraints</autodoc>
<docstring>Returns a pointer to the window's layout constraints, or None if there
are none.</docstring>
</method>
<method name="SetAutoLayout" type="" overloaded="no">
- <autodoc>SetAutoLayout(bool autoLayout)</autodoc>
+ <autodoc>SetAutoLayout(self, bool autoLayout)</autodoc>
<docstring>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
</paramlist>
</method>
<method name="GetAutoLayout" type="bool" overloaded="no">
- <autodoc>GetAutoLayout() -> bool</autodoc>
+ <autodoc>GetAutoLayout(self) -> bool</autodoc>
<docstring>Returns the current autoLayout setting</docstring>
</method>
<method name="Layout" type="bool" overloaded="no">
- <autodoc>Layout() -> bool</autodoc>
+ <autodoc>Layout(self) -> bool</autodoc>
<docstring>Invokes the constraint-based layout algorithm or the sizer-based
algorithm for this window. See SetAutoLayout: when auto layout is on,
this function gets called automatically by the default EVT_SIZE
handler when the window is resized.</docstring>
</method>
<method name="SetSizer" type="" overloaded="no">
- <autodoc>SetSizer(Sizer sizer, bool deleteOld=True)</autodoc>
+ <autodoc>SetSizer(self, Sizer sizer, bool deleteOld=True)</autodoc>
<docstring>Sets the window to have the given layout sizer. The window will then
own the object, and will take care of its deletion. If an existing
layout sizer object is already owned by the window, it will be deleted
</paramlist>
</method>
<method name="SetSizerAndFit" type="" overloaded="no">
- <autodoc>SetSizerAndFit(Sizer sizer, bool deleteOld=True)</autodoc>
+ <autodoc>SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)</autodoc>
<docstring>The same as SetSizer, except it also sets the size hints for the
window based on the sizer's minimum size.</docstring>
<paramlist>
</paramlist>
</method>
<method name="GetSizer" type="wxSizer" overloaded="no">
- <autodoc>GetSizer() -> Sizer</autodoc>
+ <autodoc>GetSizer(self) -> Sizer</autodoc>
<docstring>Return the sizer associated with the window by a previous call to
SetSizer or None if there isn't one.</docstring>
</method>
<method name="SetContainingSizer" type="" overloaded="no">
- <autodoc>SetContainingSizer(Sizer sizer)</autodoc>
+ <autodoc>SetContainingSizer(self, Sizer sizer)</autodoc>
<docstring>This normally does not need to be called by application code. It is
called internally when a window is added to a sizer, and is used so
the window can remove itself from the sizer when it is destroyed.</docstring>
</paramlist>
</method>
<method name="GetContainingSizer" type="wxSizer" overloaded="no">
- <autodoc>GetContainingSizer() -> Sizer</autodoc>
+ <autodoc>GetContainingSizer(self) -> Sizer</autodoc>
<docstring>Return the sizer that this window is a member of, if any, otherwise None.</docstring>
</method>
+ <method name="InheritAttributes" type="" overloaded="no">
+ <autodoc>InheritAttributes(self)</autodoc>
+ <docstring>This function is (or should be, in case of custom controls) called
+during window creation to intelligently set up the window visual
+attributes, that is the font and the foreground and background
+colours.
+
+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
+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
+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
+parent. However it was also deemed desirable to allow to simply change
+the attributes of all children at once by just changing the font or
+colour of their common parent, hence in this case we do inherit the
+parents attributes.
+</docstring>
+ </method>
+ <method name="ShouldInheritColours" type="bool" overloaded="no">
+ <autodoc>ShouldInheritColours(self) -> bool</autodoc>
+ <docstring>Return true from here to allow the colours of this window to be
+changed by InheritAttributes, returning false forbids inheriting them
+from the parent window.
+
+The base class version returns false, but this method is overridden in
+wxControl where it returns true.</docstring>
+ </method>
</class>
<pythoncode>
def DLG_PNT(win, point_or_x, y=None):
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Validator" oldname="wxValidator" module="core">
+ <class name="Validator" oldname="wxValidator" module="_core">
<baseclass name="EvtHandler"/>
<constructor name="Validator" overloaded="no">
- <autodoc>__init__() -> Validator</autodoc>
+ <autodoc>__init__(self) -> Validator</autodoc>
</constructor>
<method name="Clone" type="Validator" overloaded="no">
- <autodoc>Clone() -> Validator</autodoc>
+ <autodoc>Clone(self) -> Validator</autodoc>
</method>
<method name="Validate" type="bool" overloaded="no">
- <autodoc>Validate(Window parent) -> bool</autodoc>
+ <autodoc>Validate(self, Window parent) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="TransferToWindow" type="bool" overloaded="no">
- <autodoc>TransferToWindow() -> bool</autodoc>
+ <autodoc>TransferToWindow(self) -> bool</autodoc>
</method>
<method name="TransferFromWindow" type="bool" overloaded="no">
- <autodoc>TransferFromWindow() -> bool</autodoc>
+ <autodoc>TransferFromWindow(self) -> bool</autodoc>
</method>
<method name="GetWindow" type="Window" overloaded="no">
- <autodoc>GetWindow() -> Window</autodoc>
+ <autodoc>GetWindow(self) -> Window</autodoc>
</method>
<method name="SetWindow" type="" overloaded="no">
- <autodoc>SetWindow(Window window)</autodoc>
+ <autodoc>SetWindow(self, Window window)</autodoc>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</paramlist>
</staticmethod>
</class>
- <class name="PyValidator" oldname="wxPyValidator" module="core">
+ <class name="PyValidator" oldname="wxPyValidator" module="_core">
<baseclass name="Validator"/>
<constructor name="PyValidator" overloaded="no">
- <autodoc>__init__() -> PyValidator</autodoc>
+ <autodoc>__init__(self) -> PyValidator</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class, int incref=True)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Menu" oldname="wxMenu" module="core">
+ <class name="Menu" oldname="wxMenu" module="_core">
<baseclass name="EvtHandler"/>
<constructor name="Menu" overloaded="no">
- <autodoc>__init__(String title=EmptyString, long style=0) -> Menu</autodoc>
+ <autodoc>__init__(self, String title=EmptyString, long style=0) -> Menu</autodoc>
<paramlist>
<param name="title" type="String" default="wxPyEmptyString"/>
<param name="style" type="long" default="0"/>
</paramlist>
</constructor>
<method name="Append" type="wxMenuItem" overloaded="no">
- <autodoc>Append(int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem</autodoc>
+ <autodoc>Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="AppendSeparator" type="wxMenuItem" overloaded="no">
- <autodoc>AppendSeparator() -> MenuItem</autodoc>
+ <autodoc>AppendSeparator(self) -> MenuItem</autodoc>
</method>
<method name="AppendCheckItem" type="wxMenuItem" overloaded="no">
- <autodoc>AppendCheckItem(int id, String text, String help=EmptyString) -> MenuItem</autodoc>
+ <autodoc>AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="AppendRadioItem" type="wxMenuItem" overloaded="no">
- <autodoc>AppendRadioItem(int id, String text, String help=EmptyString) -> MenuItem</autodoc>
+ <autodoc>AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="AppendMenu" type="wxMenuItem" overloaded="no">
- <autodoc>AppendMenu(int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</autodoc>
+ <autodoc>AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="AppendItem" type="wxMenuItem" overloaded="no">
- <autodoc>AppendItem(MenuItem item) -> MenuItem</autodoc>
+ <autodoc>AppendItem(self, MenuItem item) -> MenuItem</autodoc>
<paramlist>
<param name="item" type="wxMenuItem" default=""/>
</paramlist>
</method>
<method name="Break" type="" overloaded="no">
- <autodoc>Break()</autodoc>
+ <autodoc>Break(self)</autodoc>
</method>
<method name="InsertItem" type="wxMenuItem" overloaded="no">
- <autodoc>InsertItem(size_t pos, MenuItem item) -> MenuItem</autodoc>
+ <autodoc>InsertItem(self, size_t pos, MenuItem item) -> MenuItem</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="item" type="wxMenuItem" default=""/>
</paramlist>
</method>
<method name="Insert" type="wxMenuItem" overloaded="no">
- <autodoc>Insert(size_t pos, int id, String text, String help=EmptyString,
+ <autodoc>Insert(self, size_t pos, int id, String text, String help=EmptyString,
int kind=ITEM_NORMAL) -> MenuItem</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
</paramlist>
</method>
<method name="InsertSeparator" type="wxMenuItem" overloaded="no">
- <autodoc>InsertSeparator(size_t pos) -> MenuItem</autodoc>
+ <autodoc>InsertSeparator(self, size_t pos) -> MenuItem</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
</paramlist>
</method>
<method name="InsertCheckItem" type="wxMenuItem" overloaded="no">
- <autodoc>InsertCheckItem(size_t pos, int id, String text, String help=EmptyString) -> MenuItem</autodoc>
+ <autodoc>InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="InsertRadioItem" type="wxMenuItem" overloaded="no">
- <autodoc>InsertRadioItem(size_t pos, int id, String text, String help=EmptyString) -> MenuItem</autodoc>
+ <autodoc>InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="InsertMenu" type="wxMenuItem" overloaded="no">
- <autodoc>InsertMenu(size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</autodoc>
+ <autodoc>InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="PrependItem" type="wxMenuItem" overloaded="no">
- <autodoc>PrependItem(MenuItem item) -> MenuItem</autodoc>
+ <autodoc>PrependItem(self, MenuItem item) -> MenuItem</autodoc>
<paramlist>
<param name="item" type="wxMenuItem" default=""/>
</paramlist>
</method>
<method name="Prepend" type="wxMenuItem" overloaded="no">
- <autodoc>Prepend(int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem</autodoc>
+ <autodoc>Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="PrependSeparator" type="wxMenuItem" overloaded="no">
- <autodoc>PrependSeparator() -> MenuItem</autodoc>
+ <autodoc>PrependSeparator(self) -> MenuItem</autodoc>
</method>
<method name="PrependCheckItem" type="wxMenuItem" overloaded="no">
- <autodoc>PrependCheckItem(int id, String text, String help=EmptyString) -> MenuItem</autodoc>
+ <autodoc>PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="PrependRadioItem" type="wxMenuItem" overloaded="no">
- <autodoc>PrependRadioItem(int id, String text, String help=EmptyString) -> MenuItem</autodoc>
+ <autodoc>PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="PrependMenu" type="wxMenuItem" overloaded="no">
- <autodoc>PrependMenu(int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</autodoc>
+ <autodoc>PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="Remove" type="wxMenuItem" overloaded="no">
- <autodoc>Remove(int id) -> MenuItem</autodoc>
+ <autodoc>Remove(self, int id) -> MenuItem</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="RemoveItem" type="wxMenuItem" overloaded="no">
- <autodoc>RemoveItem(MenuItem item) -> MenuItem</autodoc>
+ <autodoc>RemoveItem(self, MenuItem item) -> MenuItem</autodoc>
<paramlist>
<param name="item" type="wxMenuItem" default=""/>
</paramlist>
</method>
<method name="Delete" type="bool" overloaded="no">
- <autodoc>Delete(int id) -> bool</autodoc>
+ <autodoc>Delete(self, int id) -> bool</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="DeleteItem" type="bool" overloaded="no">
- <autodoc>DeleteItem(MenuItem item) -> bool</autodoc>
+ <autodoc>DeleteItem(self, MenuItem item) -> bool</autodoc>
<paramlist>
<param name="item" type="wxMenuItem" default=""/>
</paramlist>
</method>
<method name="Destroy" type="" overloaded="no">
- <autodoc>Destroy()</autodoc>
+ <autodoc>Destroy(self)</autodoc>
<docstring>Deletes the C++ object this Python object is a proxy for.</docstring>
</method>
<method name="DestroyId" type="bool" overloaded="no">
- <autodoc>DestroyId(int id) -> bool</autodoc>
+ <autodoc>DestroyId(self, int id) -> bool</autodoc>
<docstring>Deletes the C++ object this Python object is a proxy for.</docstring>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="DestroyItem" type="bool" overloaded="no">
- <autodoc>DestroyItem(MenuItem item) -> bool</autodoc>
+ <autodoc>DestroyItem(self, MenuItem item) -> bool</autodoc>
<docstring>Deletes the C++ object this Python object is a proxy for.</docstring>
<paramlist>
<param name="item" type="wxMenuItem" default=""/>
</paramlist>
</method>
<method name="GetMenuItemCount" type="size_t" overloaded="no">
- <autodoc>GetMenuItemCount() -> size_t</autodoc>
+ <autodoc>GetMenuItemCount(self) -> size_t</autodoc>
</method>
<method name="GetMenuItems" type="PyObject" overloaded="no">
- <autodoc>GetMenuItems() -> PyObject</autodoc>
+ <autodoc>GetMenuItems(self) -> PyObject</autodoc>
</method>
<method name="FindItem" type="int" overloaded="no">
- <autodoc>FindItem(String item) -> int</autodoc>
+ <autodoc>FindItem(self, String item) -> int</autodoc>
<paramlist>
<param name="item" type="String" default=""/>
</paramlist>
</method>
<method name="FindItemById" type="wxMenuItem" overloaded="no">
- <autodoc>FindItemById(int id) -> MenuItem</autodoc>
+ <autodoc>FindItemById(self, int id) -> MenuItem</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="FindItemByPosition" type="wxMenuItem" overloaded="no">
- <autodoc>FindItemByPosition(size_t position) -> MenuItem</autodoc>
+ <autodoc>FindItemByPosition(self, size_t position) -> MenuItem</autodoc>
<paramlist>
<param name="position" type="size_t" default=""/>
</paramlist>
</method>
<method name="Enable" type="" overloaded="no">
- <autodoc>Enable(int id, bool enable)</autodoc>
+ <autodoc>Enable(self, int id, bool enable)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="enable" type="bool" default=""/>
</paramlist>
</method>
<method name="IsEnabled" type="bool" overloaded="no">
- <autodoc>IsEnabled(int id) -> bool</autodoc>
+ <autodoc>IsEnabled(self, int id) -> bool</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="Check" type="" overloaded="no">
- <autodoc>Check(int id, bool check)</autodoc>
+ <autodoc>Check(self, int id, bool check)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="check" type="bool" default=""/>
</paramlist>
</method>
<method name="IsChecked" type="bool" overloaded="no">
- <autodoc>IsChecked(int id) -> bool</autodoc>
+ <autodoc>IsChecked(self, int id) -> bool</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="SetLabel" type="" overloaded="no">
- <autodoc>SetLabel(int id, String label)</autodoc>
+ <autodoc>SetLabel(self, int id, String label)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="label" type="String" default=""/>
</paramlist>
</method>
<method name="GetLabel" type="String" overloaded="no">
- <autodoc>GetLabel(int id) -> String</autodoc>
+ <autodoc>GetLabel(self, int id) -> String</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="SetHelpString" type="" overloaded="no">
- <autodoc>SetHelpString(int id, String helpString)</autodoc>
+ <autodoc>SetHelpString(self, int id, String helpString)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="helpString" type="String" default=""/>
</paramlist>
</method>
<method name="GetHelpString" type="String" overloaded="no">
- <autodoc>GetHelpString(int id) -> String</autodoc>
+ <autodoc>GetHelpString(self, int id) -> String</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="SetTitle" type="" overloaded="no">
- <autodoc>SetTitle(String title)</autodoc>
+ <autodoc>SetTitle(self, String title)</autodoc>
<paramlist>
<param name="title" type="String" default=""/>
</paramlist>
</method>
<method name="GetTitle" type="String" overloaded="no">
- <autodoc>GetTitle() -> String</autodoc>
+ <autodoc>GetTitle(self) -> String</autodoc>
</method>
<method name="SetEventHandler" type="" overloaded="no">
- <autodoc>SetEventHandler(EvtHandler handler)</autodoc>
+ <autodoc>SetEventHandler(self, EvtHandler handler)</autodoc>
<paramlist>
<param name="handler" type="EvtHandler" default=""/>
</paramlist>
</method>
<method name="GetEventHandler" type="EvtHandler" overloaded="no">
- <autodoc>GetEventHandler() -> EvtHandler</autodoc>
+ <autodoc>GetEventHandler(self) -> EvtHandler</autodoc>
</method>
<method name="SetInvokingWindow" type="" overloaded="no">
- <autodoc>SetInvokingWindow(Window win)</autodoc>
+ <autodoc>SetInvokingWindow(self, Window win)</autodoc>
<paramlist>
<param name="win" type="Window" default=""/>
</paramlist>
</method>
<method name="GetInvokingWindow" type="Window" overloaded="no">
- <autodoc>GetInvokingWindow() -> Window</autodoc>
+ <autodoc>GetInvokingWindow(self) -> Window</autodoc>
</method>
<method name="GetStyle" type="long" overloaded="no">
- <autodoc>GetStyle() -> long</autodoc>
+ <autodoc>GetStyle(self) -> long</autodoc>
</method>
<method name="UpdateUI" type="" overloaded="no">
- <autodoc>UpdateUI(EvtHandler source=None)</autodoc>
+ <autodoc>UpdateUI(self, EvtHandler source=None)</autodoc>
<paramlist>
<param name="source" type="EvtHandler" default="NULL"/>
</paramlist>
</method>
<method name="GetMenuBar" type="wxMenuBar" overloaded="no">
- <autodoc>GetMenuBar() -> MenuBar</autodoc>
+ <autodoc>GetMenuBar(self) -> MenuBar</autodoc>
</method>
<method name="Attach" type="" overloaded="no">
- <autodoc>Attach(wxMenuBarBase menubar)</autodoc>
+ <autodoc>Attach(self, wxMenuBarBase menubar)</autodoc>
<paramlist>
<param name="menubar" type="wxMenuBarBase" default=""/>
</paramlist>
</method>
<method name="Detach" type="" overloaded="no">
- <autodoc>Detach()</autodoc>
+ <autodoc>Detach(self)</autodoc>
</method>
<method name="IsAttached" type="bool" overloaded="no">
- <autodoc>IsAttached() -> bool</autodoc>
+ <autodoc>IsAttached(self) -> bool</autodoc>
</method>
<method name="SetParent" type="" overloaded="no">
- <autodoc>SetParent(Menu parent)</autodoc>
+ <autodoc>SetParent(self, Menu parent)</autodoc>
<paramlist>
<param name="parent" type="Menu" default=""/>
</paramlist>
</method>
<method name="GetParent" type="Menu" overloaded="no">
- <autodoc>GetParent() -> Menu</autodoc>
+ <autodoc>GetParent(self) -> Menu</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MenuBar" oldname="wxMenuBar" module="core">
+ <class name="MenuBar" oldname="wxMenuBar" module="_core">
<baseclass name="Window"/>
<constructor name="MenuBar" overloaded="no">
- <autodoc>__init__(long style=0) -> MenuBar</autodoc>
+ <autodoc>__init__(self, long style=0) -> MenuBar</autodoc>
<paramlist>
<param name="style" type="long" default="0"/>
</paramlist>
</constructor>
<method name="Append" type="bool" overloaded="no">
- <autodoc>Append(Menu menu, String title) -> bool</autodoc>
+ <autodoc>Append(self, Menu menu, String title) -> bool</autodoc>
<paramlist>
<param name="menu" type="Menu" default=""/>
<param name="title" type="String" default=""/>
</paramlist>
</method>
<method name="Insert" type="bool" overloaded="no">
- <autodoc>Insert(size_t pos, Menu menu, String title) -> bool</autodoc>
+ <autodoc>Insert(self, size_t pos, Menu menu, String title) -> bool</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="menu" type="Menu" default=""/>
</paramlist>
</method>
<method name="GetMenuCount" type="size_t" overloaded="no">
- <autodoc>GetMenuCount() -> size_t</autodoc>
+ <autodoc>GetMenuCount(self) -> size_t</autodoc>
</method>
<method name="GetMenu" type="Menu" overloaded="no">
- <autodoc>GetMenu(size_t pos) -> Menu</autodoc>
+ <autodoc>GetMenu(self, size_t pos) -> Menu</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
</paramlist>
</method>
<method name="Replace" type="Menu" overloaded="no">
- <autodoc>Replace(size_t pos, Menu menu, String title) -> Menu</autodoc>
+ <autodoc>Replace(self, size_t pos, Menu menu, String title) -> Menu</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="menu" type="Menu" default=""/>
</paramlist>
</method>
<method name="Remove" type="Menu" overloaded="no">
- <autodoc>Remove(size_t pos) -> Menu</autodoc>
+ <autodoc>Remove(self, size_t pos) -> Menu</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
</paramlist>
</method>
<method name="EnableTop" type="" overloaded="no">
- <autodoc>EnableTop(size_t pos, bool enable)</autodoc>
+ <autodoc>EnableTop(self, size_t pos, bool enable)</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="enable" type="bool" default=""/>
</paramlist>
</method>
<method name="IsEnabledTop" type="bool" overloaded="no">
- <autodoc>IsEnabledTop(size_t pos) -> bool</autodoc>
+ <autodoc>IsEnabledTop(self, size_t pos) -> bool</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetLabelTop" type="" overloaded="no">
- <autodoc>SetLabelTop(size_t pos, String label)</autodoc>
+ <autodoc>SetLabelTop(self, size_t pos, String label)</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="label" type="String" default=""/>
</paramlist>
</method>
<method name="GetLabelTop" type="String" overloaded="no">
- <autodoc>GetLabelTop(size_t pos) -> String</autodoc>
+ <autodoc>GetLabelTop(self, size_t pos) -> String</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
</paramlist>
</method>
<method name="FindMenuItem" type="int" overloaded="no">
- <autodoc>FindMenuItem(String menu, String item) -> int</autodoc>
+ <autodoc>FindMenuItem(self, String menu, String item) -> int</autodoc>
<paramlist>
<param name="menu" type="String" default=""/>
<param name="item" type="String" default=""/>
</paramlist>
</method>
<method name="FindItemById" type="wxMenuItem" overloaded="no">
- <autodoc>FindItemById(int id) -> MenuItem</autodoc>
+ <autodoc>FindItemById(self, int id) -> MenuItem</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="FindMenu" type="int" overloaded="no">
- <autodoc>FindMenu(String title) -> int</autodoc>
+ <autodoc>FindMenu(self, String title) -> int</autodoc>
<paramlist>
<param name="title" type="String" default=""/>
</paramlist>
</method>
<method name="Enable" type="" overloaded="no">
- <autodoc>Enable(int id, bool enable)</autodoc>
+ <autodoc>Enable(self, int id, bool enable)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="enable" type="bool" default=""/>
</paramlist>
</method>
<method name="Check" type="" overloaded="no">
- <autodoc>Check(int id, bool check)</autodoc>
+ <autodoc>Check(self, int id, bool check)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="check" type="bool" default=""/>
</paramlist>
</method>
<method name="IsChecked" type="bool" overloaded="no">
- <autodoc>IsChecked(int id) -> bool</autodoc>
+ <autodoc>IsChecked(self, int id) -> bool</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="IsEnabled" type="bool" overloaded="no">
- <autodoc>IsEnabled(int id) -> bool</autodoc>
+ <autodoc>IsEnabled(self, int id) -> bool</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="SetLabel" type="" overloaded="no">
- <autodoc>SetLabel(int id, String label)</autodoc>
+ <autodoc>SetLabel(self, int id, String label)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="label" type="String" default=""/>
</paramlist>
</method>
<method name="GetLabel" type="String" overloaded="no">
- <autodoc>GetLabel(int id) -> String</autodoc>
+ <autodoc>GetLabel(self, int id) -> String</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="SetHelpString" type="" overloaded="no">
- <autodoc>SetHelpString(int id, String helpString)</autodoc>
+ <autodoc>SetHelpString(self, int id, String helpString)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="helpString" type="String" default=""/>
</paramlist>
</method>
<method name="GetHelpString" type="String" overloaded="no">
- <autodoc>GetHelpString(int id) -> String</autodoc>
+ <autodoc>GetHelpString(self, int id) -> String</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="GetFrame" type="wxFrame" overloaded="no">
- <autodoc>GetFrame() -> wxFrame</autodoc>
+ <autodoc>GetFrame(self) -> wxFrame</autodoc>
</method>
<method name="IsAttached" type="bool" overloaded="no">
- <autodoc>IsAttached() -> bool</autodoc>
+ <autodoc>IsAttached(self) -> bool</autodoc>
</method>
<method name="Attach" type="" overloaded="no">
- <autodoc>Attach(wxFrame frame)</autodoc>
+ <autodoc>Attach(self, wxFrame frame)</autodoc>
<paramlist>
<param name="frame" type="wxFrame" default=""/>
</paramlist>
</method>
<method name="Detach" type="" overloaded="no">
- <autodoc>Detach()</autodoc>
+ <autodoc>Detach(self)</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MenuItem" oldname="wxMenuItem" module="core">
+ <class name="MenuItem" oldname="wxMenuItem" module="_core">
<baseclass name="Object"/>
<constructor name="MenuItem" overloaded="no">
- <autodoc>__init__(Menu parentMenu=None, int id=ID_SEPARATOR, String text=EmptyString,
+ <autodoc>__init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
String help=EmptyString, int kind=ITEM_NORMAL,
Menu subMenu=None) -> MenuItem</autodoc>
<paramlist>
<param name="parentMenu" type="Menu" default="NULL"/>
- <param name="id" type="int" default="wxID_SEPARATOR"/>
+ <param name="id" type="int" default="wxID_ANY"/>
<param name="text" type="String" default="wxPyEmptyString"/>
<param name="help" type="String" default="wxPyEmptyString"/>
<param name="kind" type="wxItemKind" default="wxITEM_NORMAL"/>
</paramlist>
</constructor>
<method name="GetMenu" type="Menu" overloaded="no">
- <autodoc>GetMenu() -> Menu</autodoc>
+ <autodoc>GetMenu(self) -> Menu</autodoc>
</method>
<method name="SetMenu" type="" overloaded="no">
- <autodoc>SetMenu(Menu menu)</autodoc>
+ <autodoc>SetMenu(self, Menu menu)</autodoc>
<paramlist>
<param name="menu" type="Menu" default=""/>
</paramlist>
</method>
<method name="SetId" type="" overloaded="no">
- <autodoc>SetId(int id)</autodoc>
+ <autodoc>SetId(self, int id)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="GetId" type="int" overloaded="no">
- <autodoc>GetId() -> int</autodoc>
+ <autodoc>GetId(self) -> int</autodoc>
</method>
<method name="IsSeparator" type="bool" overloaded="no">
- <autodoc>IsSeparator() -> bool</autodoc>
+ <autodoc>IsSeparator(self) -> bool</autodoc>
</method>
<method name="SetText" type="" overloaded="no">
- <autodoc>SetText(String str)</autodoc>
+ <autodoc>SetText(self, String str)</autodoc>
<paramlist>
<param name="str" type="String" default=""/>
</paramlist>
</method>
<method name="GetLabel" type="String" overloaded="no">
- <autodoc>GetLabel() -> String</autodoc>
+ <autodoc>GetLabel(self) -> String</autodoc>
</method>
<method name="GetText" type="String" overloaded="no">
- <autodoc>GetText() -> String</autodoc>
+ <autodoc>GetText(self) -> String</autodoc>
</method>
<staticmethod name="GetLabelFromText" type="String" overloaded="no">
<autodoc>GetLabelFromText(String text) -> String</autodoc>
</paramlist>
</staticmethod>
<method name="GetKind" type="wxItemKind" overloaded="no">
- <autodoc>GetKind() -> int</autodoc>
+ <autodoc>GetKind(self) -> int</autodoc>
+ </method>
+ <method name="SetKind" type="" overloaded="no">
+ <autodoc>SetKind(self, int kind)</autodoc>
+ <paramlist>
+ <param name="kind" type="wxItemKind" default=""/>
+ </paramlist>
</method>
<method name="SetCheckable" type="" overloaded="no">
- <autodoc>SetCheckable(bool checkable)</autodoc>
+ <autodoc>SetCheckable(self, bool checkable)</autodoc>
<paramlist>
<param name="checkable" type="bool" default=""/>
</paramlist>
</method>
<method name="IsCheckable" type="bool" overloaded="no">
- <autodoc>IsCheckable() -> bool</autodoc>
+ <autodoc>IsCheckable(self) -> bool</autodoc>
</method>
<method name="IsSubMenu" type="bool" overloaded="no">
- <autodoc>IsSubMenu() -> bool</autodoc>
+ <autodoc>IsSubMenu(self) -> bool</autodoc>
</method>
<method name="SetSubMenu" type="" overloaded="no">
- <autodoc>SetSubMenu(Menu menu)</autodoc>
+ <autodoc>SetSubMenu(self, Menu menu)</autodoc>
<paramlist>
<param name="menu" type="Menu" default=""/>
</paramlist>
</method>
<method name="GetSubMenu" type="Menu" overloaded="no">
- <autodoc>GetSubMenu() -> Menu</autodoc>
+ <autodoc>GetSubMenu(self) -> Menu</autodoc>
</method>
<method name="Enable" type="" overloaded="no">
- <autodoc>Enable(bool enable=True)</autodoc>
+ <autodoc>Enable(self, bool enable=True)</autodoc>
<paramlist>
<param name="enable" type="bool" default="True"/>
</paramlist>
</method>
<method name="IsEnabled" type="bool" overloaded="no">
- <autodoc>IsEnabled() -> bool</autodoc>
+ <autodoc>IsEnabled(self) -> bool</autodoc>
</method>
<method name="Check" type="" overloaded="no">
- <autodoc>Check(bool check=True)</autodoc>
+ <autodoc>Check(self, bool check=True)</autodoc>
<paramlist>
<param name="check" type="bool" default="True"/>
</paramlist>
</method>
<method name="IsChecked" type="bool" overloaded="no">
- <autodoc>IsChecked() -> bool</autodoc>
+ <autodoc>IsChecked(self) -> bool</autodoc>
</method>
<method name="Toggle" type="" overloaded="no">
- <autodoc>Toggle()</autodoc>
+ <autodoc>Toggle(self)</autodoc>
</method>
<method name="SetHelp" type="" overloaded="no">
- <autodoc>SetHelp(String str)</autodoc>
+ <autodoc>SetHelp(self, String str)</autodoc>
<paramlist>
<param name="str" type="String" default=""/>
</paramlist>
</method>
<method name="GetHelp" type="String" overloaded="no">
- <autodoc>GetHelp() -> String</autodoc>
+ <autodoc>GetHelp(self) -> String</autodoc>
</method>
<method name="GetAccel" type="AcceleratorEntry" overloaded="no">
- <autodoc>GetAccel() -> AcceleratorEntry</autodoc>
+ <autodoc>GetAccel(self) -> AcceleratorEntry</autodoc>
</method>
<method name="SetAccel" type="" overloaded="no">
- <autodoc>SetAccel(AcceleratorEntry accel)</autodoc>
+ <autodoc>SetAccel(self, AcceleratorEntry accel)</autodoc>
<paramlist>
<param name="accel" type="AcceleratorEntry" default=""/>
</paramlist>
<autodoc>GetDefaultMarginWidth() -> int</autodoc>
</staticmethod>
<method name="SetBitmap" type="" overloaded="no">
- <autodoc>SetBitmap(Bitmap bitmap)</autodoc>
+ <autodoc>SetBitmap(self, Bitmap bitmap)</autodoc>
<paramlist>
<param name="bitmap" type="wxBitmap" default=""/>
</paramlist>
</method>
<method name="GetBitmap" type="wxBitmap" overloaded="no">
- <autodoc>GetBitmap() -> Bitmap</autodoc>
+ <autodoc>GetBitmap(self) -> Bitmap</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Control" oldname="wxControl" module="core">
+ <class name="Control" oldname="wxControl" module="_core">
<docstring>This is the base class for a control or 'widget'.
-A control is generally a small window which processes user input and/or
-displays one or more item of data.</docstring>
+A control is generally a small window which processes user input
+and/or displays one or more item of data.</docstring>
<baseclass name="Window"/>
<constructor name="Control" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, Validator validator=DefaultValidator,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
String name=ControlNameStr) -> Control</autodoc>
- <docstring>Create a Control. Normally you should only call this from a
-subclass' __init__ as a plain old wx.Control is not very useful.</docstring>
+ <docstring>Create a Control. Normally you should only call this from a subclass'
+__init__ as a plain old wx.Control is not very useful.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<docstring>Precreate a Control control for 2-phase creation</docstring>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, Validator validator=DefaultValidator,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
String name=ControlNameStr) -> bool</autodoc>
<docstring>Do the 2nd phase and create the GUI control.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
</paramlist>
</method>
<method name="Command" type="" overloaded="no">
- <autodoc>Command(CommandEvent event)</autodoc>
- <docstring>Simulates the effect of the user issuing a command to the
-item. See wxCommandEvent.</docstring>
+ <autodoc>Command(self, CommandEvent event)</autodoc>
+ <docstring>Simulates the effect of the user issuing a command to the item.
+
+:see: `wx.CommandEvent`
+</docstring>
<paramlist>
<param name="event" type="CommandEvent" default=""/>
</paramlist>
</method>
<method name="GetLabel" type="String" overloaded="no">
- <autodoc>GetLabel() -> String</autodoc>
+ <autodoc>GetLabel(self) -> String</autodoc>
<docstring>Return a control's text.</docstring>
</method>
<method name="SetLabel" type="" overloaded="no">
- <autodoc>SetLabel(String label)</autodoc>
+ <autodoc>SetLabel(self, String label)</autodoc>
<docstring>Sets the item's text.</docstring>
<paramlist>
<param name="label" type="String" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ItemContainer" oldname="wxItemContainer" module="core">
+ <class name="ItemContainer" oldname="wxItemContainer" module="_core">
<docstring>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 and
-wx.ComboBox (which implements an extended interface deriving from
-this one)
+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 each of the derived classes implements them differently,
-they still all conform to the same interface.
+It defines the methods for accessing the control's items and although
+each of the derived classes implements them differently, they still
+all conform to the same interface.
-The items in a wx.ItemContainer have (non empty) string labels
-and, optionally, client data associated with them.
+The items in a wx.ItemContainer have (non empty) string labels and,
+optionally, client data associated with them.
</docstring>
<method name="Append" type="int" overloaded="no">
- <autodoc>Append(String item, PyObject clientData=None) -> int</autodoc>
- <docstring>Adds the item to the control, associating the given data with the
-item if not None. The return value is the index of the newly
-added item which may be different from the last one if the
-control is sorted (e.g. has wx.LB_SORT or wx.CB_SORT style).</docstring>
+ <autodoc>Append(self, String item, PyObject clientData=None) -> int</autodoc>
+ <docstring>Adds the item to the control, associating the given data with the item
+if not None. The return value is the index of the newly added item
+which may be different from the last one if the control is sorted (e.g.
+has wx.LB_SORT or wx.CB_SORT style).</docstring>
<paramlist>
<param name="item" type="String" default=""/>
<param name="clientData" type="PyObject" default="NULL"/>
</paramlist>
</method>
<method name="AppendItems" type="" overloaded="no">
- <autodoc>AppendItems(wxArrayString strings)</autodoc>
- <docstring>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 need to add a lot of items.</docstring>
+ <autodoc>AppendItems(self, wxArrayString strings)</autodoc>
+ <docstring>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
+need to add a lot of items.</docstring>
<paramlist>
<param name="strings" type="wxArrayString" default=""/>
</paramlist>
</method>
<method name="Insert" type="int" overloaded="no">
- <autodoc>Insert(String item, int pos, PyObject clientData=None) -> int</autodoc>
- <docstring>Insert an item into the control before the item at the pos index,
+ <autodoc>Insert(self, String item, int pos, PyObject clientData=None) -> int</autodoc>
+ <docstring>Insert an item into the control before the item at the ``pos`` index,
optionally associating some data object with the item.</docstring>
<paramlist>
<param name="item" type="String" default=""/>
</paramlist>
</method>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear()</autodoc>
+ <autodoc>Clear(self)</autodoc>
<docstring>Removes all items from the control.</docstring>
</method>
<method name="Delete" type="" overloaded="no">
- <autodoc>Delete(int n)</autodoc>
- <docstring>Deletes the item at the zero-based index 'n' from the control.
-Note that it is an error (signalled by a PyAssertionError
-exception if enabled) to remove an item with the index negative
-or greater or equal than the number of items in the control.</docstring>
+ <autodoc>Delete(self, int n)</autodoc>
+ <docstring>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
+enabled) to remove an item with the index negative or greater or equal
+than the number of items in the control.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetCount" type="int" overloaded="no">
- <autodoc>GetCount() -> int</autodoc>
+ <autodoc>GetCount(self) -> int</autodoc>
<docstring>Returns the number of items in the control.</docstring>
</method>
<method name="IsEmpty" type="bool" overloaded="no">
- <autodoc>IsEmpty() -> bool</autodoc>
+ <autodoc>IsEmpty(self) -> bool</autodoc>
<docstring>Returns True if the control is empty or False if it has some items.</docstring>
</method>
<method name="GetString" type="String" overloaded="no">
- <autodoc>GetString(int n) -> String</autodoc>
+ <autodoc>GetString(self, int n) -> String</autodoc>
<docstring>Returns the label of the item with the given index.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetStrings" type="wxArrayString" overloaded="no">
- <autodoc>GetStrings() -> wxArrayString</autodoc>
+ <autodoc>GetStrings(self) -> wxArrayString</autodoc>
</method>
<method name="SetString" type="" overloaded="no">
- <autodoc>SetString(int n, String s)</autodoc>
+ <autodoc>SetString(self, int n, String s)</autodoc>
<docstring>Sets the label for the given item.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="FindString" type="int" overloaded="no">
- <autodoc>FindString(String s) -> int</autodoc>
+ <autodoc>FindString(self, String s) -> int</autodoc>
<docstring>Finds an item whose label matches the given string. Returns the
-zero-based position of the item, or wx.NOT_FOUND if the string
-was not found.</docstring>
+zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
+found.</docstring>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="Select" type="" overloaded="no">
- <autodoc>Select(int n)</autodoc>
+ <autodoc>Select(self, int n)</autodoc>
<docstring>Sets the item at index 'n' to be the selected item.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetSelection" type="int" overloaded="no">
- <autodoc>GetSelection() -> int</autodoc>
- <docstring>Returns the index of the selected item or wx.NOT_FOUND if no item is selected.</docstring>
+ <autodoc>GetSelection(self) -> int</autodoc>
+ <docstring>Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
+is selected.</docstring>
</method>
<method name="GetStringSelection" type="String" overloaded="no">
- <autodoc>GetStringSelection() -> String</autodoc>
- <docstring>Returns the label of the selected item or an empty string if no item is selected.</docstring>
+ <autodoc>GetStringSelection(self) -> String</autodoc>
+ <docstring>Returns the label of the selected item or an empty string if no item
+is selected.</docstring>
</method>
<method name="GetClientData" type="PyObject" overloaded="no">
- <autodoc>GetClientData(int n) -> PyObject</autodoc>
+ <autodoc>GetClientData(self, int n) -> PyObject</autodoc>
<docstring>Returns the client data associated with the given item, (if any.)</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetClientData" type="" overloaded="no">
- <autodoc>SetClientData(int n, PyObject clientData)</autodoc>
+ <autodoc>SetClientData(self, int n, PyObject clientData)</autodoc>
<docstring>Associate the given client data with the item at position n.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ControlWithItems" oldname="wxControlWithItems" module="core">
- <docstring>wx.ControlWithItems combines the wx.ItemContainer class with the
-wx.Control class, and is used for the base class of various
-controls that have items.</docstring>
+ <class name="ControlWithItems" oldname="wxControlWithItems" module="_core">
+ <docstring>wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
+wx.Control class, and is used for the base class of various controls
+that have items.</docstring>
<baseclass name="Control"/>
<baseclass name="ItemContainer"/>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="SizerItem" oldname="wxSizerItem" module="core">
+ <class name="SizerItem" oldname="wxSizerItem" module="_core">
+ <docstring>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`</docstring>
<baseclass name="Object"/>
<constructor name="SizerItem" overloaded="no">
- <autodoc>__init__() -> SizerItem</autodoc>
+ <autodoc>__init__(self) -> SizerItem</autodoc>
+ <docstring>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`</docstring>
</constructor>
- <constructor name="SizerItemSpacer" overloaded="no">
- <autodoc>SizerItemSpacer(int width, int height, int proportion, int flag, int border,
- Object userData) -> SizerItem</autodoc>
+ <constructor name="SizerItemWindow" overloaded="no">
+ <autodoc>SizerItemWindow(Window window, int proportion, int flag, int border,
+ PyObject userData=None) -> SizerItem</autodoc>
+ <docstring>Constructs a `wx.SizerItem` for tracking a window.</docstring>
<paramlist>
- <param name="width" type="int" default=""/>
- <param name="height" type="int" default=""/>
+ <param name="window" type="Window" default=""/>
<param name="proportion" type="int" default=""/>
<param name="flag" type="int" default=""/>
<param name="border" type="int" default=""/>
- <param name="userData" type="Object" default=""/>
+ <param name="userData" type="PyObject" default="NULL"/>
</paramlist>
</constructor>
- <constructor name="SizerItemWindow" overloaded="no">
- <autodoc>SizerItemWindow(Window window, int proportion, int flag, int border,
- Object userData) -> SizerItem</autodoc>
+ <constructor name="SizerItemSpacer" overloaded="no">
+ <autodoc>SizerItemSpacer(int width, int height, int proportion, int flag, int border,
+ PyObject userData=None) -> SizerItem</autodoc>
+ <docstring>Constructs a `wx.SizerItem` for tracking a spacer.</docstring>
<paramlist>
- <param name="window" type="Window" default=""/>
+ <param name="width" type="int" default=""/>
+ <param name="height" type="int" default=""/>
<param name="proportion" type="int" default=""/>
<param name="flag" type="int" default=""/>
<param name="border" type="int" default=""/>
- <param name="userData" type="Object" default=""/>
+ <param name="userData" type="PyObject" default="NULL"/>
</paramlist>
</constructor>
<constructor name="SizerItemSizer" overloaded="no">
<autodoc>SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
- Object userData) -> SizerItem</autodoc>
+ PyObject userData=None) -> SizerItem</autodoc>
+ <docstring>Constructs a `wx.SizerItem` for tracking a subsizer</docstring>
<paramlist>
<param name="sizer" type="wxSizer" default=""/>
<param name="proportion" type="int" default=""/>
<param name="flag" type="int" default=""/>
<param name="border" type="int" default=""/>
- <param name="userData" type="Object" default=""/>
+ <param name="userData" type="PyObject" default="NULL"/>
</paramlist>
</constructor>
<method name="DeleteWindows" type="" overloaded="no">
- <autodoc>DeleteWindows()</autodoc>
+ <autodoc>DeleteWindows(self)</autodoc>
+ <docstring>Destroy the window or the windows in a subsizer, depending on the type
+of item.</docstring>
</method>
<method name="DetachSizer" type="" overloaded="no">
- <autodoc>DetachSizer()</autodoc>
+ <autodoc>DetachSizer(self)</autodoc>
+ <docstring>Enable deleting the SizerItem without destroying the contained sizer.</docstring>
</method>
<method name="GetSize" type="Size" overloaded="no">
- <autodoc>GetSize() -> Size</autodoc>
+ <autodoc>GetSize(self) -> Size</autodoc>
+ <docstring>Get the current size of the item, as set in the last Layout.</docstring>
</method>
<method name="CalcMin" type="Size" overloaded="no">
- <autodoc>CalcMin() -> Size</autodoc>
+ <autodoc>CalcMin(self) -> Size</autodoc>
+ <docstring>Calculates the minimum desired size for the item, including any space
+needed by borders.</docstring>
</method>
<method name="SetDimension" type="" overloaded="no">
- <autodoc>SetDimension(Point pos, Size size)</autodoc>
+ <autodoc>SetDimension(self, Point pos, Size size)</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="pos" type="Point" default=""/>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="GetMinSize" type="Size" overloaded="no">
- <autodoc>GetMinSize() -> Size</autodoc>
+ <autodoc>GetMinSize(self) -> Size</autodoc>
+ <docstring>Get the minimum size needed for the item.</docstring>
</method>
<method name="SetInitSize" type="" overloaded="no">
- <autodoc>SetInitSize(int x, int y)</autodoc>
+ <autodoc>SetInitSize(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="SetRatioWH" type="" overloaded="no">
- <autodoc>SetRatioWH(int width, int height)</autodoc>
+ <autodoc>SetRatioWH(self, int width, int height)</autodoc>
+ <docstring>Set the ratio item attribute.</docstring>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="SetRatioSize" type="" overloaded="no">
- <autodoc>SetRatioSize(Size size)</autodoc>
+ <autodoc>SetRatioSize(self, Size size)</autodoc>
+ <docstring>Set the ratio item attribute.</docstring>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="SetRatio" type="" overloaded="no">
- <autodoc>SetRatio(float ratio)</autodoc>
+ <autodoc>SetRatio(self, float ratio)</autodoc>
+ <docstring>Set the ratio item attribute.</docstring>
<paramlist>
<param name="ratio" type="float" default=""/>
</paramlist>
</method>
<method name="GetRatio" type="float" overloaded="no">
- <autodoc>GetRatio() -> float</autodoc>
+ <autodoc>GetRatio(self) -> float</autodoc>
+ <docstring>Set the ratio item attribute.</docstring>
</method>
<method name="IsWindow" type="bool" overloaded="no">
- <autodoc>IsWindow() -> bool</autodoc>
+ <autodoc>IsWindow(self) -> bool</autodoc>
+ <docstring>Is this sizer item a window?</docstring>
</method>
<method name="IsSizer" type="bool" overloaded="no">
- <autodoc>IsSizer() -> bool</autodoc>
+ <autodoc>IsSizer(self) -> bool</autodoc>
+ <docstring>Is this sizer item a subsizer?</docstring>
</method>
<method name="IsSpacer" type="bool" overloaded="no">
- <autodoc>IsSpacer() -> bool</autodoc>
+ <autodoc>IsSpacer(self) -> bool</autodoc>
+ <docstring>Is this sizer item a spacer?</docstring>
</method>
<method name="SetProportion" type="" overloaded="no">
- <autodoc>SetProportion(int proportion)</autodoc>
+ <autodoc>SetProportion(self, int proportion)</autodoc>
+ <docstring>Set the proportion value for this item.</docstring>
<paramlist>
<param name="proportion" type="int" default=""/>
</paramlist>
</method>
<method name="GetProportion" type="int" overloaded="no">
- <autodoc>GetProportion() -> int</autodoc>
+ <autodoc>GetProportion(self) -> int</autodoc>
+ <docstring>Get the proportion value for this item.</docstring>
</method>
<method name="SetFlag" type="" overloaded="no">
- <autodoc>SetFlag(int flag)</autodoc>
+ <autodoc>SetFlag(self, int flag)</autodoc>
+ <docstring>Set the flag value for this item.</docstring>
<paramlist>
<param name="flag" type="int" default=""/>
</paramlist>
</method>
<method name="GetFlag" type="int" overloaded="no">
- <autodoc>GetFlag() -> int</autodoc>
+ <autodoc>GetFlag(self) -> int</autodoc>
+ <docstring>Get the flag value for this item.</docstring>
</method>
<method name="SetBorder" type="" overloaded="no">
- <autodoc>SetBorder(int border)</autodoc>
+ <autodoc>SetBorder(self, int border)</autodoc>
+ <docstring>Set the border value for this item.</docstring>
<paramlist>
<param name="border" type="int" default=""/>
</paramlist>
</method>
<method name="GetBorder" type="int" overloaded="no">
- <autodoc>GetBorder() -> int</autodoc>
+ <autodoc>GetBorder(self) -> int</autodoc>
+ <docstring>Get the border value for this item.</docstring>
</method>
<method name="GetWindow" type="Window" overloaded="no">
- <autodoc>GetWindow() -> Window</autodoc>
+ <autodoc>GetWindow(self) -> Window</autodoc>
+ <docstring>Get the window (if any) that is managed by this sizer item.</docstring>
</method>
<method name="SetWindow" type="" overloaded="no">
- <autodoc>SetWindow(Window window)</autodoc>
+ <autodoc>SetWindow(self, Window window)</autodoc>
+ <docstring>Set the window to be managed by this sizer item.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="GetSizer" type="wxSizer" overloaded="no">
- <autodoc>GetSizer() -> Sizer</autodoc>
+ <autodoc>GetSizer(self) -> Sizer</autodoc>
+ <docstring>Get the subsizer (if any) that is managed by this sizer item.</docstring>
</method>
<method name="SetSizer" type="" overloaded="no">
- <autodoc>SetSizer(Sizer sizer)</autodoc>
+ <autodoc>SetSizer(self, Sizer sizer)</autodoc>
+ <docstring>Set the subsizer to be managed by this sizer item.</docstring>
<paramlist>
<param name="sizer" type="wxSizer" default=""/>
</paramlist>
</method>
<method name="GetSpacer" type="Size" overloaded="no">
- <autodoc>GetSpacer() -> Size</autodoc>
+ <autodoc>GetSpacer(self) -> Size</autodoc>
+ <docstring>Get the size of the spacer managed by this sizer item.</docstring>
</method>
<method name="SetSpacer" type="" overloaded="no">
- <autodoc>SetSpacer(Size size)</autodoc>
+ <autodoc>SetSpacer(self, Size size)</autodoc>
+ <docstring>Set the size of the spacer to be managed by this sizer item.</docstring>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="Show" type="" overloaded="no">
- <autodoc>Show(bool show)</autodoc>
+ <autodoc>Show(self, bool show)</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="show" type="bool" default=""/>
</paramlist>
</method>
<method name="IsShown" type="bool" overloaded="no">
- <autodoc>IsShown() -> bool</autodoc>
+ <autodoc>IsShown(self) -> bool</autodoc>
+ <docstring>Is the item to be shown in the layout?</docstring>
</method>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
+ <docstring>Returns the current position of the item, as set in the last Layout.</docstring>
</method>
<method name="GetUserData" type="PyObject" overloaded="no">
- <autodoc>GetUserData() -> PyObject</autodoc>
- </method>
- </class>
- <class name="Sizer" oldname="wxSizer" module="core">
+ <autodoc>GetUserData(self) -> PyObject</autodoc>
+ <docstring>Returns the userData associated with this sizer item, or None if there
+isn't any.</docstring>
+ </method>
+ </class>
+ <class name="Sizer" oldname="wxSizer" module="_core">
+ <docstring>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.</docstring>
<baseclass name="Object"/>
<method name="_setOORInfo" type="" overloaded="no">
- <autodoc>_setOORInfo(PyObject _self)</autodoc>
+ <autodoc>_setOORInfo(self, PyObject _self)</autodoc>
<paramlist>
<param name="_self" type="PyObject" default=""/>
</paramlist>
</method>
<method name="Add" type="" overloaded="no">
- <autodoc>Add(PyObject item, int proportion=0, int flag=0, int border=0,
+ <autodoc>Add(self, item, int proportion=0, int flag=0, int border=0,
PyObject userData=None)</autodoc>
+ <docstring>Appends a child item to the sizer.</docstring>
<paramlist>
<param name="item" type="PyObject" default=""/>
<param name="proportion" type="int" default="0"/>
</paramlist>
</method>
<method name="Insert" type="" overloaded="no">
- <autodoc>Insert(int before, PyObject item, int proportion=0, int flag=0,
- int border=0, PyObject userData=None)</autodoc>
+ <autodoc>Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
+ PyObject userData=None)</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="before" type="int" default=""/>
<param name="item" type="PyObject" default=""/>
</paramlist>
</method>
<method name="Prepend" type="" overloaded="no">
- <autodoc>Prepend(PyObject item, int proportion=0, int flag=0, int border=0,
+ <autodoc>Prepend(self, item, int proportion=0, int flag=0, int border=0,
PyObject userData=None)</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="item" type="PyObject" default=""/>
<param name="proportion" type="int" default="0"/>
</paramlist>
</method>
<method name="Remove" type="bool" overloaded="no">
- <autodoc>Remove(PyObject item) -> bool</autodoc>
+ <autodoc>Remove(self, item) -> bool</autodoc>
+ <docstring>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.</docstring>
+ <paramlist>
+ <param name="item" type="PyObject" default=""/>
+ </paramlist>
+ </method>
+ <method name="Detach" type="bool" overloaded="no">
+ <autodoc>Detach(self, item) -> bool</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="item" type="PyObject" default=""/>
</paramlist>
</method>
<method name="_SetItemMinSize" type="" overloaded="no">
- <autodoc>_SetItemMinSize(PyObject item, Size size)</autodoc>
+ <autodoc>_SetItemMinSize(self, PyObject item, Size size)</autodoc>
<paramlist>
<param name="item" type="PyObject" default=""/>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="AddItem" type="" overloaded="no">
- <autodoc>AddItem(SizerItem item)</autodoc>
+ <autodoc>AddItem(self, SizerItem item)</autodoc>
+ <docstring>Adds a `wx.SizerItem` to the sizer.</docstring>
<paramlist>
<param name="item" type="SizerItem" default=""/>
</paramlist>
</method>
<method name="InsertItem" type="" overloaded="no">
- <autodoc>InsertItem(size_t index, SizerItem item)</autodoc>
+ <autodoc>InsertItem(self, int index, SizerItem item)</autodoc>
+ <docstring>Inserts a `wx.SizerItem` to the sizer at the position given by *index*.</docstring>
<paramlist>
<param name="index" type="size_t" default=""/>
<param name="item" type="SizerItem" default=""/>
</paramlist>
</method>
<method name="PrependItem" type="" overloaded="no">
- <autodoc>PrependItem(SizerItem item)</autodoc>
+ <autodoc>PrependItem(self, SizerItem item)</autodoc>
+ <docstring>Prepends a `wx.SizerItem` to the sizer.</docstring>
<paramlist>
<param name="item" type="SizerItem" default=""/>
</paramlist>
</method>
<method name="SetDimension" type="" overloaded="no">
- <autodoc>SetDimension(int x, int y, int width, int height)</autodoc>
+ <autodoc>SetDimension(self, int x, int y, int width, int height)</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="SetMinSize" type="" overloaded="no">
- <autodoc>SetMinSize(Size size)</autodoc>
+ <autodoc>SetMinSize(self, Size size)</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="GetSize" type="Size" overloaded="no">
- <autodoc>GetSize() -> Size</autodoc>
+ <autodoc>GetSize(self) -> Size</autodoc>
+ <docstring>Returns the current size of the space managed by the sizer.</docstring>
</method>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
+ <docstring>Returns the current position of the sizer's managed space.</docstring>
</method>
<method name="GetMinSize" type="Size" overloaded="no">
- <autodoc>GetMinSize() -> Size</autodoc>
+ <autodoc>GetMinSize(self) -> Size</autodoc>
+ <docstring>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.</docstring>
</method>
<method name="RecalcSizes" type="" overloaded="no">
- <autodoc>RecalcSizes()</autodoc>
+ <autodoc>RecalcSizes(self)</autodoc>
+ <docstring>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`.</docstring>
</method>
<method name="CalcMin" type="Size" overloaded="no">
- <autodoc>CalcMin() -> Size</autodoc>
+ <autodoc>CalcMin(self) -> Size</autodoc>
+ <docstring>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`.</docstring>
</method>
<method name="Layout" type="" overloaded="no">
- <autodoc>Layout()</autodoc>
+ <autodoc>Layout(self)</autodoc>
+ <docstring>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.</docstring>
</method>
<method name="Fit" type="Size" overloaded="no">
- <autodoc>Fit(Window window) -> Size</autodoc>
+ <autodoc>Fit(self, Window window) -> Size</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="FitInside" type="" overloaded="no">
- <autodoc>FitInside(Window window)</autodoc>
+ <autodoc>FitInside(self, Window window)</autodoc>
+ <docstring>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`
+</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="SetSizeHints" type="" overloaded="no">
- <autodoc>SetSizeHints(Window window)</autodoc>
+ <autodoc>SetSizeHints(self, Window window)</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="SetVirtualSizeHints" type="" overloaded="no">
- <autodoc>SetVirtualSizeHints(Window window)</autodoc>
+ <autodoc>SetVirtualSizeHints(self, Window window)</autodoc>
+ <docstring>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`
+</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear(bool delete_windows=False)</autodoc>
+ <autodoc>Clear(self, bool deleteWindows=False)</autodoc>
+ <docstring>Clear all items from the sizer, optionally destroying the window items
+as well.</docstring>
<paramlist>
- <param name="delete_windows" type="bool" default="False"/>
+ <param name="deleteWindows" type="bool" default="False"/>
</paramlist>
</method>
<method name="DeleteWindows" type="" overloaded="no">
- <autodoc>DeleteWindows()</autodoc>
+ <autodoc>DeleteWindows(self)</autodoc>
+ <docstring>Destroy all windows managed by the sizer.</docstring>
</method>
<method name="GetChildren" type="PyObject" overloaded="no">
- <autodoc>GetChildren() -> PyObject</autodoc>
+ <autodoc>GetChildren(sefl) -> list</autodoc>
+ <docstring>Returns a list of all the `wx.SizerItem` objects managed by the sizer.</docstring>
</method>
<method name="Show" type="" overloaded="no">
- <autodoc>Show(PyObject item, bool show=True)</autodoc>
+ <autodoc>Show(self, item, bool show=True)</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="item" type="PyObject" default=""/>
<param name="show" type="bool" default="True"/>
</paramlist>
</method>
- <method name="Hide" type="" overloaded="no">
- <autodoc>Hide(PyObject item)</autodoc>
- <paramlist>
- <param name="item" type="PyObject" default=""/>
- </paramlist>
- </method>
<method name="IsShown" type="bool" overloaded="no">
- <autodoc>IsShown(PyObject item) -> bool</autodoc>
+ <autodoc>IsShown(self, item)</autodoc>
+ <docstring>Determines if the item is currently shown. 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.</docstring>
<paramlist>
<param name="item" type="PyObject" default=""/>
</paramlist>
</method>
<method name="ShowItems" type="" overloaded="no">
- <autodoc>ShowItems(bool show)</autodoc>
+ <autodoc>ShowItems(self, bool show)</autodoc>
+ <docstring>Recursively call `wx.Window.Show` on all sizer items.</docstring>
<paramlist>
<param name="show" type="bool" default=""/>
</paramlist>
</method>
</class>
- <class name="PySizer" oldname="wxPySizer" module="core">
+ <class name="PySizer" oldname="wxPySizer" module="_core">
+ <docstring>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 resuing them in `RecalcSizes`.
+
+:see: `wx.SizerItem`, `wx.Sizer.GetChildren`
+
+</docstring>
<baseclass name="Sizer"/>
<constructor name="PySizer" overloaded="no">
- <autodoc>__init__() -> PySizer</autodoc>
+ <autodoc>__init__(self) -> PySizer</autodoc>
+ <docstring>Creates a wx.PySizer. Must be called from the __init__ in the derived
+class.</docstring>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="BoxSizer" oldname="wxBoxSizer" module="core">
+ <class name="BoxSizer" oldname="wxBoxSizer" module="_core">
+ <docstring>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.</docstring>
<baseclass name="Sizer"/>
<constructor name="BoxSizer" overloaded="no">
- <autodoc>__init__(int orient=HORIZONTAL) -> BoxSizer</autodoc>
+ <autodoc>__init__(self, int orient=HORIZONTAL) -> BoxSizer</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="orient" type="int" default="wxHORIZONTAL"/>
</paramlist>
</constructor>
<method name="GetOrientation" type="int" overloaded="no">
- <autodoc>GetOrientation() -> int</autodoc>
+ <autodoc>GetOrientation(self) -> int</autodoc>
+ <docstring>Returns the current orientation of the sizer.</docstring>
</method>
<method name="SetOrientation" type="" overloaded="no">
- <autodoc>SetOrientation(int orient)</autodoc>
+ <autodoc>SetOrientation(self, int orient)</autodoc>
+ <docstring>Resets the orientation of the sizer.</docstring>
<paramlist>
<param name="orient" type="int" default=""/>
</paramlist>
</method>
- <method name="RecalcSizes" type="" overloaded="no">
- <autodoc>RecalcSizes()</autodoc>
- </method>
- <method name="CalcMin" type="Size" overloaded="no">
- <autodoc>CalcMin() -> Size</autodoc>
- </method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="StaticBoxSizer" oldname="wxStaticBoxSizer" module="core">
+ <class name="StaticBoxSizer" oldname="wxStaticBoxSizer" module="_core">
+ <docstring>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.</docstring>
<baseclass name="BoxSizer"/>
<constructor name="StaticBoxSizer" overloaded="no">
- <autodoc>__init__(wxStaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer</autodoc>
+ <autodoc>__init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer</autodoc>
+ <docstring>Constructor. It takes an associated static box and the orientation
+*orient* as parameters - orient can be either of ``wx.VERTICAL`` or
+``wx.HORIZONTAL``.</docstring>
<paramlist>
<param name="box" type="wxStaticBox" default=""/>
<param name="orient" type="int" default="wxHORIZONTAL"/>
</paramlist>
</constructor>
<method name="GetStaticBox" type="wxStaticBox" overloaded="no">
- <autodoc>GetStaticBox() -> wxStaticBox</autodoc>
- </method>
- <method name="RecalcSizes" type="" overloaded="no">
- <autodoc>RecalcSizes()</autodoc>
- </method>
- <method name="CalcMin" type="Size" overloaded="no">
- <autodoc>CalcMin() -> Size</autodoc>
+ <autodoc>GetStaticBox(self) -> StaticBox</autodoc>
+ <docstring>Returns the static box associated with this sizer.</docstring>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="GridSizer" oldname="wxGridSizer" module="core">
+ <class name="GridSizer" oldname="wxGridSizer" module="_core">
+ <docstring>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`.
+</docstring>
<baseclass name="Sizer"/>
<constructor name="GridSizer" overloaded="no">
- <autodoc>__init__(int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer</autodoc>
+ <autodoc>__init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="rows" type="int" default="1"/>
<param name="cols" type="int" default="0"/>
<param name="hgap" type="int" default="0"/>
</paramlist>
</constructor>
- <method name="RecalcSizes" type="" overloaded="no">
- <autodoc>RecalcSizes()</autodoc>
- </method>
- <method name="CalcMin" type="Size" overloaded="no">
- <autodoc>CalcMin() -> Size</autodoc>
- </method>
<method name="SetCols" type="" overloaded="no">
- <autodoc>SetCols(int cols)</autodoc>
+ <autodoc>SetCols(self, int cols)</autodoc>
+ <docstring>Sets the number of columns in the sizer.</docstring>
<paramlist>
<param name="cols" type="int" default=""/>
</paramlist>
</method>
<method name="SetRows" type="" overloaded="no">
- <autodoc>SetRows(int rows)</autodoc>
+ <autodoc>SetRows(self, int rows)</autodoc>
+ <docstring>Sets the number of rows in the sizer.</docstring>
<paramlist>
<param name="rows" type="int" default=""/>
</paramlist>
</method>
<method name="SetVGap" type="" overloaded="no">
- <autodoc>SetVGap(int gap)</autodoc>
+ <autodoc>SetVGap(self, int gap)</autodoc>
+ <docstring>Sets the vertical gap (in pixels) between the cells in the sizer.</docstring>
<paramlist>
<param name="gap" type="int" default=""/>
</paramlist>
</method>
<method name="SetHGap" type="" overloaded="no">
- <autodoc>SetHGap(int gap)</autodoc>
+ <autodoc>SetHGap(self, int gap)</autodoc>
+ <docstring>Sets the horizontal gap (in pixels) between cells in the sizer</docstring>
<paramlist>
<param name="gap" type="int" default=""/>
</paramlist>
</method>
<method name="GetCols" type="int" overloaded="no">
- <autodoc>GetCols() -> int</autodoc>
+ <autodoc>GetCols(self) -> int</autodoc>
+ <docstring>Returns the number of columns in the sizer.</docstring>
</method>
<method name="GetRows" type="int" overloaded="no">
- <autodoc>GetRows() -> int</autodoc>
+ <autodoc>GetRows(self) -> int</autodoc>
+ <docstring>Returns the number of rows in the sizer.</docstring>
</method>
<method name="GetVGap" type="int" overloaded="no">
- <autodoc>GetVGap() -> int</autodoc>
+ <autodoc>GetVGap(self) -> int</autodoc>
+ <docstring>Returns the vertical gap (in pixels) between the cells in the sizer.</docstring>
</method>
<method name="GetHGap" type="int" overloaded="no">
- <autodoc>GetHGap() -> int</autodoc>
+ <autodoc>GetHGap(self) -> int</autodoc>
+ <docstring>Returns the horizontal gap (in pixels) between cells in the sizer.</docstring>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="FlexGridSizer" oldname="wxFlexGridSizer" module="core">
+ <class name="FlexGridSizer" oldname="wxFlexGridSizer" module="_core">
+ <docstring>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`.
+
+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.
+
+</docstring>
<baseclass name="GridSizer"/>
<constructor name="FlexGridSizer" overloaded="no">
- <autodoc>__init__(int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer</autodoc>
+ <autodoc>__init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="rows" type="int" default="1"/>
<param name="cols" type="int" default="0"/>
<param name="hgap" type="int" default="0"/>
</paramlist>
</constructor>
- <method name="RecalcSizes" type="" overloaded="no">
- <autodoc>RecalcSizes()</autodoc>
- </method>
- <method name="CalcMin" type="Size" overloaded="no">
- <autodoc>CalcMin() -> Size</autodoc>
- </method>
<method name="AddGrowableRow" type="" overloaded="no">
- <autodoc>AddGrowableRow(size_t idx, int proportion=0)</autodoc>
+ <autodoc>AddGrowableRow(self, size_t idx, int proportion=0)</autodoc>
+ <docstring>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).</docstring>
<paramlist>
<param name="idx" type="size_t" default=""/>
<param name="proportion" type="int" default="0"/>
</paramlist>
</method>
<method name="RemoveGrowableRow" type="" overloaded="no">
- <autodoc>RemoveGrowableRow(size_t idx)</autodoc>
+ <autodoc>RemoveGrowableRow(self, size_t idx)</autodoc>
+ <docstring>Specifies that row *idx* is no longer growable.</docstring>
<paramlist>
<param name="idx" type="size_t" default=""/>
</paramlist>
</method>
<method name="AddGrowableCol" type="" overloaded="no">
- <autodoc>AddGrowableCol(size_t idx, int proportion=0)</autodoc>
+ <autodoc>AddGrowableCol(self, size_t idx, int proportion=0)</autodoc>
+ <docstring>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).</docstring>
<paramlist>
<param name="idx" type="size_t" default=""/>
<param name="proportion" type="int" default="0"/>
</paramlist>
</method>
<method name="RemoveGrowableCol" type="" overloaded="no">
- <autodoc>RemoveGrowableCol(size_t idx)</autodoc>
+ <autodoc>RemoveGrowableCol(self, size_t idx)</autodoc>
+ <docstring>Specifies that column *idx* is no longer growable.</docstring>
<paramlist>
<param name="idx" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetFlexibleDirection" type="" overloaded="no">
- <autodoc>SetFlexibleDirection(int direction)</autodoc>
+ <autodoc>SetFlexibleDirection(self, int direction)</autodoc>
+ <docstring>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.
+</docstring>
<paramlist>
<param name="direction" type="int" default=""/>
</paramlist>
</method>
<method name="GetFlexibleDirection" type="int" overloaded="no">
- <autodoc>GetFlexibleDirection() -> int</autodoc>
+ <autodoc>GetFlexibleDirection(self) -> int</autodoc>
+ <docstring>Returns a value that specifies whether the sizer
+flexibly resizes its columns, rows, or both (default).
+
+:see: `SetFlexibleDirection`</docstring>
</method>
<method name="SetNonFlexibleGrowMode" type="" overloaded="no">
- <autodoc>SetNonFlexibleGrowMode(int mode)</autodoc>
+ <autodoc>SetNonFlexibleGrowMode(self, int mode)</autodoc>
+ <docstring>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.
+
+</docstring>
<paramlist>
<param name="mode" type="wxFlexSizerGrowMode" default=""/>
</paramlist>
</method>
<method name="GetNonFlexibleGrowMode" type="wxFlexSizerGrowMode" overloaded="no">
- <autodoc>GetNonFlexibleGrowMode() -> int</autodoc>
+ <autodoc>GetNonFlexibleGrowMode(self) -> int</autodoc>
+ <docstring>Returns the value that specifies how the sizer grows in the
+non-flexible direction if there is one.
+
+:see: `SetNonFlexibleGrowMode`</docstring>
</method>
<method name="GetRowHeights" type="wxArrayInt" overloaded="no">
- <autodoc>GetRowHeights() -> wxArrayInt</autodoc>
+ <autodoc>GetRowHeights(self) -> list</autodoc>
</method>
<method name="GetColWidths" type="wxArrayInt" overloaded="no">
- <autodoc>GetColWidths() -> wxArrayInt</autodoc>
+ <autodoc>GetColWidths(self) -> list</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="GBPosition" oldname="wxGBPosition" module="core">
+ <class name="GBPosition" oldname="wxGBPosition" module="_core">
+ <docstring>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.</docstring>
<constructor name="GBPosition" overloaded="no">
- <autodoc>__init__(int row=0, int col=0) -> GBPosition</autodoc>
+ <autodoc>__init__(self, int row=0, int col=0) -> GBPosition</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="row" type="int" default="0"/>
<param name="col" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetRow" type="int" overloaded="no">
- <autodoc>GetRow() -> int</autodoc>
+ <autodoc>GetRow(self) -> int</autodoc>
</method>
<method name="GetCol" type="int" overloaded="no">
- <autodoc>GetCol() -> int</autodoc>
+ <autodoc>GetCol(self) -> int</autodoc>
</method>
<method name="SetRow" type="" overloaded="no">
- <autodoc>SetRow(int row)</autodoc>
+ <autodoc>SetRow(self, int row)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="SetCol" type="" overloaded="no">
- <autodoc>SetCol(int col)</autodoc>
+ <autodoc>SetCol(self, int col)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(GBPosition other) -> bool</autodoc>
+ <autodoc>__eq__(self, GBPosition other) -> bool</autodoc>
<paramlist>
<param name="other" type="GBPosition" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(GBPosition other) -> bool</autodoc>
+ <autodoc>__ne__(self, GBPosition other) -> bool</autodoc>
<paramlist>
<param name="other" type="GBPosition" default=""/>
</paramlist>
</method>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(int row=0, int col=0)</autodoc>
+ <autodoc>Set(self, int row=0, int col=0)</autodoc>
<paramlist>
<param name="row" type="int" default="0"/>
<param name="col" type="int" default="0"/>
</paramlist>
</method>
<method name="Get" type="PyObject" overloaded="no">
- <autodoc>Get() -> PyObject</autodoc>
+ <autodoc>Get(self) -> PyObject</autodoc>
</method>
</class>
- <class name="GBSpan" oldname="wxGBSpan" module="core">
+ <class name="GBSpan" oldname="wxGBSpan" module="_core">
+ <docstring>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.
+</docstring>
<constructor name="GBSpan" overloaded="no">
- <autodoc>__init__(int rowspan=1, int colspan=1) -> GBSpan</autodoc>
+ <autodoc>__init__(self, int rowspan=1, int colspan=1) -> GBSpan</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="rowspan" type="int" default="1"/>
<param name="colspan" type="int" default="1"/>
</paramlist>
</constructor>
<method name="GetRowspan" type="int" overloaded="no">
- <autodoc>GetRowspan() -> int</autodoc>
+ <autodoc>GetRowspan(self) -> int</autodoc>
</method>
<method name="GetColspan" type="int" overloaded="no">
- <autodoc>GetColspan() -> int</autodoc>
+ <autodoc>GetColspan(self) -> int</autodoc>
</method>
<method name="SetRowspan" type="" overloaded="no">
- <autodoc>SetRowspan(int rowspan)</autodoc>
+ <autodoc>SetRowspan(self, int rowspan)</autodoc>
<paramlist>
<param name="rowspan" type="int" default=""/>
</paramlist>
</method>
<method name="SetColspan" type="" overloaded="no">
- <autodoc>SetColspan(int colspan)</autodoc>
+ <autodoc>SetColspan(self, int colspan)</autodoc>
<paramlist>
<param name="colspan" type="int" default=""/>
</paramlist>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(GBSpan other) -> bool</autodoc>
+ <autodoc>__eq__(self, GBSpan other) -> bool</autodoc>
<paramlist>
<param name="other" type="GBSpan" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(GBSpan other) -> bool</autodoc>
+ <autodoc>__ne__(self, GBSpan other) -> bool</autodoc>
<paramlist>
<param name="other" type="GBSpan" default=""/>
</paramlist>
</method>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(int rowspan=1, int colspan=1)</autodoc>
+ <autodoc>Set(self, int rowspan=1, int colspan=1)</autodoc>
<paramlist>
<param name="rowspan" type="int" default="1"/>
<param name="colspan" type="int" default="1"/>
</paramlist>
</method>
<method name="Get" type="PyObject" overloaded="no">
- <autodoc>Get() -> PyObject</autodoc>
+ <autodoc>Get(self) -> PyObject</autodoc>
</method>
</class>
- <class name="GBSizerItem" oldname="wxGBSizerItem" module="core">
+ <class name="GBSizerItem" oldname="wxGBSizerItem" module="_core">
+ <docstring>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.
+</docstring>
<baseclass name="SizerItem"/>
<constructor name="GBSizerItem" overloaded="no">
- <autodoc>__init__() -> GBSizerItem</autodoc>
+ <autodoc>__init__(self) -> GBSizerItem</autodoc>
+ <docstring>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.</docstring>
</constructor>
<constructor name="GBSizerItemWindow" overloaded="no">
<autodoc>GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
- int border, Object userData) -> GBSizerItem</autodoc>
+ int border, PyObject userData=None) -> GBSizerItem</autodoc>
+ <docstring>Construct a `wx.GBSizerItem` for a window.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
<param name="pos" type="GBPosition" default=""/>
<param name="span" type="GBSpan" default=""/>
<param name="flag" type="int" default=""/>
<param name="border" type="int" default=""/>
- <param name="userData" type="Object" default=""/>
+ <param name="userData" type="PyObject" default="NULL"/>
</paramlist>
</constructor>
<constructor name="GBSizerItemSizer" overloaded="no">
<autodoc>GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
- int border, Object userData) -> GBSizerItem</autodoc>
+ int border, PyObject userData=None) -> GBSizerItem</autodoc>
+ <docstring>Construct a `wx.GBSizerItem` for a sizer</docstring>
<paramlist>
<param name="sizer" type="Sizer" default=""/>
<param name="pos" type="GBPosition" default=""/>
<param name="span" type="GBSpan" default=""/>
<param name="flag" type="int" default=""/>
<param name="border" type="int" default=""/>
- <param name="userData" type="Object" default=""/>
+ <param name="userData" type="PyObject" default="NULL"/>
</paramlist>
</constructor>
<constructor name="GBSizerItemSpacer" overloaded="no">
<autodoc>GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
- int flag, int border, Object userData) -> GBSizerItem</autodoc>
+ int flag, int border, PyObject userData=None) -> GBSizerItem</autodoc>
+ <docstring>Construct a `wx.GBSizerItem` for a spacer.</docstring>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
<param name="span" type="GBSpan" default=""/>
<param name="flag" type="int" default=""/>
<param name="border" type="int" default=""/>
- <param name="userData" type="Object" default=""/>
+ <param name="userData" type="PyObject" default="NULL"/>
</paramlist>
</constructor>
<method name="GetPos" type="GBPosition" overloaded="no">
- <autodoc>GetPos() -> GBPosition</autodoc>
+ <autodoc>GetPos(self) -> GBPosition</autodoc>
+ <docstring>Get the grid position of the item</docstring>
</method>
<method name="GetSpan" type="GBSpan" overloaded="no">
- <autodoc>GetSpan() -> GBSpan</autodoc>
+ <autodoc>GetSpan(self) -> GBSpan</autodoc>
+ <docstring>Get the row and column spanning of the item</docstring>
</method>
<method name="SetPos" type="bool" overloaded="no">
- <autodoc>SetPos(GBPosition pos) -> bool</autodoc>
+ <autodoc>SetPos(self, GBPosition pos) -> bool</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="pos" type="GBPosition" default=""/>
</paramlist>
</method>
<method name="SetSpan" type="bool" overloaded="no">
- <autodoc>SetSpan(GBSpan span) -> bool</autodoc>
+ <autodoc>SetSpan(self, GBSpan span) -> bool</autodoc>
+ <docstring>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.
+</docstring>
<paramlist>
<param name="span" type="GBSpan" default=""/>
</paramlist>
</method>
- <method name="Intersects" type="bool" overloaded="yes">
+ <method name="Intersects" type="bool" overloaded="no">
+ <autodoc>Intersects(self, GBSizerItem other) -> bool</autodoc>
+ <docstring>Returns True if this item and the other item instersect.</docstring>
<paramlist>
<param name="other" type="GBSizerItem" default=""/>
</paramlist>
</method>
- <method name="Intersects" type="bool" overloaded="yes">
- <autodoc>Intersects(GBSizerItem other) -> bool
-Intersects(GBPosition pos, GBSpan span) -> bool</autodoc>
+ <method name="IntersectsPos" type="bool" overloaded="no">
+ <autodoc>IntersectsPos(self, GBPosition pos, GBSpan span) -> bool</autodoc>
+ <docstring>Returns True if the given pos/span would intersect with this item.</docstring>
<paramlist>
<param name="pos" type="GBPosition" default=""/>
<param name="span" type="GBSpan" default=""/>
</paramlist>
</method>
- <method name="GetEndPos" type="" overloaded="no">
- <autodoc>GetEndPos(int row, int col)</autodoc>
- <paramlist>
- <param name="row" type="int" default=""/>
- <param name="col" type="int" default=""/>
- </paramlist>
+ <method name="GetEndPos" type="GBPosition" overloaded="no">
+ <autodoc>GetEndPos(self) -> GBPosition</autodoc>
+ <docstring>Get the row and column of the endpoint of this item.</docstring>
</method>
<method name="GetGBSizer" type="wxGridBagSizer" overloaded="no">
- <autodoc>GetGBSizer() -> GridBagSizer</autodoc>
+ <autodoc>GetGBSizer(self) -> GridBagSizer</autodoc>
+ <docstring>Get the sizer this item is a member of.</docstring>
</method>
<method name="SetGBSizer" type="" overloaded="no">
- <autodoc>SetGBSizer(GridBagSizer sizer)</autodoc>
+ <autodoc>SetGBSizer(self, GridBagSizer sizer)</autodoc>
+ <docstring>Set the sizer this item is a member of.</docstring>
<paramlist>
<param name="sizer" type="wxGridBagSizer" default=""/>
</paramlist>
</method>
</class>
- <class name="GridBagSizer" oldname="wxGridBagSizer" module="core">
+ <class name="GridBagSizer" oldname="wxGridBagSizer" module="_core">
+ <docstring>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.
+</docstring>
<baseclass name="FlexGridSizer"/>
<constructor name="GridBagSizer" overloaded="no">
- <autodoc>__init__(int vgap=0, int hgap=0) -> GridBagSizer</autodoc>
+ <autodoc>__init__(self, int vgap=0, int hgap=0) -> GridBagSizer</autodoc>
+ <docstring>Constructor, with optional parameters to specify the gap between the
+rows and columns.</docstring>
<paramlist>
<param name="vgap" type="int" default="0"/>
<param name="hgap" type="int" default="0"/>
</paramlist>
</constructor>
<method name="Add" type="bool" overloaded="no">
- <autodoc>Add(PyObject item, GBPosition pos, GBSpan span=DefaultSpan,
- int flag=0, int border=0, PyObject userData=None) -> bool</autodoc>
+ <autodoc>Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
+int border=0, userData=None)</autodoc>
+ <docstring>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.
+</docstring>
<paramlist>
<param name="item" type="PyObject" default=""/>
<param name="pos" type="GBPosition" default=""/>
</paramlist>
</method>
<method name="AddItem" type="bool" overloaded="no">
- <autodoc>AddItem(GBSizerItem item) -> bool</autodoc>
+ <autodoc>Add(self, GBSizerItem item) -> bool</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="item" type="GBSizerItem" default=""/>
</paramlist>
</method>
<method name="GetEmptyCellSize" type="Size" overloaded="no">
- <autodoc>GetEmptyCellSize() -> Size</autodoc>
+ <autodoc>GetEmptyCellSize(self) -> Size</autodoc>
+ <docstring>Get the size used for cells in the grid with no item.</docstring>
</method>
<method name="SetEmptyCellSize" type="" overloaded="no">
- <autodoc>SetEmptyCellSize(Size sz)</autodoc>
+ <autodoc>SetEmptyCellSize(self, Size sz)</autodoc>
+ <docstring>Set the size used for cells in the grid with no item.</docstring>
<paramlist>
<param name="sz" type="Size" default=""/>
</paramlist>
</method>
<method name="GetItemPosition" type="GBPosition" overloaded="yes">
+ <docstring>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.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="GetItemPosition" type="GBPosition" overloaded="yes">
+ <docstring>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.</docstring>
<paramlist>
<param name="sizer" type="Sizer" default=""/>
</paramlist>
</method>
<method name="GetItemPosition" type="GBPosition" overloaded="yes">
- <autodoc>GetItemPosition(Window window) -> GBPosition
-GetItemPosition(Sizer sizer) -> GBPosition
-GetItemPosition(size_t index) -> GBPosition</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="index" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetItemPosition" type="bool" overloaded="yes">
+ <docstring>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.
+</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
<param name="pos" type="GBPosition" default=""/>
</paramlist>
</method>
<method name="SetItemPosition" type="bool" overloaded="yes">
+ <docstring>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.
+</docstring>
<paramlist>
<param name="sizer" type="Sizer" default=""/>
<param name="pos" type="GBPosition" default=""/>
</paramlist>
</method>
<method name="SetItemPosition" type="bool" overloaded="yes">
- <autodoc>SetItemPosition(Window window, GBPosition pos) -> bool
-SetItemPosition(Sizer sizer, GBPosition pos) -> bool
-SetItemPosition(size_t index, GBPosition pos) -> bool</autodoc>
+ <docstring>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.
+</docstring>
<paramlist>
<param name="index" type="size_t" default=""/>
<param name="pos" type="GBPosition" default=""/>
</paramlist>
</method>
<method name="GetItemSpan" type="GBSpan" overloaded="yes">
+ <docstring>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.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="GetItemSpan" type="GBSpan" overloaded="yes">
+ <docstring>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.</docstring>
<paramlist>
<param name="sizer" type="Sizer" default=""/>
</paramlist>
</method>
<method name="GetItemSpan" type="GBSpan" overloaded="yes">
- <autodoc>GetItemSpan(Window window) -> GBSpan
-GetItemSpan(Sizer sizer) -> GBSpan
-GetItemSpan(size_t index) -> GBSpan</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="index" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetItemSpan" type="bool" overloaded="yes">
+ <docstring>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.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
<param name="span" type="GBSpan" default=""/>
</paramlist>
</method>
<method name="SetItemSpan" type="bool" overloaded="yes">
+ <docstring>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.</docstring>
<paramlist>
<param name="sizer" type="Sizer" default=""/>
<param name="span" type="GBSpan" default=""/>
</paramlist>
</method>
<method name="SetItemSpan" type="bool" overloaded="yes">
- <autodoc>SetItemSpan(Window window, GBSpan span) -> bool
-SetItemSpan(Sizer sizer, GBSpan span) -> bool
-SetItemSpan(size_t index, GBSpan span) -> bool</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="index" type="size_t" default=""/>
<param name="span" type="GBSpan" default=""/>
</paramlist>
</method>
<method name="FindItem" type="GBSizerItem" overloaded="yes">
+ <docstring>FindItem(self, item) -> GBSizerItem
+
+Find the sizer item for the given window or subsizer, returns None if
+not found. (non-recursive)</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="FindItem" type="GBSizerItem" overloaded="yes">
- <autodoc>FindItem(Window window) -> GBSizerItem
-FindItem(Sizer sizer) -> GBSizerItem</autodoc>
+ <docstring>FindItem(self, item) -> GBSizerItem
+
+Find the sizer item for the given window or subsizer, returns None if
+not found. (non-recursive)</docstring>
<paramlist>
<param name="sizer" type="Sizer" default=""/>
</paramlist>
</method>
<method name="FindItemAtPosition" type="GBSizerItem" overloaded="no">
- <autodoc>FindItemAtPosition(GBPosition pos) -> GBSizerItem</autodoc>
+ <autodoc>FindItemAtPosition(self, GBPosition pos) -> GBSizerItem</autodoc>
+ <docstring>Return the sizer item for the given grid cell, or None if there is no
+item at that position. (non-recursive)</docstring>
<paramlist>
<param name="pos" type="GBPosition" default=""/>
</paramlist>
</method>
<method name="FindItemAtPoint" type="GBSizerItem" overloaded="no">
- <autodoc>FindItemAtPoint(Point pt) -> GBSizerItem</autodoc>
+ <autodoc>FindItemAtPoint(self, Point pt) -> GBSizerItem</autodoc>
+ <docstring>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)</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
- <method name="FindItemWithData" type="GBSizerItem" overloaded="no">
- <autodoc>FindItemWithData(Object userData) -> GBSizerItem</autodoc>
+ <method name="CheckForIntersection" type="bool" overloaded="no">
+ <autodoc>CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool</autodoc>
+ <docstring>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.
+</docstring>
<paramlist>
- <param name="userData" type="Object" default=""/>
+ <param name="item" type="GBSizerItem" default=""/>
+ <param name="excludeItem" type="GBSizerItem" default="NULL"/>
</paramlist>
</method>
- <method name="RecalcSizes" type="" overloaded="no">
- <autodoc>RecalcSizes()</autodoc>
- </method>
- <method name="CalcMin" type="Size" overloaded="no">
- <autodoc>CalcMin() -> Size</autodoc>
- </method>
- <method name="CheckForIntersection" type="bool" overloaded="yes">
- <paramlist>
- <param name="item" type="GBSizerItem" default=""/>
- <param name="excludeItem" type="GBSizerItem" default="NULL"/>
- </paramlist>
- </method>
- <method name="CheckForIntersection" type="bool" overloaded="yes">
- <autodoc>CheckForIntersection(GBSizerItem item, GBSizerItem excludeItem=None) -> bool
-CheckForIntersection(GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool</autodoc>
+ <method name="CheckForIntersectionPos" type="bool" overloaded="no">
+ <autodoc>CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool</autodoc>
+ <docstring>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.</docstring>
<paramlist>
<param name="pos" type="GBPosition" default=""/>
<param name="span" type="GBSpan" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="IndividualLayoutConstraint" oldname="wxIndividualLayoutConstraint" module="core">
- <docstring>Objects of this class are stored in the wx.LayoutConstraint class as one of
-eight possible constraints that a window can be involved in. You will never
-need to create an instance of wx.IndividualLayoutConstraint, rather you should
-use create a wx.LayoutContstraints instance and use the individual contstraints
-that it contains.
-
-Constraints are initially set to have the relationship wx.Unconstrained, which
-means that their values should be calculated by looking at known constraints.
-
-The Edge specifies the type of edge or dimension of a window.
-
- Edges
-
- wx.Left The left edge.
- wx.Top The top edge.
- wx.Right The right edge.
- wx.Bottom The bottom edge.
- wx.CentreX The x-coordinate of the centre of the window.
- wx.CentreY The y-coordinate of the centre of the window.
-
-
-The Relationship specifies the relationship that this edge or dimension has
-with another specified edge or dimension. Normally, the user doesn't use these
-directly because functions such as Below and RightOf are a convenience for
-using the more general Set function.
-
- Relationships
-
- wx.Unconstrained The edge or dimension is unconstrained
- (the default for edges.)
- wx.AsIs The edge or dimension is to be taken from the current
- window position or size (the default for dimensions.)
- wx.Above The edge should be above another edge.
- wx.Below The edge should be below another edge.
- wx.LeftOf The edge should be to the left of another edge.
- wx.RightOf The edge should be to the right of another edge.
- wx.SameAs The edge or dimension should be the same as another edge
- or dimension.
- wx.PercentOf The edge or dimension should be a percentage of another
- edge or dimension.
- wx.Absolute The edge or dimension should be a given absolute value.
-
-</docstring>
+ <class name="IndividualLayoutConstraint" oldname="wxIndividualLayoutConstraint" module="_core">
+ <docstring>Objects of this class are stored in the `wx.LayoutConstraints` class as
+one of eight possible constraints that a window can be involved in.
+You will never need to create an instance of
+wx.IndividualLayoutConstraint, rather you should create a
+`wx.LayoutConstraints` instance and use the individual contstraints
+that it contains.</docstring>
<baseclass name="Object"/>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)</autodoc>
+ <autodoc>Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)</autodoc>
+ <docstring>Sets the properties of the constraint. Normally called by one of the
+convenience functions such as Above, RightOf, SameAs.</docstring>
<paramlist>
<param name="rel" type="wxRelationship" default=""/>
<param name="otherW" type="Window" default=""/>
</paramlist>
</method>
<method name="LeftOf" type="" overloaded="no">
- <autodoc>LeftOf(Window sibling, int marg=0)</autodoc>
- <docstring>Sibling relationship</docstring>
+ <autodoc>LeftOf(self, Window sibling, int marg=0)</autodoc>
+ <docstring>Constrains this edge to be to the left of the given window, with an
+optional margin. Implicitly, this is relative to the left edge of the
+other window.</docstring>
<paramlist>
<param name="sibling" type="Window" default=""/>
<param name="marg" type="int" default="0"/>
</paramlist>
</method>
<method name="RightOf" type="" overloaded="no">
- <autodoc>RightOf(Window sibling, int marg=0)</autodoc>
- <docstring>Sibling relationship</docstring>
+ <autodoc>RightOf(self, Window sibling, int marg=0)</autodoc>
+ <docstring>Constrains this edge to be to the right of the given window, with an
+optional margin. Implicitly, this is relative to the right edge of the
+other window.</docstring>
<paramlist>
<param name="sibling" type="Window" default=""/>
<param name="marg" type="int" default="0"/>
</paramlist>
</method>
<method name="Above" type="" overloaded="no">
- <autodoc>Above(Window sibling, int marg=0)</autodoc>
- <docstring>Sibling relationship</docstring>
+ <autodoc>Above(self, Window sibling, int marg=0)</autodoc>
+ <docstring>Constrains this edge to be above the given window, with an optional
+margin. Implicitly, this is relative to the top edge of the other
+window.</docstring>
<paramlist>
<param name="sibling" type="Window" default=""/>
<param name="marg" type="int" default="0"/>
</paramlist>
</method>
<method name="Below" type="" overloaded="no">
- <autodoc>Below(Window sibling, int marg=0)</autodoc>
- <docstring>Sibling relationship</docstring>
+ <autodoc>Below(self, Window sibling, int marg=0)</autodoc>
+ <docstring>Constrains this edge to be below the given window, with an optional
+margin. Implicitly, this is relative to the bottom edge of the other
+window.</docstring>
<paramlist>
<param name="sibling" type="Window" default=""/>
<param name="marg" type="int" default="0"/>
</paramlist>
</method>
<method name="SameAs" type="" overloaded="no">
- <autodoc>SameAs(Window otherW, int edge, int marg=0)</autodoc>
- <docstring>'Same edge' alignment</docstring>
+ <autodoc>SameAs(self, Window otherW, int edge, int marg=0)</autodoc>
+ <docstring>Constrains this edge or dimension to be to the same as the edge of the
+given window, with an optional margin.</docstring>
<paramlist>
<param name="otherW" type="Window" default=""/>
<param name="edge" type="wxEdge" default=""/>
</paramlist>
</method>
<method name="PercentOf" type="" overloaded="no">
- <autodoc>PercentOf(Window otherW, int wh, int per)</autodoc>
- <docstring>The edge is a percentage of the other window's edge</docstring>
+ <autodoc>PercentOf(self, Window otherW, int wh, int per)</autodoc>
+ <docstring>Constrains this edge or dimension to be to a percentage of the given
+window, with an optional margin.</docstring>
<paramlist>
<param name="otherW" type="Window" default=""/>
<param name="wh" type="wxEdge" default=""/>
</paramlist>
</method>
<method name="Absolute" type="" overloaded="no">
- <autodoc>Absolute(int val)</autodoc>
- <docstring>Edge has absolute value</docstring>
+ <autodoc>Absolute(self, int val)</autodoc>
+ <docstring>Constrains this edge or dimension to be the given absolute value.</docstring>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="Unconstrained" type="" overloaded="no">
- <autodoc>Unconstrained()</autodoc>
- <docstring>Dimension is unconstrained</docstring>
+ <autodoc>Unconstrained(self)</autodoc>
+ <docstring>Sets this edge or dimension to be unconstrained, that is, dependent on
+other edges and dimensions from which this value can be deduced.</docstring>
</method>
<method name="AsIs" type="" overloaded="no">
- <autodoc>AsIs()</autodoc>
- <docstring>Dimension is 'as is' (use current size settings)</docstring>
+ <autodoc>AsIs(self)</autodoc>
+ <docstring>Sets this edge or constraint to be whatever the window's value is at
+the moment. If either of the width and height constraints are *as is*,
+the window will not be resized, but moved instead. This is important
+when considering panel items which are intended to have a default
+size, such as a button, which may take its size from the size of the
+button label.</docstring>
</method>
<method name="GetOtherWindow" type="Window" overloaded="no">
- <autodoc>GetOtherWindow() -> Window</autodoc>
+ <autodoc>GetOtherWindow(self) -> Window</autodoc>
</method>
<method name="GetMyEdge" type="wxEdge" overloaded="no">
- <autodoc>GetMyEdge() -> int</autodoc>
+ <autodoc>GetMyEdge(self) -> int</autodoc>
</method>
<method name="SetEdge" type="" overloaded="no">
- <autodoc>SetEdge(int which)</autodoc>
+ <autodoc>SetEdge(self, int which)</autodoc>
<paramlist>
<param name="which" type="wxEdge" default=""/>
</paramlist>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(int v)</autodoc>
+ <autodoc>SetValue(self, int v)</autodoc>
<paramlist>
<param name="v" type="int" default=""/>
</paramlist>
</method>
<method name="GetMargin" type="int" overloaded="no">
- <autodoc>GetMargin() -> int</autodoc>
+ <autodoc>GetMargin(self) -> int</autodoc>
</method>
<method name="SetMargin" type="" overloaded="no">
- <autodoc>SetMargin(int m)</autodoc>
+ <autodoc>SetMargin(self, int m)</autodoc>
<paramlist>
<param name="m" type="int" default=""/>
</paramlist>
</method>
<method name="GetValue" type="int" overloaded="no">
- <autodoc>GetValue() -> int</autodoc>
+ <autodoc>GetValue(self) -> int</autodoc>
</method>
<method name="GetPercent" type="int" overloaded="no">
- <autodoc>GetPercent() -> int</autodoc>
+ <autodoc>GetPercent(self) -> int</autodoc>
</method>
<method name="GetOtherEdge" type="int" overloaded="no">
- <autodoc>GetOtherEdge() -> int</autodoc>
+ <autodoc>GetOtherEdge(self) -> int</autodoc>
</method>
<method name="GetDone" type="bool" overloaded="no">
- <autodoc>GetDone() -> bool</autodoc>
+ <autodoc>GetDone(self) -> bool</autodoc>
</method>
<method name="SetDone" type="" overloaded="no">
- <autodoc>SetDone(bool d)</autodoc>
+ <autodoc>SetDone(self, bool d)</autodoc>
<paramlist>
<param name="d" type="bool" default=""/>
</paramlist>
</method>
<method name="GetRelationship" type="wxRelationship" overloaded="no">
- <autodoc>GetRelationship() -> int</autodoc>
+ <autodoc>GetRelationship(self) -> int</autodoc>
</method>
<method name="SetRelationship" type="" overloaded="no">
- <autodoc>SetRelationship(int r)</autodoc>
+ <autodoc>SetRelationship(self, int r)</autodoc>
<paramlist>
<param name="r" type="wxRelationship" default=""/>
</paramlist>
</method>
<method name="ResetIfWin" type="bool" overloaded="no">
- <autodoc>ResetIfWin(Window otherW) -> bool</autodoc>
+ <autodoc>ResetIfWin(self, Window otherW) -> bool</autodoc>
<docstring>Reset constraint if it mentions otherWin</docstring>
<paramlist>
<param name="otherW" type="Window" default=""/>
</paramlist>
</method>
<method name="SatisfyConstraint" type="bool" overloaded="no">
- <autodoc>SatisfyConstraint(LayoutConstraints constraints, Window win) -> bool</autodoc>
+ <autodoc>SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool</autodoc>
<docstring>Try to satisfy constraint</docstring>
<paramlist>
<param name="constraints" type="wxLayoutConstraints" default=""/>
</paramlist>
</method>
<method name="GetEdge" type="int" overloaded="no">
- <autodoc>GetEdge(int which, Window thisWin, Window other) -> int</autodoc>
+ <autodoc>GetEdge(self, int which, Window thisWin, Window other) -> int</autodoc>
<docstring>Get the value of this edge or dimension, or if this
is not determinable, -1.</docstring>
<paramlist>
</paramlist>
</method>
</class>
- <class name="LayoutConstraints" oldname="wxLayoutConstraints" module="core">
- <docstring>Note: constraints are now deprecated and you should use sizers instead.
+ <class name="LayoutConstraints" oldname="wxLayoutConstraints" module="_core">
+ <docstring>**Note:** constraints are now deprecated and you should use sizers
+instead.
-Objects of this class can be associated with a window to define its layout
-constraints, with respect to siblings or its parent.
+Objects of this class can be associated with a window to define its
+layout constraints, with respect to siblings or its parent.
The class consists of the following eight constraints of class
wx.IndividualLayoutConstraint, some or all of which should be accessed
* centreX: represents the horizontal centre point of the window
* centreY: represents the vertical centre point of the window
-Most constraints are initially set to have the relationship wxUnconstrained,
-which means that their values should be calculated by looking at known
-constraints. The exceptions are width and height, which are set to wxAsIs to
-ensure that if the user does not specify a constraint, the existing width and
-height will be used, to be compatible with panel items which often have take a
-default size. If the constraint is wxAsIs, the dimension will not be changed.
+Most constraints are initially set to have the relationship
+wxUnconstrained, which means that their values should be calculated by
+looking at known constraints. The exceptions are width and height,
+which are set to wxAsIs to ensure that if the user does not specify a
+constraint, the existing width and height will be used, to be
+compatible with panel items which often have take a default size. If
+the constraint is ``wx.AsIs``, the dimension will not be changed.
+
+:see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
</docstring>
<baseclass name="Object"/>
<constructor name="LayoutConstraints" overloaded="no">
- <autodoc>__init__() -> LayoutConstraints</autodoc>
+ <autodoc>__init__(self) -> LayoutConstraints</autodoc>
</constructor>
<property name="left" type="IndividualLayoutConstraint" readonly="yes"/>
<property name="top" type="IndividualLayoutConstraint" readonly="yes"/>
</paramlist>
</method>
<method name="AreSatisfied" type="bool" overloaded="no">
- <autodoc>AreSatisfied() -> bool</autodoc>
+ <autodoc>AreSatisfied(self) -> bool</autodoc>
</method>
</class>
<pythoncode>#----------------------------------------------------------------------------
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"
-if RELEASE_VERSION != _core.RELEASE_VERSION:
+assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWindows version mismatch"
+assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWindows version mismatch"
+if RELEASE_VERSION != _core_.RELEASE_VERSION:
import warnings
warnings.warn("wxPython/wxWindows release number mismatch")
class _wxPyUnbornObject(object):
"""
- Some stock objects are created when the wx.core module is
+ Some stock objects are created when the wx._core module is
imported, but their C++ instance is not created until the wx.App
object is created and initialized. These object instances will
temporarily have their __class__ changed to this class so an
"""
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'
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
wx.CallAfter(self.Stop)
+
+#----------------------------------------------------------------------------
+# Control which items in this module should be documented by epydoc.
+# We allow only classes and functions, which will help reduce the size
+# of the docs by filtering out the zillions of constants, EVT objects,
+# and etc that don't make much sense by themselves, but are instead
+# documented (or will be) as part of the classes/functions/methods
+# where they should be used.
+
+class __DocFilter:
+ """
+ A filter for epydoc that only allows non-Ptr classes and
+ fucntions, in order to reduce the clutter in the API docs.
+ """
+ def __init__(self, globals):
+ self._globals = globals
+
+ def __call__(self, name):
+ import types
+ 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'):
+ return False
+ return True
+
#----------------------------------------------------------------------------
#----------------------------------------------------------------------------
# Import other modules in this package that should show up in the
# "core" wx namespace
-from gdi import *
-from windows import *
-from controls import *
-from misc import *
+from _gdi import *
+from _windows import *
+from _controls import *
+from _misc import *
# Fixup the stock objects since they can't be used yet. (They will be
# restored in wx.PyApp.OnInit.)
-_core._wxPyFixStockObjects()
+_core_._wxPyFixStockObjects()
#----------------------------------------------------------------------------
#----------------------------------------------------------------------------
</pythoncode>
</module>
- <module name="gdi">
- <import name="core"/>
- <pythoncode> wx = core </pythoncode>
+ <module name="_gdi">
+ <import name="_core"/>
+ <pythoncode> wx = _core </pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="GDIObject" oldname="wxGDIObject" module="gdi">
+ <class name="GDIObject" oldname="wxGDIObject" module="_gdi">
<baseclass name="Object"/>
<constructor name="GDIObject" overloaded="no">
- <autodoc>__init__() -> GDIObject</autodoc>
+ <autodoc>__init__(self) -> GDIObject</autodoc>
</constructor>
<destructor name="~wxGDIObject" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetVisible" type="bool" overloaded="no">
- <autodoc>GetVisible() -> bool</autodoc>
+ <autodoc>GetVisible(self) -> bool</autodoc>
</method>
<method name="SetVisible" type="" overloaded="no">
- <autodoc>SetVisible(bool visible)</autodoc>
+ <autodoc>SetVisible(self, bool visible)</autodoc>
<paramlist>
<param name="visible" type="bool" default=""/>
</paramlist>
</method>
<method name="IsNull" type="bool" overloaded="no">
- <autodoc>IsNull() -> bool</autodoc>
+ <autodoc>IsNull(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Colour" oldname="wxColour" module="gdi">
- <docstring>A colour is an object representing a combination of Red, Green, and Blue (RGB)
-intensity values, and is used to determine drawing colours, window colours,
-etc. Valid RGB values are in the range 0 to 255.
+ <class name="Colour" oldname="wxColour" module="_gdi">
+ <docstring>A colour is an object representing a combination of Red, Green, and
+Blue (RGB) intensity values, and is used to determine drawing colours,
+window colours, etc. Valid RGB values are in the range 0 to 255.
-In wxPython there are typemaps that will automatically convert from a colour
-name, or from a "#RRGGBB" colour hex value string to a wx.Colour object when
-calling C++ methods that expect a wxColour. This means that the following are
-all equivallent:
+In wxPython there are typemaps that will automatically convert from a
+colour name, or from a '#RRGGBB' colour hex value string to a
+wx.Colour object when calling C++ methods that expect a wxColour.
+This means that the following are all equivallent::
win.SetBackgroundColour(wxColour(0,0,255))
- win.SetBackgroundColour("BLUE")
- win.SetBackgroundColour("#0000FF")
+ win.SetBackgroundColour('BLUE')
+ win.SetBackgroundColour('#0000FF')
-You can retrieve the various current system colour settings with
-wx.SystemSettings.GetColour.</docstring>
+Additional colour names and their coresponding values can be added
+using `wx.ColourDatabase`. Various system colours (as set in the
+user's system preferences) can be retrieved with
+`wx.SystemSettings.GetColour`.
+</docstring>
<baseclass name="Object"/>
<constructor name="Colour" overloaded="no">
- <autodoc>__init__(unsigned char red=0, unsigned char green=0, unsigned char blue=0) -> Colour</autodoc>
- <docstring>Constructs a colour from red, green and blue values.</docstring>
+ <autodoc>__init__(self, byte red=0, byte green=0, byte blue=0) -> Colour</autodoc>
+ <docstring>Constructs a colour from red, green and blue values.
+
+:see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`.
+</docstring>
<paramlist>
- <param name="red" type="unsigned char" default="0"/>
- <param name="green" type="unsigned char" default="0"/>
- <param name="blue" type="unsigned char" default="0"/>
+ <param name="red" type="byte" default="0"/>
+ <param name="green" type="byte" default="0"/>
+ <param name="blue" type="byte" default="0"/>
</paramlist>
</constructor>
<constructor name="NamedColour" overloaded="no">
<autodoc>NamedColour(String colorName) -> Colour</autodoc>
- <docstring>Constructs a colour object using a colour name listed in wx.TheColourDatabase.</docstring>
+ <docstring>Constructs a colour object using a colour name listed in
+``wx.TheColourDatabase``.</docstring>
<paramlist>
<param name="colorName" type="String" default=""/>
</paramlist>
</paramlist>
</constructor>
<destructor name="~wxColour" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
- <method name="Red" type="unsigned char" overloaded="no">
- <autodoc>Red() -> unsigned char</autodoc>
+ <method name="Red" type="byte" overloaded="no">
+ <autodoc>Red(self) -> byte</autodoc>
<docstring>Returns the red intensity.</docstring>
</method>
- <method name="Green" type="unsigned char" overloaded="no">
- <autodoc>Green() -> unsigned char</autodoc>
+ <method name="Green" type="byte" overloaded="no">
+ <autodoc>Green(self) -> byte</autodoc>
<docstring>Returns the green intensity.</docstring>
</method>
- <method name="Blue" type="unsigned char" overloaded="no">
- <autodoc>Blue() -> unsigned char</autodoc>
+ <method name="Blue" type="byte" overloaded="no">
+ <autodoc>Blue(self) -> byte</autodoc>
<docstring>Returns the blue intensity.</docstring>
</method>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
<docstring>Returns True if the colour object is valid (the colour has been
initialised with RGB values).</docstring>
</method>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(unsigned char red, unsigned char green, unsigned char blue)</autodoc>
+ <autodoc>Set(self, byte red, byte green, byte blue)</autodoc>
<docstring>Sets the RGB intensity values.</docstring>
<paramlist>
- <param name="red" type="unsigned char" default=""/>
- <param name="green" type="unsigned char" default=""/>
- <param name="blue" type="unsigned char" default=""/>
+ <param name="red" type="byte" default=""/>
+ <param name="green" type="byte" default=""/>
+ <param name="blue" type="byte" default=""/>
</paramlist>
</method>
<method name="SetRGB" type="" overloaded="no">
- <autodoc>SetRGB(unsigned long colRGB)</autodoc>
+ <autodoc>SetRGB(self, unsigned long colRGB)</autodoc>
<docstring>Sets the RGB intensity values from a packed RGB value.</docstring>
<paramlist>
<param name="colRGB" type="unsigned long" default=""/>
</paramlist>
</method>
<method name="SetFromName" type="" overloaded="no">
- <autodoc>SetFromName(String colourName)</autodoc>
- <docstring>Sets the RGB intensity values using a colour name listed in wx.TheColourDatabase.</docstring>
+ <autodoc>SetFromName(self, String colourName)</autodoc>
+ <docstring>Sets the RGB intensity values using a colour name listed in
+``wx.TheColourDatabase``.</docstring>
<paramlist>
<param name="colourName" type="String" default=""/>
</paramlist>
</method>
<method name="GetPixel" type="long" overloaded="no">
- <autodoc>GetPixel() -> long</autodoc>
+ <autodoc>GetPixel(self) -> long</autodoc>
<docstring>Returns a pixel value which is platform-dependent. On Windows, a
-COLORREF is returned. On X, an allocated pixel value is returned.
--1 is returned if the pixel is invalid (on X, unallocated).</docstring>
+COLORREF is returned. On X, an allocated pixel value is returned. -1
+is returned if the pixel is invalid (on X, unallocated).</docstring>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(Colour colour) -> bool</autodoc>
+ <autodoc>__eq__(self, Colour colour) -> bool</autodoc>
<docstring>Compare colours for equality</docstring>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(Colour colour) -> bool</autodoc>
+ <autodoc>__ne__(self, Colour colour) -> bool</autodoc>
<docstring>Compare colours for inequality</docstring>
<paramlist>
<param name="colour" type="Colour" default=""/>
<docstring>Returns the RGB intensity values as a tuple.</docstring>
</method>
<method name="GetRGB" type="unsigned long" overloaded="no">
- <autodoc>GetRGB() -> unsigned long</autodoc>
+ <autodoc>GetRGB(self) -> unsigned long</autodoc>
<docstring>Return the colour as a packed RGB value</docstring>
</method>
</class>
NamedColor = NamedColour
ColorRGB = ColourRGB
</pythoncode>
- <class name="Palette" oldname="wxPalette" module="gdi">
+ <class name="Palette" oldname="wxPalette" module="_gdi">
<baseclass name="GDIObject"/>
<constructor name="Palette" overloaded="no">
- <autodoc>__init__(int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette</autodoc>
+ <autodoc>__init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
<param name="red" type="unsigned char" default=""/>
</paramlist>
</constructor>
<destructor name="~wxPalette" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetPixel" type="int" overloaded="no">
- <autodoc>GetPixel(byte red, byte green, byte blue) -> int</autodoc>
+ <autodoc>GetPixel(self, byte red, byte green, byte blue) -> int</autodoc>
<paramlist>
<param name="red" type="byte" default=""/>
<param name="green" type="byte" default=""/>
</paramlist>
</method>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Pen" oldname="wxPen" module="gdi">
+ <class name="Pen" oldname="wxPen" module="_gdi">
<baseclass name="GDIObject"/>
<constructor name="Pen" overloaded="no">
- <autodoc>__init__(Colour colour, int width=1, int style=SOLID) -> Pen</autodoc>
+ <autodoc>__init__(self, Colour colour, int width=1, int style=SOLID) -> Pen</autodoc>
<paramlist>
<param name="colour" type="Colour" default=""/>
<param name="width" type="int" default="1"/>
</paramlist>
</constructor>
<destructor name="~wxPen" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetCap" type="int" overloaded="no">
- <autodoc>GetCap() -> int</autodoc>
+ <autodoc>GetCap(self) -> int</autodoc>
</method>
<method name="GetColour" type="Colour" overloaded="no">
- <autodoc>GetColour() -> Colour</autodoc>
+ <autodoc>GetColour(self) -> Colour</autodoc>
</method>
<method name="GetJoin" type="int" overloaded="no">
- <autodoc>GetJoin() -> int</autodoc>
+ <autodoc>GetJoin(self) -> int</autodoc>
</method>
<method name="GetStyle" type="int" overloaded="no">
- <autodoc>GetStyle() -> int</autodoc>
+ <autodoc>GetStyle(self) -> int</autodoc>
</method>
<method name="GetWidth" type="int" overloaded="no">
- <autodoc>GetWidth() -> int</autodoc>
+ <autodoc>GetWidth(self) -> int</autodoc>
</method>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
<method name="SetCap" type="" overloaded="no">
- <autodoc>SetCap(int cap_style)</autodoc>
+ <autodoc>SetCap(self, int cap_style)</autodoc>
<paramlist>
<param name="cap_style" type="int" default=""/>
</paramlist>
</method>
<method name="SetColour" type="" overloaded="no">
- <autodoc>SetColour(Colour colour)</autodoc>
+ <autodoc>SetColour(self, Colour colour)</autodoc>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetJoin" type="" overloaded="no">
- <autodoc>SetJoin(int join_style)</autodoc>
+ <autodoc>SetJoin(self, int join_style)</autodoc>
<paramlist>
<param name="join_style" type="int" default=""/>
</paramlist>
</method>
<method name="SetStyle" type="" overloaded="no">
- <autodoc>SetStyle(int style)</autodoc>
+ <autodoc>SetStyle(self, int style)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
</paramlist>
</method>
<method name="SetWidth" type="" overloaded="no">
- <autodoc>SetWidth(int width)</autodoc>
+ <autodoc>SetWidth(self, int width)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="SetDashes" type="" overloaded="no">
- <autodoc>SetDashes(int dashes, wxDash dashes_array)</autodoc>
+ <autodoc>SetDashes(self, int dashes, wxDash dashes_array)</autodoc>
<paramlist>
<param name="dashes" type="int" default=""/>
<param name="dashes_array" type="wxDash" default=""/>
</paramlist>
</method>
<method name="GetDashes" type="PyObject" overloaded="no">
- <autodoc>GetDashes() -> PyObject</autodoc>
- </method>
- <method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(Pen other) -> bool</autodoc>
- <paramlist>
- <param name="other" type="Pen" default=""/>
- </paramlist>
+ <autodoc>GetDashes(self) -> PyObject</autodoc>
</method>
- <method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(Pen other) -> bool</autodoc>
+ <method name="_SetDashes" type="" overloaded="no">
+ <autodoc>_SetDashes(self, PyObject _self, PyObject pyDashes)</autodoc>
<paramlist>
- <param name="other" type="Pen" default=""/>
+ <param name="_self" type="PyObject" default=""/>
+ <param name="pyDashes" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetDashCount" type="int" overloaded="no">
- <autodoc>GetDashCount() -> int</autodoc>
+ <autodoc>GetDashCount(self) -> int</autodoc>
</method>
- </class>
- <class name="PyPen" oldname="wxPyPen" module="gdi">
- <baseclass name="Pen"/>
- <constructor name="PyPen" overloaded="no">
- <autodoc>__init__(Colour colour, int width=1, int style=SOLID) -> PyPen</autodoc>
+ <method name="__eq__" type="bool" overloaded="no">
+ <autodoc>__eq__(self, Pen other) -> bool</autodoc>
<paramlist>
- <param name="colour" type="Colour" default=""/>
- <param name="width" type="int" default="1"/>
- <param name="style" type="int" default="wxSOLID"/>
+ <param name="other" type="Pen" default=""/>
</paramlist>
- </constructor>
- <destructor name="~wxPyPen" overloaded="no">
- <autodoc>__del__()</autodoc>
- </destructor>
- <method name="SetDashes" type="" overloaded="no">
- <autodoc>SetDashes(int dashes, wxDash dashes_array)</autodoc>
+ </method>
+ <method name="__ne__" type="bool" overloaded="no">
+ <autodoc>__ne__(self, Pen other) -> bool</autodoc>
<paramlist>
- <param name="dashes" type="int" default=""/>
- <param name="dashes_array" type="wxDash" default=""/>
+ <param name="other" type="Pen" default=""/>
</paramlist>
</method>
</class>
- <pythoncode> Pen = PyPen </pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Brush" oldname="wxBrush" module="gdi">
- <docstring>A brush is a drawing tool for filling in areas. It is used for painting the
-background of rectangles, ellipses, etc. It has a colour and a style.</docstring>
+ <class name="Brush" oldname="wxBrush" module="_gdi">
+ <docstring>A brush is a drawing tool for filling in areas. It is used for
+painting the background of rectangles, ellipses, etc. when drawing on
+a `wx.DC`. It has a colour and a style.</docstring>
<baseclass name="GDIObject"/>
<constructor name="Brush" overloaded="no">
- <autodoc>__init__(Colour colour, int style=SOLID) -> Brush</autodoc>
- <docstring>Constructs a brush from a colour object and style.</docstring>
+ <autodoc>__init__(self, Colour colour, int style=SOLID) -> Brush</autodoc>
+ <docstring>Constructs a brush from a `wx.Colour` object and a style.</docstring>
<paramlist>
<param name="colour" type="Colour" default=""/>
<param name="style" type="int" default="wxSOLID"/>
</paramlist>
</constructor>
<destructor name="~wxBrush" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetColour" type="" overloaded="no">
- <autodoc>SetColour(Colour col)</autodoc>
+ <autodoc>SetColour(self, Colour col)</autodoc>
+ <docstring>Set the brush's `wx.Colour`.</docstring>
<paramlist>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetStyle" type="" overloaded="no">
- <autodoc>SetStyle(int style)</autodoc>
+ <autodoc>SetStyle(self, int style)</autodoc>
+ <docstring>Sets the style of the brush. See `__init__` for a listing of styles.</docstring>
<paramlist>
<param name="style" type="int" default=""/>
</paramlist>
</method>
<method name="SetStipple" type="" overloaded="no">
- <autodoc>SetStipple(Bitmap stipple)</autodoc>
+ <autodoc>SetStipple(self, Bitmap stipple)</autodoc>
+ <docstring>Sets the stipple `wx.Bitmap`.</docstring>
<paramlist>
<param name="stipple" type="wxBitmap" default=""/>
</paramlist>
</method>
<method name="GetColour" type="Colour" overloaded="no">
- <autodoc>GetColour() -> Colour</autodoc>
+ <autodoc>GetColour(self) -> Colour</autodoc>
+ <docstring>Returns the `wx.Colour` of the brush.</docstring>
</method>
<method name="GetStyle" type="int" overloaded="no">
- <autodoc>GetStyle() -> int</autodoc>
+ <autodoc>GetStyle(self) -> int</autodoc>
+ <docstring>Returns the style of the brush. See `__init__` for a listing of
+styles.</docstring>
</method>
<method name="GetStipple" type="wxBitmap" overloaded="no">
- <autodoc>GetStipple() -> Bitmap</autodoc>
+ <autodoc>GetStipple(self) -> Bitmap</autodoc>
+ <docstring>Returns the stiple `wx.Bitmap` of the brush. If the brush does not
+have a wx.STIPPLE style, then the return value may be non-None but an
+uninitialised bitmap (`wx.Bitmap.Ok` returns False).</docstring>
</method>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
+ <docstring>Returns True if the brush is initialised and valid.</docstring>
</method>
</class>
- <class name="Bitmap" oldname="wxBitmap" module="gdi">
+ <class name="Bitmap" oldname="wxBitmap" module="_gdi">
+ <docstring>The wx.Bitmap class encapsulates the concept of a platform-dependent
+bitmap. It can be either monochrome or colour, and either loaded from
+a file or created dynamically. A bitmap can be selected into a memory
+device context (instance of `wx.MemoryDC`). This enables the bitmap to
+be copied to a window or memory device context using `wx.DC.Blit`, or
+to be used as a drawing surface.</docstring>
<baseclass name="GDIObject"/>
<constructor name="Bitmap" overloaded="no">
- <autodoc>__init__(String name, int type=BITMAP_TYPE_ANY) -> Bitmap</autodoc>
+ <autodoc>__init__(self, String name, int type=BITMAP_TYPE_ANY) -> Bitmap</autodoc>
<docstring>Loads a bitmap from a file.</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</constructor>
<constructor name="EmptyBitmap" overloaded="no">
<autodoc>EmptyBitmap(int width, int height, int depth=-1) -> Bitmap</autodoc>
- <docstring>Creates a new bitmap of the given size. A depth of -1 indicates the depth of
-the current screen or visual. Some platforms only support 1 for monochrome and
--1 for the current colour setting.</docstring>
+ <docstring>Creates a new bitmap of the given size. A depth of -1 indicates the
+depth of the current screen or visual. Some platforms only support 1
+for monochrome and -1 for the current colour setting.</docstring>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</constructor>
<constructor name="BitmapFromIcon" overloaded="no">
<autodoc>BitmapFromIcon(Icon icon) -> Bitmap</autodoc>
- <docstring>Create a new bitmap from an Icon object.</docstring>
+ <docstring>Create a new bitmap from a `wx.Icon` object.</docstring>
<paramlist>
<param name="icon" type="wxIcon" default=""/>
</paramlist>
</constructor>
<constructor name="BitmapFromImage" overloaded="no">
<autodoc>BitmapFromImage(Image image, int depth=-1) -> Bitmap</autodoc>
- <docstring>Creates bitmap object from the image. This has to be done to actually display
-an image as you cannot draw an image directly on a window. The resulting
-bitmap will use the provided colour depth (or that of the current system if
-depth is -1) which entails that a colour reduction has to take place.</docstring>
+ <docstring>Creates bitmap object from a `wx.Image`. This has to be done to
+actually display a `wx.Image` as you cannot draw an image directly on
+a window. The resulting bitmap will use the provided colour depth (or
+that of the current screen colour depth if depth is -1) which entails
+that a colour reduction may have to take place.</docstring>
<paramlist>
<param name="image" type="Image" default=""/>
<param name="depth" type="int" default="-1"/>
</constructor>
<constructor name="BitmapFromBits" overloaded="no">
<autodoc>BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap</autodoc>
- <docstring>Creates a bitmap from an array of bits. You should only use this function for
-monochrome bitmaps (depth 1) in portable programs: in this case the bits
-parameter should contain an XBM image. For other bit depths, the behaviour is
-platform dependent.</docstring>
+ <docstring>Creates a bitmap from an array of bits. You should only use this
+function for monochrome bitmaps (depth 1) in portable programs: in
+this case the bits parameter should contain an XBM image. For other
+bit depths, the behaviour is platform dependent.</docstring>
<paramlist>
<param name="bits" type="PyObject" default=""/>
<param name="width" type="int" default=""/>
</paramlist>
</constructor>
<destructor name="~wxBitmap" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
<method name="GetWidth" type="int" overloaded="no">
- <autodoc>GetWidth() -> int</autodoc>
+ <autodoc>GetWidth(self) -> int</autodoc>
<docstring>Gets the width of the bitmap in pixels.</docstring>
</method>
<method name="GetHeight" type="int" overloaded="no">
- <autodoc>GetHeight() -> int</autodoc>
+ <autodoc>GetHeight(self) -> int</autodoc>
<docstring>Gets the height of the bitmap in pixels.</docstring>
</method>
<method name="GetDepth" type="int" overloaded="no">
- <autodoc>GetDepth() -> int</autodoc>
+ <autodoc>GetDepth(self) -> int</autodoc>
<docstring>Gets the colour depth of the bitmap. A value of 1 indicates a
monochrome bitmap.</docstring>
</method>
+ <method name="GetSize" type="Size" overloaded="no">
+ <autodoc>GetSize(self) -> Size</autodoc>
+ <docstring>Get the size of the bitmap.</docstring>
+ </method>
<method name="ConvertToImage" type="Image" overloaded="no">
- <autodoc>ConvertToImage() -> Image</autodoc>
- <docstring>Creates a platform-independent image from a platform-dependent bitmap. This
-preserves mask information so that bitmaps and images can be converted back
-and forth without loss in that respect.</docstring>
+ <autodoc>ConvertToImage(self) -> Image</autodoc>
+ <docstring>Creates a platform-independent image from a platform-dependent
+bitmap. This preserves mask information so that bitmaps and images can
+be converted back and forth without loss in that respect.</docstring>
</method>
<method name="GetMask" type="wxMask" overloaded="no">
- <autodoc>GetMask() -> Mask</autodoc>
- <docstring>Gets the associated mask (if any) which may have been loaded from a file
-or explpicitly set for the bitmap.</docstring>
+ <autodoc>GetMask(self) -> Mask</autodoc>
+ <docstring>Gets the associated mask (if any) which may have been loaded from a
+file or explpicitly set for the bitmap.
+
+:see: `SetMask`, `wx.Mask`
+</docstring>
</method>
<method name="SetMask" type="" overloaded="no">
- <autodoc>SetMask(Mask mask)</autodoc>
- <docstring>Sets the mask for this bitmap.</docstring>
+ <autodoc>SetMask(self, Mask mask)</autodoc>
+ <docstring>Sets the mask for this bitmap.
+
+:see: `GetMask`, `wx.Mask`
+</docstring>
<paramlist>
<param name="mask" type="wxMask" default=""/>
</paramlist>
</method>
<method name="SetMaskColour" type="" overloaded="no">
- <autodoc>SetMaskColour(Colour colour)</autodoc>
+ <autodoc>SetMaskColour(self, Colour colour)</autodoc>
<docstring>Create a Mask based on a specified colour in the Bitmap.</docstring>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetSubBitmap" type="Bitmap" overloaded="no">
- <autodoc>GetSubBitmap(Rect rect) -> Bitmap</autodoc>
- <docstring>Returns a sub bitmap of the current one as long as the rect belongs entirely
-to the bitmap. This function preserves bit depth and mask information.</docstring>
+ <autodoc>GetSubBitmap(self, Rect rect) -> Bitmap</autodoc>
+ <docstring>Returns a sub-bitmap of the current one as long as the rect belongs
+entirely to the bitmap. This function preserves bit depth and mask
+information.</docstring>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="SaveFile" type="bool" overloaded="no">
- <autodoc>SaveFile(String name, int type, Palette palette=(wxPalette *) NULL) -> bool</autodoc>
- <docstring>Saves a bitmap in the named file.</docstring>
+ <autodoc>SaveFile(self, String name, int type, Palette palette=None) -> bool</autodoc>
+ <docstring>Saves a bitmap in the named file. See `__init__` for a description of
+the ``type`` parameter.</docstring>
<paramlist>
<param name="name" type="String" default=""/>
<param name="type" type="wxBitmapType" default=""/>
- <param name="palette" type="Palette" default="(wxPalette *) NULL"/>
+ <param name="palette" type="Palette" default="NULL"/>
</paramlist>
</method>
<method name="LoadFile" type="bool" overloaded="no">
- <autodoc>LoadFile(String name, int type) -> bool</autodoc>
- <docstring>Loads a bitmap from a file</docstring>
+ <autodoc>LoadFile(self, String name, int type) -> bool</autodoc>
+ <docstring>Loads a bitmap from a file. See `__init__` for a description of the
+``type`` parameter.</docstring>
<paramlist>
<param name="name" type="String" default=""/>
<param name="type" type="wxBitmapType" default=""/>
</paramlist>
</method>
<method name="CopyFromIcon" type="bool" overloaded="no">
- <autodoc>CopyFromIcon(Icon icon) -> bool</autodoc>
+ <autodoc>CopyFromIcon(self, Icon icon) -> bool</autodoc>
<paramlist>
<param name="icon" type="wxIcon" default=""/>
</paramlist>
</method>
<method name="SetHeight" type="" overloaded="no">
- <autodoc>SetHeight(int height)</autodoc>
- <docstring>Set the height property (does not affect the bitmap data).</docstring>
+ <autodoc>SetHeight(self, int height)</autodoc>
+ <docstring>Set the height property (does not affect the existing bitmap data).</docstring>
<paramlist>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="SetWidth" type="" overloaded="no">
- <autodoc>SetWidth(int width)</autodoc>
- <docstring>Set the width property (does not affect the bitmap data).</docstring>
+ <autodoc>SetWidth(self, int width)</autodoc>
+ <docstring>Set the width property (does not affect the existing bitmap data).</docstring>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="SetDepth" type="" overloaded="no">
- <autodoc>SetDepth(int depth)</autodoc>
- <docstring>Set the depth property (does not affect the bitmap data).</docstring>
+ <autodoc>SetDepth(self, int depth)</autodoc>
+ <docstring>Set the depth property (does not affect the existing bitmap data).</docstring>
<paramlist>
<param name="depth" type="int" default=""/>
</paramlist>
</method>
+ <method name="SetSize" type="" overloaded="no">
+ <autodoc>SetSize(self, Size size)</autodoc>
+ <docstring>Set the bitmap size (does not affect the existing bitmap data).</docstring>
+ <paramlist>
+ <param name="size" type="Size" default=""/>
+ </paramlist>
+ </method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(Bitmap other) -> bool</autodoc>
+ <autodoc>__eq__(self, Bitmap other) -> bool</autodoc>
<paramlist>
<param name="other" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(Bitmap other) -> bool</autodoc>
+ <autodoc>__ne__(self, Bitmap other) -> bool</autodoc>
<paramlist>
<param name="other" type="Bitmap" default=""/>
</paramlist>
</method>
</class>
- <class name="Mask" oldname="wxMask" module="gdi">
- <docstring>This class encapsulates a monochrome mask bitmap, where the masked area is
-black and the unmasked area is white. When associated with a bitmap and drawn
-in a device context, the unmasked area of the bitmap will be drawn, and the
-masked area will not be drawn.</docstring>
+ <class name="Mask" oldname="wxMask" module="_gdi">
+ <docstring>This class encapsulates a monochrome mask bitmap, where the masked
+area is black and the unmasked area is white. When associated with a
+bitmap and drawn in a device context, the unmasked area of the bitmap
+will be drawn, and the masked area will not be drawn.
+
+A mask may be associated with a `wx.Bitmap`. It is used in
+`wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
+`wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
+mask.</docstring>
<baseclass name="Object"/>
<constructor name="Mask" overloaded="no">
- <autodoc>__init__(Bitmap bitmap, Colour colour=NullColour) -> Mask</autodoc>
- <docstring>Constructs a mask from a bitmap and a colour in that bitmap that indicates
-the transparent portions of the mask, by default BLACK is used.</docstring>
+ <autodoc>__init__(self, Bitmap bitmap, Colour colour=NullColour) -> Mask</autodoc>
+ <docstring>Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
+that indicates the transparent portions of the mask. In other words,
+the pixels in ``bitmap`` that match ``colour`` will be the transparent
+portions of the mask. If no ``colour`` or an invalid ``colour`` is
+passed then BLACK is used.
+
+:see: `wx.Bitmap`, `wx.Colour`</docstring>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
<param name="colour" type="Colour" default="wxNullColour"/>
</paramlist>
</constructor>
</class>
- <pythoncode> MaskColour = Mask </pythoncode>
- <class name="Icon" oldname="wxIcon" module="gdi">
+ <pythoncode> MaskColour = wx._deprecated(Mask, "wx.MaskColour is deprecated, use `wx.Mask` instead.") </pythoncode>
+ <class name="Icon" oldname="wxIcon" module="_gdi">
<baseclass name="GDIObject"/>
<constructor name="Icon" overloaded="no">
- <autodoc>__init__(String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon</autodoc>
+ <autodoc>__init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="type" type="wxBitmapType" default=""/>
</paramlist>
</constructor>
<destructor name="~wxIcon" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="LoadFile" type="bool" overloaded="no">
- <autodoc>LoadFile(String name, int type) -> bool</autodoc>
+ <autodoc>LoadFile(self, String name, int type) -> bool</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="type" type="wxBitmapType" default=""/>
</paramlist>
</method>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
<method name="GetWidth" type="int" overloaded="no">
- <autodoc>GetWidth() -> int</autodoc>
+ <autodoc>GetWidth(self) -> int</autodoc>
</method>
<method name="GetHeight" type="int" overloaded="no">
- <autodoc>GetHeight() -> int</autodoc>
+ <autodoc>GetHeight(self) -> int</autodoc>
</method>
<method name="GetDepth" type="int" overloaded="no">
- <autodoc>GetDepth() -> int</autodoc>
+ <autodoc>GetDepth(self) -> int</autodoc>
</method>
<method name="SetWidth" type="" overloaded="no">
- <autodoc>SetWidth(int w)</autodoc>
+ <autodoc>SetWidth(self, int w)</autodoc>
<paramlist>
<param name="w" type="int" default=""/>
</paramlist>
</method>
<method name="SetHeight" type="" overloaded="no">
- <autodoc>SetHeight(int h)</autodoc>
+ <autodoc>SetHeight(self, int h)</autodoc>
<paramlist>
<param name="h" type="int" default=""/>
</paramlist>
</method>
<method name="SetDepth" type="" overloaded="no">
- <autodoc>SetDepth(int d)</autodoc>
+ <autodoc>SetDepth(self, int d)</autodoc>
<paramlist>
<param name="d" type="int" default=""/>
</paramlist>
</method>
<method name="CopyFromBitmap" type="" overloaded="no">
- <autodoc>CopyFromBitmap(Bitmap bmp)</autodoc>
+ <autodoc>CopyFromBitmap(self, Bitmap bmp)</autodoc>
<paramlist>
<param name="bmp" type="Bitmap" default=""/>
</paramlist>
</method>
</class>
- <class name="IconLocation" oldname="wxIconLocation" module="gdi">
+ <class name="IconLocation" oldname="wxIconLocation" module="_gdi">
<constructor name="IconLocation" overloaded="no">
- <autodoc>__init__(String filename=&wxPyEmptyString, int num=0) -> IconLocation</autodoc>
+ <autodoc>__init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation</autodoc>
<paramlist>
<param name="filename" type="String" default="&wxPyEmptyString"/>
<param name="num" type="int" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxIconLocation" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="IsOk" type="bool" overloaded="no">
- <autodoc>IsOk() -> bool</autodoc>
+ <autodoc>IsOk(self) -> bool</autodoc>
</method>
<method name="SetFileName" type="" overloaded="no">
- <autodoc>SetFileName(String filename)</autodoc>
+ <autodoc>SetFileName(self, String filename)</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
</paramlist>
</method>
<method name="GetFileName" type="String" overloaded="no">
- <autodoc>GetFileName() -> String</autodoc>
+ <autodoc>GetFileName(self) -> String</autodoc>
</method>
<method name="SetIndex" type="" overloaded="no">
- <autodoc>SetIndex(int num)</autodoc>
+ <autodoc>SetIndex(self, int num)</autodoc>
<paramlist>
<param name="num" type="int" default=""/>
</paramlist>
</method>
<method name="GetIndex" type="int" overloaded="no">
- <autodoc>GetIndex() -> int</autodoc>
+ <autodoc>GetIndex(self) -> int</autodoc>
</method>
</class>
- <class name="IconBundle" oldname="wxIconBundle" module="gdi">
+ <class name="IconBundle" oldname="wxIconBundle" module="_gdi">
<constructor name="IconBundle" overloaded="no">
- <autodoc>__init__() -> IconBundle</autodoc>
+ <autodoc>__init__(self) -> IconBundle</autodoc>
</constructor>
<constructor name="IconBundleFromFile" overloaded="no">
<autodoc>IconBundleFromFile(String file, long type) -> IconBundle</autodoc>
</paramlist>
</constructor>
<destructor name="~wxIconBundle" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="AddIcon" type="" overloaded="no">
- <autodoc>AddIcon(Icon icon)</autodoc>
+ <autodoc>AddIcon(self, Icon icon)</autodoc>
<paramlist>
<param name="icon" type="Icon" default=""/>
</paramlist>
</method>
<method name="AddIconFromFile" type="" overloaded="no">
- <autodoc>AddIconFromFile(String file, long type)</autodoc>
+ <autodoc>AddIconFromFile(self, String file, long type)</autodoc>
<paramlist>
<param name="file" type="String" default=""/>
<param name="type" type="long" default=""/>
</paramlist>
</method>
<method name="GetIcon" type="Icon" overloaded="no">
- <autodoc>GetIcon(Size size) -> Icon</autodoc>
+ <autodoc>GetIcon(self, Size size) -> Icon</autodoc>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
</class>
- <class name="Cursor" oldname="wxCursor" module="gdi">
- <docstring>A cursor is a small bitmap usually used for denoting where the
-mouse pointer is, with a picture that might indicate the
-interpretation of a mouse click.
+ <class name="Cursor" oldname="wxCursor" module="_gdi">
+ <docstring>A cursor is a small bitmap usually used for denoting where the mouse
+pointer is, with a picture that might indicate the interpretation of a
+mouse click.
A single cursor object may be used in many windows (any subwindow
-type). The wxWindows convention is to set the cursor for a
-window, as in X, rather than to set it globally as in MS Windows,
-although a global wx.SetCursor function is also available for use
-on MS Windows.</docstring>
+type). The wxWindows convention is to set the cursor for a window, as
+in X, rather than to set it globally as in MS Windows, although a
+global `wx.SetCursor` function is also available for use on MS Windows.
+</docstring>
<baseclass name="GDIObject"/>
<constructor name="Cursor" overloaded="no">
- <autodoc>__init__(String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor</autodoc>
+ <autodoc>__init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor</autodoc>
<docstring>Construct a Cursor from a file. Specify the type of file using
-wx.BITAMP_TYPE* constants, and specify the hotspot if not using a
-.cur file.
+wx.BITAMP_TYPE* constants, and specify the hotspot if not using a cur
+file.
-This cursor is not available on wxGTK, use wx.StockCursor,
-wx.CursorFromImage, or wx.CursorFromBits instead.</docstring>
+This constructor is not available on wxGTK, use ``wx.StockCursor``,
+``wx.CursorFromImage``, or ``wx.CursorFromBits`` instead.</docstring>
<paramlist>
<param name="cursorName" type="String" default=""/>
<param name="type" type="long" default=""/>
</constructor>
<constructor name="StockCursor" overloaded="no">
<autodoc>StockCursor(int id) -> Cursor</autodoc>
- <docstring>Create a cursor using one of the stock cursors. Note that not
-all cursors are available on all platforms.</docstring>
- <refdoc>
- Stock Cursor IDs
-
- wx.CURSOR_ARROW A standard arrow cursor.
- wx.CURSOR_RIGHT_ARROW A standard arrow cursor pointing to the right.
- wx.CURSOR_BLANK Transparent cursor.
- wx.CURSOR_BULLSEYE Bullseye cursor.
- wx.CURSOR_CHAR Rectangular character cursor.
- wx.CURSOR_CROSS A cross cursor.
- wx.CURSOR_HAND A hand cursor.
- wx.CURSOR_IBEAM An I-beam cursor (vertical line).
- wx.CURSOR_LEFT_BUTTON Represents a mouse with the left button depressed.
- wx.CURSOR_MAGNIFIER A magnifier icon.
- wx.CURSOR_MIDDLE_BUTTON Represents a mouse with the middle button depressed.
- wx.CURSOR_NO_ENTRY A no-entry sign cursor.
- wx.CURSOR_PAINT_BRUSH A paintbrush cursor.
- wx.CURSOR_PENCIL A pencil cursor.
- wx.CURSOR_POINT_LEFT A cursor that points left.
- wx.CURSOR_POINT_RIGHT A cursor that points right.
- wx.CURSOR_QUESTION_ARROW An arrow and question mark.
- wx.CURSOR_RIGHT_BUTTON Represents a mouse with the right button depressed.
- wx.CURSOR_SIZENESW A sizing cursor pointing NE-SW.
- wx.CURSOR_SIZENS A sizing cursor pointing N-S.
- wx.CURSOR_SIZENWSE A sizing cursor pointing NW-SE.
- wx.CURSOR_SIZEWE A sizing cursor pointing W-E.
- wx.CURSOR_SIZING A general sizing cursor.
- wx.CURSOR_SPRAYCAN A spraycan cursor.
- wx.CURSOR_WAIT A wait cursor.
- wx.CURSOR_WATCH A watch cursor.
- wx.CURSOR_ARROWWAIT A cursor with both an arrow and an hourglass, (windows.)
-
-</refdoc>
+ <docstring>Create a cursor using one of the stock cursors. Note that not all
+cursors are available on all platforms.</docstring>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</constructor>
<constructor name="CursorFromImage" overloaded="no">
<autodoc>CursorFromImage(Image image) -> Cursor</autodoc>
- <docstring>Constructs a cursor from a wxImage. The cursor is monochrome,
-colors with the RGB elements all greater than 127 will be
-foreground, colors less than this background. The mask (if any)
-will be used as transparent.
-
-In MSW the foreground will be white and the background black. The
-cursor is resized to 32x32 In GTK, the two most frequent colors
-will be used for foreground and background. The cursor will be
-displayed at the size of the image. On MacOS the cursor is
-resized to 16x16 and currently only shown as black/white (mask
-respected).</docstring>
+ <docstring>Constructs a cursor from a wxImage. The cursor is monochrome, colors
+with the RGB elements all greater than 127 will be foreground, colors
+less than this background. The mask (if any) will be used as
+transparent.</docstring>
<paramlist>
<param name="image" type="Image" default=""/>
</paramlist>
</constructor>
<destructor name="~wxCursor" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Region" oldname="wxRegion" module="gdi">
+ <class name="Region" oldname="wxRegion" module="_gdi">
<baseclass name="GDIObject"/>
<constructor name="Region" overloaded="no">
- <autodoc>__init__(int x=0, int y=0, int width=0, int height=0) -> Region</autodoc>
+ <autodoc>__init__(self, int x=0, int y=0, int width=0, int height=0) -> Region</autodoc>
<paramlist>
<param name="x" type="int" default="0"/>
<param name="y" type="int" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxRegion" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear()</autodoc>
+ <autodoc>Clear(self)</autodoc>
</method>
<method name="Offset" type="bool" overloaded="no">
- <autodoc>Offset(int x, int y) -> bool</autodoc>
+ <autodoc>Offset(self, int x, int y) -> bool</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="Contains" type="wxRegionContain" overloaded="no">
- <autodoc>Contains(int x, int y) -> int</autodoc>
+ <autodoc>Contains(self, int x, int y) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="ContainsPoint" type="wxRegionContain" overloaded="no">
- <autodoc>ContainsPoint(Point pt) -> int</autodoc>
+ <autodoc>ContainsPoint(self, Point pt) -> int</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="ContainsRect" type="wxRegionContain" overloaded="no">
- <autodoc>ContainsRect(Rect rect) -> int</autodoc>
+ <autodoc>ContainsRect(self, Rect rect) -> int</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="ContainsRectDim" type="wxRegionContain" overloaded="no">
- <autodoc>ContainsRectDim(int x, int y, int w, int h) -> int</autodoc>
+ <autodoc>ContainsRectDim(self, int x, int y, int w, int h) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="GetBox" type="Rect" overloaded="no">
- <autodoc>GetBox() -> Rect</autodoc>
+ <autodoc>GetBox(self) -> Rect</autodoc>
</method>
<method name="Intersect" type="bool" overloaded="no">
- <autodoc>Intersect(int x, int y, int width, int height) -> bool</autodoc>
+ <autodoc>Intersect(self, int x, int y, int width, int height) -> bool</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="IntersectRect" type="bool" overloaded="no">
- <autodoc>IntersectRect(Rect rect) -> bool</autodoc>
+ <autodoc>IntersectRect(self, Rect rect) -> bool</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="IntersectRegion" type="bool" overloaded="no">
- <autodoc>IntersectRegion(Region region) -> bool</autodoc>
+ <autodoc>IntersectRegion(self, Region region) -> bool</autodoc>
<paramlist>
<param name="region" type="Region" default=""/>
</paramlist>
</method>
<method name="IsEmpty" type="bool" overloaded="no">
- <autodoc>IsEmpty() -> bool</autodoc>
+ <autodoc>IsEmpty(self) -> bool</autodoc>
</method>
<method name="Union" type="bool" overloaded="no">
- <autodoc>Union(int x, int y, int width, int height) -> bool</autodoc>
+ <autodoc>Union(self, int x, int y, int width, int height) -> bool</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="UnionRect" type="bool" overloaded="no">
- <autodoc>UnionRect(Rect rect) -> bool</autodoc>
+ <autodoc>UnionRect(self, Rect rect) -> bool</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="UnionRegion" type="bool" overloaded="no">
- <autodoc>UnionRegion(Region region) -> bool</autodoc>
+ <autodoc>UnionRegion(self, Region region) -> bool</autodoc>
<paramlist>
<param name="region" type="Region" default=""/>
</paramlist>
</method>
<method name="Subtract" type="bool" overloaded="no">
- <autodoc>Subtract(int x, int y, int width, int height) -> bool</autodoc>
+ <autodoc>Subtract(self, int x, int y, int width, int height) -> bool</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="SubtractRect" type="bool" overloaded="no">
- <autodoc>SubtractRect(Rect rect) -> bool</autodoc>
+ <autodoc>SubtractRect(self, Rect rect) -> bool</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="SubtractRegion" type="bool" overloaded="no">
- <autodoc>SubtractRegion(Region region) -> bool</autodoc>
+ <autodoc>SubtractRegion(self, Region region) -> bool</autodoc>
<paramlist>
<param name="region" type="Region" default=""/>
</paramlist>
</method>
<method name="Xor" type="bool" overloaded="no">
- <autodoc>Xor(int x, int y, int width, int height) -> bool</autodoc>
+ <autodoc>Xor(self, int x, int y, int width, int height) -> bool</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="XorRect" type="bool" overloaded="no">
- <autodoc>XorRect(Rect rect) -> bool</autodoc>
+ <autodoc>XorRect(self, Rect rect) -> bool</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="XorRegion" type="bool" overloaded="no">
- <autodoc>XorRegion(Region region) -> bool</autodoc>
+ <autodoc>XorRegion(self, Region region) -> bool</autodoc>
<paramlist>
<param name="region" type="Region" default=""/>
</paramlist>
</method>
<method name="ConvertToBitmap" type="Bitmap" overloaded="no">
- <autodoc>ConvertToBitmap() -> Bitmap</autodoc>
+ <autodoc>ConvertToBitmap(self) -> Bitmap</autodoc>
</method>
<method name="UnionBitmap" type="bool" overloaded="no">
- <autodoc>UnionBitmap(Bitmap bmp, Colour transColour=NullColour, int tolerance=0) -> bool</autodoc>
+ <autodoc>UnionBitmap(self, Bitmap bmp, Colour transColour=NullColour, int tolerance=0) -> bool</autodoc>
<paramlist>
<param name="bmp" type="Bitmap" default=""/>
<param name="transColour" type="Colour" default="wxNullColour"/>
</paramlist>
</method>
</class>
- <class name="RegionIterator" oldname="wxRegionIterator" module="gdi">
+ <class name="RegionIterator" oldname="wxRegionIterator" module="_gdi">
<baseclass name="Object"/>
<constructor name="RegionIterator" overloaded="no">
- <autodoc>__init__(Region region) -> RegionIterator</autodoc>
+ <autodoc>__init__(self, Region region) -> RegionIterator</autodoc>
<paramlist>
<param name="region" type="Region" default=""/>
</paramlist>
</constructor>
<destructor name="~wxRegionIterator" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetX" type="int" overloaded="no">
- <autodoc>GetX() -> int</autodoc>
+ <autodoc>GetX(self) -> int</autodoc>
</method>
<method name="GetY" type="int" overloaded="no">
- <autodoc>GetY() -> int</autodoc>
+ <autodoc>GetY(self) -> int</autodoc>
</method>
<method name="GetW" type="int" overloaded="no">
- <autodoc>GetW() -> int</autodoc>
+ <autodoc>GetW(self) -> int</autodoc>
</method>
<method name="GetWidth" type="int" overloaded="no">
- <autodoc>GetWidth() -> int</autodoc>
+ <autodoc>GetWidth(self) -> int</autodoc>
</method>
<method name="GetH" type="int" overloaded="no">
- <autodoc>GetH() -> int</autodoc>
+ <autodoc>GetH(self) -> int</autodoc>
</method>
<method name="GetHeight" type="int" overloaded="no">
- <autodoc>GetHeight() -> int</autodoc>
+ <autodoc>GetHeight(self) -> int</autodoc>
</method>
<method name="GetRect" type="Rect" overloaded="no">
- <autodoc>GetRect() -> Rect</autodoc>
+ <autodoc>GetRect(self) -> Rect</autodoc>
</method>
<method name="HaveRects" type="bool" overloaded="no">
- <autodoc>HaveRects() -> bool</autodoc>
+ <autodoc>HaveRects(self) -> bool</autodoc>
</method>
<method name="Reset" type="" overloaded="no">
- <autodoc>Reset()</autodoc>
+ <autodoc>Reset(self)</autodoc>
</method>
<method name="Next" type="" overloaded="no">
- <autodoc>Next()</autodoc>
+ <autodoc>Next(self)</autodoc>
</method>
<method name="__nonzero__" type="bool" overloaded="no">
- <autodoc>__nonzero__() -> bool</autodoc>
+ <autodoc>__nonzero__(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="NativeFontInfo" oldname="wxNativeFontInfo" module="gdi">
+ <class name="NativeFontInfo" oldname="wxNativeFontInfo" module="_gdi">
<constructor name="NativeFontInfo" overloaded="no">
- <autodoc>__init__() -> NativeFontInfo</autodoc>
+ <autodoc>__init__(self) -> NativeFontInfo</autodoc>
</constructor>
<destructor name="~wxNativeFontInfo" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Init" type="" overloaded="no">
- <autodoc>Init()</autodoc>
+ <autodoc>Init(self)</autodoc>
</method>
<method name="InitFromFont" type="" overloaded="no">
- <autodoc>InitFromFont(Font font)</autodoc>
+ <autodoc>InitFromFont(self, Font font)</autodoc>
<paramlist>
<param name="font" type="wxFont" default=""/>
</paramlist>
</method>
<method name="GetPointSize" type="int" overloaded="no">
- <autodoc>GetPointSize() -> int</autodoc>
+ <autodoc>GetPointSize(self) -> int</autodoc>
</method>
<method name="GetStyle" type="wxFontStyle" overloaded="no">
- <autodoc>GetStyle() -> int</autodoc>
+ <autodoc>GetStyle(self) -> int</autodoc>
</method>
<method name="GetWeight" type="wxFontWeight" overloaded="no">
- <autodoc>GetWeight() -> int</autodoc>
+ <autodoc>GetWeight(self) -> int</autodoc>
</method>
<method name="GetUnderlined" type="bool" overloaded="no">
- <autodoc>GetUnderlined() -> bool</autodoc>
+ <autodoc>GetUnderlined(self) -> bool</autodoc>
</method>
<method name="GetFaceName" type="String" overloaded="no">
- <autodoc>GetFaceName() -> String</autodoc>
+ <autodoc>GetFaceName(self) -> String</autodoc>
</method>
<method name="GetFamily" type="wxFontFamily" overloaded="no">
- <autodoc>GetFamily() -> int</autodoc>
+ <autodoc>GetFamily(self) -> int</autodoc>
</method>
<method name="GetEncoding" type="wxFontEncoding" overloaded="no">
- <autodoc>GetEncoding() -> int</autodoc>
+ <autodoc>GetEncoding(self) -> int</autodoc>
</method>
<method name="SetPointSize" type="" overloaded="no">
- <autodoc>SetPointSize(int pointsize)</autodoc>
+ <autodoc>SetPointSize(self, int pointsize)</autodoc>
<paramlist>
<param name="pointsize" type="int" default=""/>
</paramlist>
</method>
<method name="SetStyle" type="" overloaded="no">
- <autodoc>SetStyle(int style)</autodoc>
+ <autodoc>SetStyle(self, int style)</autodoc>
<paramlist>
<param name="style" type="wxFontStyle" default=""/>
</paramlist>
</method>
<method name="SetWeight" type="" overloaded="no">
- <autodoc>SetWeight(int weight)</autodoc>
+ <autodoc>SetWeight(self, int weight)</autodoc>
<paramlist>
<param name="weight" type="wxFontWeight" default=""/>
</paramlist>
</method>
<method name="SetUnderlined" type="" overloaded="no">
- <autodoc>SetUnderlined(bool underlined)</autodoc>
+ <autodoc>SetUnderlined(self, bool underlined)</autodoc>
<paramlist>
<param name="underlined" type="bool" default=""/>
</paramlist>
</method>
<method name="SetFaceName" type="" overloaded="no">
- <autodoc>SetFaceName(String facename)</autodoc>
+ <autodoc>SetFaceName(self, String facename)</autodoc>
<paramlist>
<param name="facename" type="String" default=""/>
</paramlist>
</method>
<method name="SetFamily" type="" overloaded="no">
- <autodoc>SetFamily(int family)</autodoc>
+ <autodoc>SetFamily(self, int family)</autodoc>
<paramlist>
<param name="family" type="wxFontFamily" default=""/>
</paramlist>
</method>
<method name="SetEncoding" type="" overloaded="no">
- <autodoc>SetEncoding(int encoding)</autodoc>
+ <autodoc>SetEncoding(self, int encoding)</autodoc>
<paramlist>
<param name="encoding" type="wxFontEncoding" default=""/>
</paramlist>
</method>
<method name="FromString" type="bool" overloaded="no">
- <autodoc>FromString(String s) -> bool</autodoc>
+ <autodoc>FromString(self, String s) -> bool</autodoc>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="ToString" type="String" overloaded="no">
- <autodoc>ToString() -> String</autodoc>
+ <autodoc>ToString(self) -> String</autodoc>
</method>
<method name="__str__" type="String" overloaded="no">
- <autodoc>__str__() -> String</autodoc>
+ <autodoc>__str__(self) -> String</autodoc>
</method>
<method name="FromUserString" type="bool" overloaded="no">
- <autodoc>FromUserString(String s) -> bool</autodoc>
+ <autodoc>FromUserString(self, String s) -> bool</autodoc>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="ToUserString" type="String" overloaded="no">
- <autodoc>ToUserString() -> String</autodoc>
+ <autodoc>ToUserString(self) -> String</autodoc>
</method>
</class>
- <class name="NativeEncodingInfo" oldname="wxNativeEncodingInfo" module="gdi">
+ <class name="NativeEncodingInfo" oldname="wxNativeEncodingInfo" module="_gdi">
<constructor name="NativeEncodingInfo" overloaded="no">
- <autodoc>__init__() -> NativeEncodingInfo</autodoc>
+ <autodoc>__init__(self) -> NativeEncodingInfo</autodoc>
</constructor>
<destructor name="~wxNativeEncodingInfo" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<property name="facename" type="String" readonly="no"/>
<property name="encoding" type="wxFontEncoding" readonly="no"/>
<method name="FromString" type="bool" overloaded="no">
- <autodoc>FromString(String s) -> bool</autodoc>
+ <autodoc>FromString(self, String s) -> bool</autodoc>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="ToString" type="String" overloaded="no">
- <autodoc>ToString() -> String</autodoc>
+ <autodoc>ToString(self) -> String</autodoc>
</method>
</class>
<method name="GetNativeFontEncoding" oldname="wxGetNativeFontEncoding" type="NativeEncodingInfo" overloaded="no">
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="FontMapper" oldname="wxFontMapper" module="gdi">
+ <class name="FontMapper" oldname="wxFontMapper" module="_gdi">
<constructor name="FontMapper" overloaded="no">
- <autodoc>__init__() -> FontMapper</autodoc>
+ <autodoc>__init__(self) -> FontMapper</autodoc>
</constructor>
<destructor name="~wxFontMapper" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<staticmethod name="Get" type="FontMapper" overloaded="no">
<autodoc>Get() -> FontMapper</autodoc>
</paramlist>
</staticmethod>
<method name="CharsetToEncoding" type="wxFontEncoding" overloaded="no">
- <autodoc>CharsetToEncoding(String charset, bool interactive=True) -> int</autodoc>
+ <autodoc>CharsetToEncoding(self, String charset, bool interactive=True) -> int</autodoc>
<paramlist>
<param name="charset" type="String" default=""/>
<param name="interactive" type="bool" default="True"/>
<param name="encoding" type="wxFontEncoding" default=""/>
</paramlist>
</staticmethod>
+ <staticmethod name="GetEncodingFromName" type="wxFontEncoding" overloaded="no">
+ <autodoc>GetEncodingFromName(String name) -> int</autodoc>
+ <paramlist>
+ <param name="name" type="String" default=""/>
+ </paramlist>
+ </staticmethod>
<method name="SetConfig" type="" overloaded="no">
- <autodoc>SetConfig(ConfigBase config)</autodoc>
+ <autodoc>SetConfig(self, ConfigBase config)</autodoc>
<paramlist>
<param name="config" type="wxConfigBase" default=""/>
</paramlist>
</method>
<method name="SetConfigPath" type="" overloaded="no">
- <autodoc>SetConfigPath(String prefix)</autodoc>
+ <autodoc>SetConfigPath(self, String prefix)</autodoc>
<paramlist>
<param name="prefix" type="String" default=""/>
</paramlist>
<autodoc>GetDefaultConfigPath() -> String</autodoc>
</staticmethod>
<method name="GetAltForEncoding" type="PyObject" overloaded="no">
- <autodoc>GetAltForEncoding(int encoding, String facename=EmptyString, bool interactive=True) -> PyObject</autodoc>
+ <autodoc>GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject</autodoc>
<paramlist>
<param name="encoding" type="wxFontEncoding" default=""/>
<param name="facename" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="IsEncodingAvailable" type="bool" overloaded="no">
- <autodoc>IsEncodingAvailable(int encoding, String facename=EmptyString) -> bool</autodoc>
+ <autodoc>IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool</autodoc>
<paramlist>
<param name="encoding" type="wxFontEncoding" default=""/>
<param name="facename" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="SetDialogParent" type="" overloaded="no">
- <autodoc>SetDialogParent(Window parent)</autodoc>
+ <autodoc>SetDialogParent(self, Window parent)</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="SetDialogTitle" type="" overloaded="no">
- <autodoc>SetDialogTitle(String title)</autodoc>
+ <autodoc>SetDialogTitle(self, String title)</autodoc>
<paramlist>
<param name="title" type="String" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Font" oldname="wxFont" module="gdi">
+ <class name="Font" oldname="wxFont" module="_gdi">
<baseclass name="GDIObject"/>
<constructor name="Font" overloaded="no">
- <autodoc>__init__(int pointSize, int family, int style, int weight, bool underline=False,
+ <autodoc>__init__(self, int pointSize, int family, int style, int weight, bool underline=False,
String face=EmptyString,
int encoding=FONTENCODING_DEFAULT) -> Font</autodoc>
<paramlist>
</paramlist>
</constructor>
<destructor name="~wxFont" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(Font other) -> bool</autodoc>
+ <autodoc>__eq__(self, Font other) -> bool</autodoc>
<paramlist>
<param name="other" type="Font" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(Font other) -> bool</autodoc>
+ <autodoc>__ne__(self, Font other) -> bool</autodoc>
<paramlist>
<param name="other" type="Font" default=""/>
</paramlist>
</method>
<method name="GetPointSize" type="int" overloaded="no">
- <autodoc>GetPointSize() -> int</autodoc>
+ <autodoc>GetPointSize(self) -> int</autodoc>
</method>
<method name="GetFamily" type="int" overloaded="no">
- <autodoc>GetFamily() -> int</autodoc>
+ <autodoc>GetFamily(self) -> int</autodoc>
</method>
<method name="GetStyle" type="int" overloaded="no">
- <autodoc>GetStyle() -> int</autodoc>
+ <autodoc>GetStyle(self) -> int</autodoc>
</method>
<method name="GetWeight" type="int" overloaded="no">
- <autodoc>GetWeight() -> int</autodoc>
+ <autodoc>GetWeight(self) -> int</autodoc>
</method>
<method name="GetUnderlined" type="bool" overloaded="no">
- <autodoc>GetUnderlined() -> bool</autodoc>
+ <autodoc>GetUnderlined(self) -> bool</autodoc>
</method>
<method name="GetFaceName" type="String" overloaded="no">
- <autodoc>GetFaceName() -> String</autodoc>
+ <autodoc>GetFaceName(self) -> String</autodoc>
</method>
<method name="GetEncoding" type="wxFontEncoding" overloaded="no">
- <autodoc>GetEncoding() -> int</autodoc>
+ <autodoc>GetEncoding(self) -> int</autodoc>
</method>
<method name="GetNativeFontInfo" type="NativeFontInfo" overloaded="no">
- <autodoc>GetNativeFontInfo() -> NativeFontInfo</autodoc>
+ <autodoc>GetNativeFontInfo(self) -> NativeFontInfo</autodoc>
</method>
<method name="IsFixedWidth" type="bool" overloaded="no">
- <autodoc>IsFixedWidth() -> bool</autodoc>
+ <autodoc>IsFixedWidth(self) -> bool</autodoc>
</method>
<method name="GetNativeFontInfoDesc" type="String" overloaded="no">
- <autodoc>GetNativeFontInfoDesc() -> String</autodoc>
+ <autodoc>GetNativeFontInfoDesc(self) -> String</autodoc>
</method>
<method name="GetNativeFontInfoUserDesc" type="String" overloaded="no">
- <autodoc>GetNativeFontInfoUserDesc() -> String</autodoc>
+ <autodoc>GetNativeFontInfoUserDesc(self) -> String</autodoc>
</method>
<method name="SetPointSize" type="" overloaded="no">
- <autodoc>SetPointSize(int pointSize)</autodoc>
+ <autodoc>SetPointSize(self, int pointSize)</autodoc>
<paramlist>
<param name="pointSize" type="int" default=""/>
</paramlist>
</method>
<method name="SetFamily" type="" overloaded="no">
- <autodoc>SetFamily(int family)</autodoc>
+ <autodoc>SetFamily(self, int family)</autodoc>
<paramlist>
<param name="family" type="int" default=""/>
</paramlist>
</method>
<method name="SetStyle" type="" overloaded="no">
- <autodoc>SetStyle(int style)</autodoc>
+ <autodoc>SetStyle(self, int style)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
</paramlist>
</method>
<method name="SetWeight" type="" overloaded="no">
- <autodoc>SetWeight(int weight)</autodoc>
+ <autodoc>SetWeight(self, int weight)</autodoc>
<paramlist>
<param name="weight" type="int" default=""/>
</paramlist>
</method>
<method name="SetFaceName" type="" overloaded="no">
- <autodoc>SetFaceName(String faceName)</autodoc>
+ <autodoc>SetFaceName(self, String faceName)</autodoc>
<paramlist>
<param name="faceName" type="String" default=""/>
</paramlist>
</method>
<method name="SetUnderlined" type="" overloaded="no">
- <autodoc>SetUnderlined(bool underlined)</autodoc>
+ <autodoc>SetUnderlined(self, bool underlined)</autodoc>
<paramlist>
<param name="underlined" type="bool" default=""/>
</paramlist>
</method>
<method name="SetEncoding" type="" overloaded="no">
- <autodoc>SetEncoding(int encoding)</autodoc>
+ <autodoc>SetEncoding(self, int encoding)</autodoc>
<paramlist>
<param name="encoding" type="wxFontEncoding" default=""/>
</paramlist>
</method>
<method name="SetNativeFontInfo" type="" overloaded="no">
- <autodoc>SetNativeFontInfo(NativeFontInfo info)</autodoc>
+ <autodoc>SetNativeFontInfo(self, NativeFontInfo info)</autodoc>
<paramlist>
<param name="info" type="NativeFontInfo" default=""/>
</paramlist>
</method>
<method name="SetNativeFontInfoFromString" type="" overloaded="no">
- <autodoc>SetNativeFontInfoFromString(String info)</autodoc>
+ <autodoc>SetNativeFontInfoFromString(self, String info)</autodoc>
<paramlist>
<param name="info" type="String" default=""/>
</paramlist>
</method>
<method name="SetNativeFontInfoUserDesc" type="" overloaded="no">
- <autodoc>SetNativeFontInfoUserDesc(String info)</autodoc>
+ <autodoc>SetNativeFontInfoUserDesc(self, String info)</autodoc>
<paramlist>
<param name="info" type="String" default=""/>
</paramlist>
</method>
<method name="GetFamilyString" type="String" overloaded="no">
- <autodoc>GetFamilyString() -> String</autodoc>
+ <autodoc>GetFamilyString(self) -> String</autodoc>
</method>
<method name="GetStyleString" type="String" overloaded="no">
- <autodoc>GetStyleString() -> String</autodoc>
+ <autodoc>GetStyleString(self) -> String</autodoc>
</method>
<method name="GetWeightString" type="String" overloaded="no">
- <autodoc>GetWeightString() -> String</autodoc>
+ <autodoc>GetWeightString(self) -> String</autodoc>
</method>
<method name="SetNoAntiAliasing" type="" overloaded="no">
- <autodoc>SetNoAntiAliasing(bool no=True)</autodoc>
+ <autodoc>SetNoAntiAliasing(self, bool no=True)</autodoc>
<paramlist>
<param name="no" type="bool" default="True"/>
</paramlist>
</method>
<method name="GetNoAntiAliasing" type="bool" overloaded="no">
- <autodoc>GetNoAntiAliasing() -> bool</autodoc>
+ <autodoc>GetNoAntiAliasing(self) -> bool</autodoc>
</method>
<staticmethod name="GetDefaultEncoding" type="wxFontEncoding" overloaded="no">
<autodoc>GetDefaultEncoding() -> int</autodoc>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="FontEnumerator" oldname="wxPyFontEnumerator" module="gdi">
+ <class name="FontEnumerator" oldname="wxPyFontEnumerator" module="_gdi">
<constructor name="wxPyFontEnumerator" overloaded="no">
- <autodoc>__init__() -> FontEnumerator</autodoc>
+ <autodoc>__init__(self) -> FontEnumerator</autodoc>
</constructor>
<destructor name="~wxPyFontEnumerator" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class, bool incref)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="EnumerateFacenames" type="bool" overloaded="no">
- <autodoc>EnumerateFacenames(int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool</autodoc>
+ <autodoc>EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool</autodoc>
<paramlist>
<param name="encoding" type="wxFontEncoding" default="wxFONTENCODING_SYSTEM"/>
<param name="fixedWidthOnly" type="bool" default="False"/>
</paramlist>
</method>
<method name="EnumerateEncodings" type="bool" overloaded="no">
- <autodoc>EnumerateEncodings(String facename=EmptyString) -> bool</autodoc>
+ <autodoc>EnumerateEncodings(self, String facename=EmptyString) -> bool</autodoc>
<paramlist>
<param name="facename" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="GetEncodings" type="PyObject" overloaded="no">
- <autodoc>GetEncodings() -> PyObject</autodoc>
+ <autodoc>GetEncodings(self) -> PyObject</autodoc>
</method>
<method name="GetFacenames" type="PyObject" overloaded="no">
- <autodoc>GetFacenames() -> PyObject</autodoc>
+ <autodoc>GetFacenames(self) -> PyObject</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="LanguageInfo" oldname="wxLanguageInfo" module="gdi">
+ <class name="LanguageInfo" oldname="wxLanguageInfo" module="_gdi">
<property name="Language" type="int" readonly="no"/>
<property name="CanonicalName" type="String" readonly="no"/>
<property name="Description" type="String" readonly="no"/>
</class>
- <class name="Locale" oldname="wxLocale" module="gdi">
+ <class name="Locale" oldname="wxLocale" module="_gdi">
<constructor name="Locale" overloaded="no">
- <autodoc>__init__(int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale</autodoc>
+ <autodoc>__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale</autodoc>
<paramlist>
- <param name="language" type="int" default="wxLANGUAGE_DEFAULT"/>
+ <param name="language" type="int" default="-1"/>
<param name="flags" type="int" default="wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING"/>
</paramlist>
</constructor>
<destructor name="~wxLocale" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Init1" type="bool" overloaded="no">
- <autodoc>Init1(String szName, String szShort=EmptyString, String szLocale=EmptyString,
+ <autodoc>Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
bool bLoadDefault=True,
bool bConvertEncoding=False) -> bool</autodoc>
<paramlist>
</paramlist>
</method>
<method name="Init2" type="bool" overloaded="no">
- <autodoc>Init2(int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool</autodoc>
+ <autodoc>Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool</autodoc>
<paramlist>
<param name="language" type="int" default="wxLANGUAGE_DEFAULT"/>
<param name="flags" type="int" default="wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING"/>
<autodoc>GetSystemEncodingName() -> String</autodoc>
</staticmethod>
<method name="IsOk" type="bool" overloaded="no">
- <autodoc>IsOk() -> bool</autodoc>
+ <autodoc>IsOk(self) -> bool</autodoc>
</method>
<method name="GetLocale" type="String" overloaded="no">
- <autodoc>GetLocale() -> String</autodoc>
+ <autodoc>GetLocale(self) -> String</autodoc>
</method>
<method name="GetLanguage" type="int" overloaded="no">
- <autodoc>GetLanguage() -> int</autodoc>
+ <autodoc>GetLanguage(self) -> int</autodoc>
</method>
<method name="GetSysName" type="String" overloaded="no">
- <autodoc>GetSysName() -> String</autodoc>
+ <autodoc>GetSysName(self) -> String</autodoc>
</method>
<method name="GetCanonicalName" type="String" overloaded="no">
- <autodoc>GetCanonicalName() -> String</autodoc>
+ <autodoc>GetCanonicalName(self) -> String</autodoc>
</method>
<staticmethod name="AddCatalogLookupPathPrefix" type="" overloaded="no">
<autodoc>AddCatalogLookupPathPrefix(String prefix)</autodoc>
</paramlist>
</staticmethod>
<method name="AddCatalog" type="bool" overloaded="no">
- <autodoc>AddCatalog(String szDomain) -> bool</autodoc>
+ <autodoc>AddCatalog(self, String szDomain) -> bool</autodoc>
<paramlist>
<param name="szDomain" type="String" default=""/>
</paramlist>
</method>
<method name="IsLoaded" type="bool" overloaded="no">
- <autodoc>IsLoaded(String szDomain) -> bool</autodoc>
+ <autodoc>IsLoaded(self, String szDomain) -> bool</autodoc>
<paramlist>
<param name="szDomain" type="String" default=""/>
</paramlist>
</paramlist>
</staticmethod>
<method name="GetString" type="String" overloaded="no">
- <autodoc>GetString(String szOrigString, String szDomain=EmptyString) -> String</autodoc>
+ <autodoc>GetString(self, String szOrigString, String szDomain=EmptyString) -> String</autodoc>
<paramlist>
<param name="szOrigString" type="String" default=""/>
<param name="szDomain" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
+ <autodoc>GetName(self) -> String</autodoc>
</method>
</class>
<method name="GetLocale" oldname="wxGetLocale" type="Locale" overloaded="no">
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="EncodingConverter" oldname="wxEncodingConverter" module="gdi">
+ <class name="EncodingConverter" oldname="wxEncodingConverter" module="_gdi">
<baseclass name="Object"/>
<constructor name="EncodingConverter" overloaded="no">
- <autodoc>__init__() -> EncodingConverter</autodoc>
+ <autodoc>__init__(self) -> EncodingConverter</autodoc>
</constructor>
<destructor name="~wxEncodingConverter" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Init" type="bool" overloaded="no">
- <autodoc>Init(int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool</autodoc>
+ <autodoc>Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool</autodoc>
<paramlist>
<param name="input_enc" type="wxFontEncoding" default=""/>
<param name="output_enc" type="wxFontEncoding" default=""/>
</paramlist>
</method>
<method name="Convert" type="String" overloaded="no">
- <autodoc>Convert(String input) -> String</autodoc>
+ <autodoc>Convert(self, String input) -> String</autodoc>
<paramlist>
<param name="input" type="String" default=""/>
</paramlist>
</staticmethod>
</class>
<pythoncode>#----------------------------------------------------------------------------
-# wxGTK sets the locale when initialized. Doing this at the Python
-# level should set it up to match what GTK is doing at the C level.
-if wx.Platform == "__WXGTK__":
- try:
- import locale
- locale.setlocale(locale.LC_ALL, "")
- except:
- pass
-
-# On MSW add the directory where the wxWindows catalogs were installed
+# On MSW add the directory where the wxWidgets catalogs were installed
# to the default catalog path.
if wx.Platform == "__WXMSW__":
import os
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="DC" oldname="wxDC" module="gdi">
+ <class name="DC" oldname="wxDC" module="_gdi">
<baseclass name="Object"/>
<destructor name="~wxDC" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="BeginDrawing" type="" overloaded="no">
- <autodoc>BeginDrawing()</autodoc>
+ <autodoc>BeginDrawing(self)</autodoc>
</method>
<method name="EndDrawing" type="" overloaded="no">
- <autodoc>EndDrawing()</autodoc>
+ <autodoc>EndDrawing(self)</autodoc>
</method>
- <method name="FloodFillXY" type="bool" overloaded="no">
- <autodoc>FloodFillXY(int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool</autodoc>
+ <method name="FloodFill" type="bool" overloaded="no">
+ <autodoc>FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
<param name="style" type="int" default="wxFLOOD_SURFACE"/>
</paramlist>
</method>
- <method name="FloodFill" type="bool" overloaded="no">
- <autodoc>FloodFill(Point pt, Colour col, int style=FLOOD_SURFACE) -> bool</autodoc>
+ <method name="FloodFillPoint" type="bool" overloaded="no">
+ <autodoc>FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
<param name="col" type="Colour" default=""/>
<param name="style" type="int" default="wxFLOOD_SURFACE"/>
</paramlist>
</method>
- <method name="GetPixelXY" type="Colour" overloaded="no">
- <autodoc>GetPixelXY(int x, int y) -> Colour</autodoc>
+ <method name="GetPixel" type="Colour" overloaded="no">
+ <autodoc>GetPixel(self, int x, int y) -> Colour</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
- <method name="GetPixel" type="Colour" overloaded="no">
- <autodoc>GetPixel(Point pt) -> Colour</autodoc>
+ <method name="GetPixelPoint" type="Colour" overloaded="no">
+ <autodoc>GetPixelPoint(self, Point pt) -> Colour</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
- <method name="DrawLineXY" type="" overloaded="no">
- <autodoc>DrawLineXY(int x1, int y1, int x2, int y2)</autodoc>
+ <method name="DrawLine" type="" overloaded="no">
+ <autodoc>DrawLine(self, int x1, int y1, int x2, int y2)</autodoc>
<paramlist>
<param name="x1" type="int" default=""/>
<param name="y1" type="int" default=""/>
<param name="y2" type="int" default=""/>
</paramlist>
</method>
- <method name="DrawLine" type="" overloaded="no">
- <autodoc>DrawLine(Point pt1, Point pt2)</autodoc>
+ <method name="DrawLinePoint" type="" overloaded="no">
+ <autodoc>DrawLinePoint(self, Point pt1, Point pt2)</autodoc>
<paramlist>
<param name="pt1" type="Point" default=""/>
<param name="pt2" type="Point" default=""/>
</paramlist>
</method>
- <method name="CrossHairXY" type="" overloaded="no">
- <autodoc>CrossHairXY(int x, int y)</autodoc>
+ <method name="CrossHair" type="" overloaded="no">
+ <autodoc>CrossHair(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
- <method name="CrossHair" type="" overloaded="no">
- <autodoc>CrossHair(Point pt)</autodoc>
+ <method name="CrossHairPoint" type="" overloaded="no">
+ <autodoc>CrossHairPoint(self, Point pt)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
- <method name="DrawArcXY" type="" overloaded="no">
- <autodoc>DrawArcXY(int x1, int y1, int x2, int y2, int xc, int yc)</autodoc>
+ <method name="DrawArc" type="" overloaded="no">
+ <autodoc>DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)</autodoc>
<paramlist>
<param name="x1" type="int" default=""/>
<param name="y1" type="int" default=""/>
<param name="yc" type="int" default=""/>
</paramlist>
</method>
- <method name="DrawArc" type="" overloaded="no">
- <autodoc>DrawArc(Point pt1, Point pt2, Point centre)</autodoc>
+ <method name="DrawArcPoint" type="" overloaded="no">
+ <autodoc>DrawArcPoint(self, Point pt1, Point pt2, Point centre)</autodoc>
<paramlist>
<param name="pt1" type="Point" default=""/>
<param name="pt2" type="Point" default=""/>
<param name="centre" type="Point" default=""/>
</paramlist>
</method>
- <method name="DrawCheckMarkXY" type="" overloaded="no">
- <autodoc>DrawCheckMarkXY(int x, int y, int width, int height)</autodoc>
+ <method name="DrawCheckMark" type="" overloaded="no">
+ <autodoc>DrawCheckMark(self, int x, int y, int width, int height)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
- <method name="DrawCheckMark" type="" overloaded="no">
- <autodoc>DrawCheckMark(Rect rect)</autodoc>
+ <method name="DrawCheckMarkRect" type="" overloaded="no">
+ <autodoc>DrawCheckMarkRect(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
- <method name="DrawEllipticArcXY" type="" overloaded="no">
- <autodoc>DrawEllipticArcXY(int x, int y, int w, int h, double sa, double ea)</autodoc>
+ <method name="DrawEllipticArc" type="" overloaded="no">
+ <autodoc>DrawEllipticArc(self, int x, int y, int w, int h, double sa, double ea)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
<param name="ea" type="double" default=""/>
</paramlist>
</method>
- <method name="DrawEllipticArc" type="" overloaded="no">
- <autodoc>DrawEllipticArc(Point pt, Size sz, double sa, double ea)</autodoc>
+ <method name="DrawEllipticArcPointSize" type="" overloaded="no">
+ <autodoc>DrawEllipticArcPointSize(self, Point pt, Size sz, double sa, double ea)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
<param name="sz" type="Size" default=""/>
<param name="ea" type="double" default=""/>
</paramlist>
</method>
- <method name="DrawPointXY" type="" overloaded="no">
- <autodoc>DrawPointXY(int x, int y)</autodoc>
+ <method name="DrawPoint" type="" overloaded="no">
+ <autodoc>DrawPoint(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
- <method name="DrawPoint" type="" overloaded="no">
- <autodoc>DrawPoint(Point pt)</autodoc>
+ <method name="DrawPointPoint" type="" overloaded="no">
+ <autodoc>DrawPointPoint(self, Point pt)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
- <method name="DrawRectangleXY" type="" overloaded="no">
- <autodoc>DrawRectangleXY(int x, int y, int width, int height)</autodoc>
+ <method name="DrawRectangle" type="" overloaded="no">
+ <autodoc>DrawRectangle(self, int x, int y, int width, int height)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
- <method name="DrawRectangle" type="" overloaded="no">
- <autodoc>DrawRectangle(Point pt, Size sz)</autodoc>
+ <method name="DrawRectangleRect" type="" overloaded="no">
+ <autodoc>DrawRectangleRect(self, Rect rect)</autodoc>
<paramlist>
- <param name="pt" type="Point" default=""/>
- <param name="sz" type="Size" default=""/>
+ <param name="rect" type="Rect" default=""/>
</paramlist>
</method>
- <method name="DrawRectangleRect" type="" overloaded="no">
- <autodoc>DrawRectangleRect(Rect rect)</autodoc>
+ <method name="DrawRectanglePointSize" type="" overloaded="no">
+ <autodoc>DrawRectanglePointSize(self, Point pt, Size sz)</autodoc>
<paramlist>
- <param name="rect" type="Rect" default=""/>
+ <param name="pt" type="Point" default=""/>
+ <param name="sz" type="Size" default=""/>
</paramlist>
</method>
- <method name="DrawRoundedRectangleXY" type="" overloaded="no">
- <autodoc>DrawRoundedRectangleXY(int x, int y, int width, int height, double radius)</autodoc>
+ <method name="DrawRoundedRectangle" type="" overloaded="no">
+ <autodoc>DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
<param name="radius" type="double" default=""/>
</paramlist>
</method>
- <method name="DrawRoundedRectangle" type="" overloaded="no">
- <autodoc>DrawRoundedRectangle(Point pt, Size sz, double radius)</autodoc>
+ <method name="DrawRoundedRectangleRect" type="" overloaded="no">
+ <autodoc>DrawRoundedRectangleRect(self, Rect r, double radius)</autodoc>
<paramlist>
- <param name="pt" type="Point" default=""/>
- <param name="sz" type="Size" default=""/>
+ <param name="r" type="Rect" default=""/>
<param name="radius" type="double" default=""/>
</paramlist>
</method>
- <method name="DrawRoundedRectangleRect" type="" overloaded="no">
- <autodoc>DrawRoundedRectangleRect(Rect r, double radius)</autodoc>
+ <method name="DrawRoundedRectanglePointSize" type="" overloaded="no">
+ <autodoc>DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)</autodoc>
<paramlist>
- <param name="r" type="Rect" default=""/>
+ <param name="pt" type="Point" default=""/>
+ <param name="sz" type="Size" default=""/>
<param name="radius" type="double" default=""/>
</paramlist>
</method>
- <method name="DrawCircleXY" type="" overloaded="no">
- <autodoc>DrawCircleXY(int x, int y, int radius)</autodoc>
+ <method name="DrawCircle" type="" overloaded="no">
+ <autodoc>DrawCircle(self, int x, int y, int radius)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
<param name="radius" type="int" default=""/>
</paramlist>
</method>
- <method name="DrawCircle" type="" overloaded="no">
- <autodoc>DrawCircle(Point pt, int radius)</autodoc>
+ <method name="DrawCirclePoint" type="" overloaded="no">
+ <autodoc>DrawCirclePoint(self, Point pt, int radius)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
<param name="radius" type="int" default=""/>
</paramlist>
</method>
- <method name="DrawEllipseXY" type="" overloaded="no">
- <autodoc>DrawEllipseXY(int x, int y, int width, int height)</autodoc>
+ <method name="DrawEllipse" type="" overloaded="no">
+ <autodoc>DrawEllipse(self, int x, int y, int width, int height)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
- <method name="DrawEllipse" type="" overloaded="no">
- <autodoc>DrawEllipse(Point pt, Size sz)</autodoc>
+ <method name="DrawEllipseRect" type="" overloaded="no">
+ <autodoc>DrawEllipseRect(self, Rect rect)</autodoc>
<paramlist>
- <param name="pt" type="Point" default=""/>
- <param name="sz" type="Size" default=""/>
+ <param name="rect" type="Rect" default=""/>
</paramlist>
</method>
- <method name="DrawEllipseRect" type="" overloaded="no">
- <autodoc>DrawEllipseRect(Rect rect)</autodoc>
+ <method name="DrawEllipsePointSize" type="" overloaded="no">
+ <autodoc>DrawEllipsePointSize(self, Point pt, Size sz)</autodoc>
<paramlist>
- <param name="rect" type="Rect" default=""/>
+ <param name="pt" type="Point" default=""/>
+ <param name="sz" type="Size" default=""/>
</paramlist>
</method>
- <method name="DrawIconXY" type="" overloaded="no">
- <autodoc>DrawIconXY(Icon icon, int x, int y)</autodoc>
+ <method name="DrawIcon" type="" overloaded="no">
+ <autodoc>DrawIcon(self, Icon icon, int x, int y)</autodoc>
<paramlist>
<param name="icon" type="Icon" default=""/>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
- <method name="DrawIcon" type="" overloaded="no">
- <autodoc>DrawIcon(Icon icon, Point pt)</autodoc>
+ <method name="DrawIconPoint" type="" overloaded="no">
+ <autodoc>DrawIconPoint(self, Icon icon, Point pt)</autodoc>
<paramlist>
<param name="icon" type="Icon" default=""/>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
- <method name="DrawBitmapXY" type="" overloaded="no">
- <autodoc>DrawBitmapXY(Bitmap bmp, int x, int y, bool useMask=False)</autodoc>
+ <method name="DrawBitmap" type="" overloaded="no">
+ <autodoc>DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)</autodoc>
<paramlist>
<param name="bmp" type="Bitmap" default=""/>
<param name="x" type="int" default=""/>
<param name="useMask" type="bool" default="False"/>
</paramlist>
</method>
- <method name="DrawBitmap" type="" overloaded="no">
- <autodoc>DrawBitmap(Bitmap bmp, Point pt, bool useMask=False)</autodoc>
+ <method name="DrawBitmapPoint" type="" overloaded="no">
+ <autodoc>DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)</autodoc>
<paramlist>
<param name="bmp" type="Bitmap" default=""/>
<param name="pt" type="Point" default=""/>
<param name="useMask" type="bool" default="False"/>
</paramlist>
</method>
- <method name="DrawTextXY" type="" overloaded="no">
- <autodoc>DrawTextXY(String text, int x, int y)</autodoc>
+ <method name="DrawText" type="" overloaded="no">
+ <autodoc>DrawText(self, String text, int x, int y)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
- <method name="DrawText" type="" overloaded="no">
- <autodoc>DrawText(String text, Point pt)</autodoc>
+ <method name="DrawTextPoint" type="" overloaded="no">
+ <autodoc>DrawTextPoint(self, String text, Point pt)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
- <method name="DrawRotatedTextXY" type="" overloaded="no">
- <autodoc>DrawRotatedTextXY(String text, int x, int y, double angle)</autodoc>
+ <method name="DrawRotatedText" type="" overloaded="no">
+ <autodoc>DrawRotatedText(self, String text, int x, int y, double angle)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="x" type="int" default=""/>
<param name="angle" type="double" default=""/>
</paramlist>
</method>
- <method name="DrawRotatedText" type="" overloaded="no">
- <autodoc>DrawRotatedText(String text, Point pt, double angle)</autodoc>
+ <method name="DrawRotatedTextPoint" type="" overloaded="no">
+ <autodoc>DrawRotatedTextPoint(self, String text, Point pt, double angle)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="pt" type="Point" default=""/>
<param name="angle" type="double" default=""/>
</paramlist>
</method>
- <method name="BlitXY" type="bool" overloaded="no">
- <autodoc>BlitXY(int xdest, int ydest, int width, int height, DC source,
+ <method name="Blit" type="bool" overloaded="no">
+ <autodoc>Blit(self, int xdest, int ydest, int width, int height, DC source,
int xsrc, int ysrc, int rop=COPY, bool useMask=False,
int xsrcMask=-1, int ysrcMask=-1) -> bool</autodoc>
<paramlist>
<param name="ysrcMask" type="int" default="-1"/>
</paramlist>
</method>
- <method name="Blit" type="bool" overloaded="no">
- <autodoc>Blit(Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
+ <method name="BlitPointSize" type="bool" overloaded="no">
+ <autodoc>BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
bool useMask=False, Point srcPtMask=DefaultPosition) -> bool</autodoc>
<paramlist>
<param name="destPt" type="Point" default=""/>
<param name="srcPtMask" type="Point" default="wxDefaultPosition"/>
</paramlist>
</method>
+ <method name="SetClippingRegion" type="" overloaded="no">
+ <autodoc>SetClippingRegion(self, int x, int y, int width, int height)</autodoc>
+ <paramlist>
+ <param name="x" type="int" default=""/>
+ <param name="y" type="int" default=""/>
+ <param name="width" type="int" default=""/>
+ <param name="height" type="int" default=""/>
+ </paramlist>
+ </method>
+ <method name="SetClippingRegionPointSize" type="" overloaded="no">
+ <autodoc>SetClippingRegionPointSize(self, Point pt, Size sz)</autodoc>
+ <paramlist>
+ <param name="pt" type="Point" default=""/>
+ <param name="sz" type="Size" default=""/>
+ </paramlist>
+ </method>
+ <method name="SetClippingRegionAsRegion" type="" overloaded="no">
+ <autodoc>SetClippingRegionAsRegion(self, Region region)</autodoc>
+ <paramlist>
+ <param name="region" type="Region" default=""/>
+ </paramlist>
+ </method>
+ <method name="SetClippingRect" type="" overloaded="no">
+ <autodoc>SetClippingRect(self, Rect rect)</autodoc>
+ <paramlist>
+ <param name="rect" type="Rect" default=""/>
+ </paramlist>
+ </method>
<method name="DrawLines" type="" overloaded="no">
- <autodoc>DrawLines(int points, Point points_array, int xoffset=0, int yoffset=0)</autodoc>
+ <autodoc>DrawLines(self, int points, Point points_array, int xoffset=0, int yoffset=0)</autodoc>
<paramlist>
<param name="points" type="int" default=""/>
<param name="points_array" type="Point" default=""/>
</paramlist>
</method>
<method name="DrawPolygon" type="" overloaded="no">
- <autodoc>DrawPolygon(int points, Point points_array, int xoffset=0, int yoffset=0,
+ <autodoc>DrawPolygon(self, int points, Point points_array, int xoffset=0, int yoffset=0,
int fillStyle=ODDEVEN_RULE)</autodoc>
<paramlist>
<param name="points" type="int" default=""/>
</paramlist>
</method>
<method name="DrawLabel" type="" overloaded="no">
- <autodoc>DrawLabel(String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
+ <autodoc>DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
int indexAccel=-1)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="DrawImageLabel" type="Rect" overloaded="no">
- <autodoc>DrawImageLabel(String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
+ <autodoc>DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
int indexAccel=-1) -> Rect</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="DrawSpline" type="" overloaded="no">
- <autodoc>DrawSpline(int points, Point points_array)</autodoc>
+ <autodoc>DrawSpline(self, int points, Point points_array)</autodoc>
<paramlist>
<param name="points" type="int" default=""/>
<param name="points_array" type="Point" default=""/>
</paramlist>
</method>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear()</autodoc>
+ <autodoc>Clear(self)</autodoc>
</method>
<method name="StartDoc" type="bool" overloaded="no">
- <autodoc>StartDoc(String message) -> bool</autodoc>
+ <autodoc>StartDoc(self, String message) -> bool</autodoc>
<paramlist>
<param name="message" type="String" default=""/>
</paramlist>
</method>
<method name="EndDoc" type="" overloaded="no">
- <autodoc>EndDoc()</autodoc>
+ <autodoc>EndDoc(self)</autodoc>
</method>
<method name="StartPage" type="" overloaded="no">
- <autodoc>StartPage()</autodoc>
+ <autodoc>StartPage(self)</autodoc>
</method>
<method name="EndPage" type="" overloaded="no">
- <autodoc>EndPage()</autodoc>
+ <autodoc>EndPage(self)</autodoc>
</method>
<method name="SetFont" type="" overloaded="no">
- <autodoc>SetFont(Font font)</autodoc>
+ <autodoc>SetFont(self, Font font)</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="SetPen" type="" overloaded="no">
- <autodoc>SetPen(Pen pen)</autodoc>
+ <autodoc>SetPen(self, Pen pen)</autodoc>
<paramlist>
<param name="pen" type="Pen" default=""/>
</paramlist>
</method>
<method name="SetBrush" type="" overloaded="no">
- <autodoc>SetBrush(Brush brush)</autodoc>
+ <autodoc>SetBrush(self, Brush brush)</autodoc>
<paramlist>
<param name="brush" type="Brush" default=""/>
</paramlist>
</method>
<method name="SetBackground" type="" overloaded="no">
- <autodoc>SetBackground(Brush brush)</autodoc>
+ <autodoc>SetBackground(self, Brush brush)</autodoc>
<paramlist>
<param name="brush" type="Brush" default=""/>
</paramlist>
</method>
<method name="SetBackgroundMode" type="" overloaded="no">
- <autodoc>SetBackgroundMode(int mode)</autodoc>
+ <autodoc>SetBackgroundMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="SetPalette" type="" overloaded="no">
- <autodoc>SetPalette(Palette palette)</autodoc>
+ <autodoc>SetPalette(self, Palette palette)</autodoc>
<paramlist>
<param name="palette" type="Palette" default=""/>
</paramlist>
</method>
- <method name="SetClippingRegionXY" type="" overloaded="no">
- <autodoc>SetClippingRegionXY(int x, int y, int width, int height)</autodoc>
- <paramlist>
- <param name="x" type="int" default=""/>
- <param name="y" type="int" default=""/>
- <param name="width" type="int" default=""/>
- <param name="height" type="int" default=""/>
- </paramlist>
- </method>
- <method name="SetClippingRegion" type="" overloaded="no">
- <autodoc>SetClippingRegion(Point pt, Size sz)</autodoc>
- <paramlist>
- <param name="pt" type="Point" default=""/>
- <param name="sz" type="Size" default=""/>
- </paramlist>
- </method>
- <method name="SetClippingRect" type="" overloaded="no">
- <autodoc>SetClippingRect(Rect rect)</autodoc>
- <paramlist>
- <param name="rect" type="Rect" default=""/>
- </paramlist>
- </method>
- <method name="SetClippingRegionAsRegion" type="" overloaded="no">
- <autodoc>SetClippingRegionAsRegion(Region region)</autodoc>
- <paramlist>
- <param name="region" type="Region" default=""/>
- </paramlist>
- </method>
<method name="DestroyClippingRegion" type="" overloaded="no">
- <autodoc>DestroyClippingRegion()</autodoc>
+ <autodoc>DestroyClippingRegion(self)</autodoc>
</method>
<method name="GetClippingBox" type="" overloaded="no">
<autodoc>GetClippingBox() -> (x, y, width, height)</autodoc>
</paramlist>
</method>
<method name="GetClippingRect" type="Rect" overloaded="no">
- <autodoc>GetClippingRect() -> Rect</autodoc>
+ <autodoc>GetClippingRect(self) -> Rect</autodoc>
</method>
<method name="GetCharHeight" type="int" overloaded="no">
- <autodoc>GetCharHeight() -> int</autodoc>
+ <autodoc>GetCharHeight(self) -> int</autodoc>
</method>
<method name="GetCharWidth" type="int" overloaded="no">
- <autodoc>GetCharWidth() -> int</autodoc>
+ <autodoc>GetCharWidth(self) -> int</autodoc>
</method>
<method name="GetTextExtent" type="" overloaded="no">
<autodoc>GetTextExtent(wxString string) -> (width, height)</autodoc>
- <docstring>Get the width and height of the text using the current font.
-Only works for single line strings.</docstring>
<paramlist>
<param name="string" type="String" default=""/>
<param name="OUTPUT" type="int" default=""/>
<method name="GetFullTextExtent" type="" overloaded="no">
<autodoc>GetFullTextExtent(wxString string, Font font=None) ->
(width, height, descent, externalLeading)</autodoc>
- <docstring>Get the width, height, decent and leading of the text using the current or specified font.
-Only works for single line strings.</docstring>
+ <docstring>Get the width, height, decent and leading of the text using the
+current or specified font. Only works for single line strings.</docstring>
<paramlist>
<param name="string" type="String" default=""/>
<param name="OUTPUT" type="int" default=""/>
<method name="GetMultiLineTextExtent" type="" overloaded="no">
<autodoc>GetMultiLineTextExtent(wxString string, Font font=None) ->
(width, height, descent, externalLeading)</autodoc>
- <docstring>Get the width, height, decent and leading of the text using the current or specified font.
-Works for single as well as multi-line strings.</docstring>
<paramlist>
<param name="text" type="String" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="GetPartialTextExtents" type="wxArrayInt" overloaded="no">
- <autodoc>GetPartialTextExtents(String text) -> wxArrayInt</autodoc>
+ <autodoc>GetPartialTextExtents(self, String text) -> wxArrayInt</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="GetSize" type="Size" overloaded="no">
- <autodoc>GetSize() -> Size</autodoc>
+ <autodoc>GetSize(self) -> Size</autodoc>
<docstring>Get the DC size in device units.</docstring>
</method>
<method name="GetSizeTuple" type="" overloaded="no">
</paramlist>
</method>
<method name="GetSizeMM" type="Size" overloaded="no">
- <autodoc>GetSizeMM() -> Size</autodoc>
+ <autodoc>GetSizeMM(self) -> Size</autodoc>
<docstring>Get the DC size in milimeters.</docstring>
</method>
<method name="GetSizeMMTuple" type="" overloaded="no">
</paramlist>
</method>
<method name="DeviceToLogicalX" type="int" overloaded="no">
- <autodoc>DeviceToLogicalX(int x) -> int</autodoc>
+ <autodoc>DeviceToLogicalX(self, int x) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="DeviceToLogicalY" type="int" overloaded="no">
- <autodoc>DeviceToLogicalY(int y) -> int</autodoc>
+ <autodoc>DeviceToLogicalY(self, int y) -> int</autodoc>
<paramlist>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="DeviceToLogicalXRel" type="int" overloaded="no">
- <autodoc>DeviceToLogicalXRel(int x) -> int</autodoc>
+ <autodoc>DeviceToLogicalXRel(self, int x) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="DeviceToLogicalYRel" type="int" overloaded="no">
- <autodoc>DeviceToLogicalYRel(int y) -> int</autodoc>
+ <autodoc>DeviceToLogicalYRel(self, int y) -> int</autodoc>
<paramlist>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="LogicalToDeviceX" type="int" overloaded="no">
- <autodoc>LogicalToDeviceX(int x) -> int</autodoc>
+ <autodoc>LogicalToDeviceX(self, int x) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="LogicalToDeviceY" type="int" overloaded="no">
- <autodoc>LogicalToDeviceY(int y) -> int</autodoc>
+ <autodoc>LogicalToDeviceY(self, int y) -> int</autodoc>
<paramlist>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="LogicalToDeviceXRel" type="int" overloaded="no">
- <autodoc>LogicalToDeviceXRel(int x) -> int</autodoc>
+ <autodoc>LogicalToDeviceXRel(self, int x) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="LogicalToDeviceYRel" type="int" overloaded="no">
- <autodoc>LogicalToDeviceYRel(int y) -> int</autodoc>
+ <autodoc>LogicalToDeviceYRel(self, int y) -> int</autodoc>
<paramlist>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="CanDrawBitmap" type="bool" overloaded="no">
- <autodoc>CanDrawBitmap() -> bool</autodoc>
+ <autodoc>CanDrawBitmap(self) -> bool</autodoc>
</method>
<method name="CanGetTextExtent" type="bool" overloaded="no">
- <autodoc>CanGetTextExtent() -> bool</autodoc>
+ <autodoc>CanGetTextExtent(self) -> bool</autodoc>
</method>
<method name="GetDepth" type="int" overloaded="no">
- <autodoc>GetDepth() -> int</autodoc>
+ <autodoc>GetDepth(self) -> int</autodoc>
</method>
<method name="GetPPI" type="Size" overloaded="no">
- <autodoc>GetPPI() -> Size</autodoc>
+ <autodoc>GetPPI(self) -> Size</autodoc>
</method>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
<method name="GetBackgroundMode" type="int" overloaded="no">
- <autodoc>GetBackgroundMode() -> int</autodoc>
+ <autodoc>GetBackgroundMode(self) -> int</autodoc>
</method>
<method name="GetBackground" type="Brush" overloaded="no">
- <autodoc>GetBackground() -> Brush</autodoc>
+ <autodoc>GetBackground(self) -> Brush</autodoc>
</method>
<method name="GetBrush" type="Brush" overloaded="no">
- <autodoc>GetBrush() -> Brush</autodoc>
+ <autodoc>GetBrush(self) -> Brush</autodoc>
</method>
<method name="GetFont" type="Font" overloaded="no">
- <autodoc>GetFont() -> Font</autodoc>
+ <autodoc>GetFont(self) -> Font</autodoc>
</method>
<method name="GetPen" type="Pen" overloaded="no">
- <autodoc>GetPen() -> Pen</autodoc>
+ <autodoc>GetPen(self) -> Pen</autodoc>
</method>
<method name="GetTextBackground" type="Colour" overloaded="no">
- <autodoc>GetTextBackground() -> Colour</autodoc>
+ <autodoc>GetTextBackground(self) -> Colour</autodoc>
</method>
<method name="GetTextForeground" type="Colour" overloaded="no">
- <autodoc>GetTextForeground() -> Colour</autodoc>
+ <autodoc>GetTextForeground(self) -> Colour</autodoc>
</method>
<method name="SetTextForeground" type="" overloaded="no">
- <autodoc>SetTextForeground(Colour colour)</autodoc>
+ <autodoc>SetTextForeground(self, Colour colour)</autodoc>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetTextBackground" type="" overloaded="no">
- <autodoc>SetTextBackground(Colour colour)</autodoc>
+ <autodoc>SetTextBackground(self, Colour colour)</autodoc>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetMapMode" type="int" overloaded="no">
- <autodoc>GetMapMode() -> int</autodoc>
+ <autodoc>GetMapMode(self) -> int</autodoc>
</method>
<method name="SetMapMode" type="" overloaded="no">
- <autodoc>SetMapMode(int mode)</autodoc>
+ <autodoc>SetMapMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</paramlist>
</method>
<method name="SetUserScale" type="" overloaded="no">
- <autodoc>SetUserScale(double x, double y)</autodoc>
+ <autodoc>SetUserScale(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="SetLogicalScale" type="" overloaded="no">
- <autodoc>SetLogicalScale(double x, double y)</autodoc>
+ <autodoc>SetLogicalScale(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="GetLogicalOrigin" type="Point" overloaded="no">
- <autodoc>GetLogicalOrigin() -> Point</autodoc>
+ <autodoc>GetLogicalOrigin(self) -> Point</autodoc>
</method>
<method name="GetLogicalOriginTuple" type="" overloaded="no">
<autodoc>GetLogicalOriginTuple() -> (x,y)</autodoc>
</paramlist>
</method>
<method name="SetLogicalOrigin" type="" overloaded="no">
- <autodoc>SetLogicalOrigin(int x, int y)</autodoc>
+ <autodoc>SetLogicalOrigin(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
+ <method name="SetLogicalOriginPoint" type="" overloaded="no">
+ <autodoc>SetLogicalOriginPoint(self, Point point)</autodoc>
+ <paramlist>
+ <param name="point" type="Point" default=""/>
+ </paramlist>
+ </method>
<method name="GetDeviceOrigin" type="Point" overloaded="no">
- <autodoc>GetDeviceOrigin() -> Point</autodoc>
+ <autodoc>GetDeviceOrigin(self) -> Point</autodoc>
</method>
<method name="GetDeviceOriginTuple" type="" overloaded="no">
<autodoc>GetDeviceOriginTuple() -> (x,y)</autodoc>
</paramlist>
</method>
<method name="SetDeviceOrigin" type="" overloaded="no">
- <autodoc>SetDeviceOrigin(int x, int y)</autodoc>
+ <autodoc>SetDeviceOrigin(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
+ <method name="SetDeviceOriginPoint" type="" overloaded="no">
+ <autodoc>SetDeviceOriginPoint(self, Point point)</autodoc>
+ <paramlist>
+ <param name="point" type="Point" default=""/>
+ </paramlist>
+ </method>
<method name="SetAxisOrientation" type="" overloaded="no">
- <autodoc>SetAxisOrientation(bool xLeftRight, bool yBottomUp)</autodoc>
+ <autodoc>SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)</autodoc>
<paramlist>
<param name="xLeftRight" type="bool" default=""/>
<param name="yBottomUp" type="bool" default=""/>
</paramlist>
</method>
<method name="GetLogicalFunction" type="int" overloaded="no">
- <autodoc>GetLogicalFunction() -> int</autodoc>
+ <autodoc>GetLogicalFunction(self) -> int</autodoc>
</method>
<method name="SetLogicalFunction" type="" overloaded="no">
- <autodoc>SetLogicalFunction(int function)</autodoc>
+ <autodoc>SetLogicalFunction(self, int function)</autodoc>
<paramlist>
<param name="function" type="int" default=""/>
</paramlist>
</method>
<method name="SetOptimization" type="" overloaded="no">
- <autodoc>SetOptimization(bool opt)</autodoc>
+ <autodoc>SetOptimization(self, bool opt)</autodoc>
<paramlist>
<param name="opt" type="bool" default=""/>
</paramlist>
</method>
<method name="GetOptimization" type="bool" overloaded="no">
- <autodoc>GetOptimization() -> bool</autodoc>
+ <autodoc>GetOptimization(self) -> bool</autodoc>
</method>
<method name="CalcBoundingBox" type="" overloaded="no">
- <autodoc>CalcBoundingBox(int x, int y)</autodoc>
+ <autodoc>CalcBoundingBox(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
+ <method name="CalcBoundingBoxPoint" type="" overloaded="no">
+ <autodoc>CalcBoundingBoxPoint(self, Point point)</autodoc>
+ <paramlist>
+ <param name="point" type="Point" default=""/>
+ </paramlist>
+ </method>
<method name="ResetBoundingBox" type="" overloaded="no">
- <autodoc>ResetBoundingBox()</autodoc>
+ <autodoc>ResetBoundingBox(self)</autodoc>
</method>
<method name="MinX" type="int" overloaded="no">
- <autodoc>MinX() -> int</autodoc>
+ <autodoc>MinX(self) -> int</autodoc>
</method>
<method name="MaxX" type="int" overloaded="no">
- <autodoc>MaxX() -> int</autodoc>
+ <autodoc>MaxX(self) -> int</autodoc>
</method>
<method name="MinY" type="int" overloaded="no">
- <autodoc>MinY() -> int</autodoc>
+ <autodoc>MinY(self) -> int</autodoc>
</method>
<method name="MaxY" type="int" overloaded="no">
- <autodoc>MaxY() -> int</autodoc>
+ <autodoc>MaxY(self) -> int</autodoc>
</method>
<method name="GetBoundingBox" type="" overloaded="no">
<autodoc>GetBoundingBox() -> (x1,y1, x2,y2)</autodoc>
</paramlist>
</method>
<method name="_DrawPointList" type="PyObject" overloaded="no">
- <autodoc>_DrawPointList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc>
+ <autodoc>_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc>
<paramlist>
<param name="pyCoords" type="PyObject" default=""/>
<param name="pyPens" type="PyObject" default=""/>
</paramlist>
</method>
<method name="_DrawLineList" type="PyObject" overloaded="no">
- <autodoc>_DrawLineList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc>
+ <autodoc>_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc>
<paramlist>
<param name="pyCoords" type="PyObject" default=""/>
<param name="pyPens" type="PyObject" default=""/>
</paramlist>
</method>
<method name="_DrawRectangleList" type="PyObject" overloaded="no">
- <autodoc>_DrawRectangleList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc>
+ <autodoc>_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc>
<paramlist>
<param name="pyCoords" type="PyObject" default=""/>
<param name="pyPens" type="PyObject" default=""/>
</paramlist>
</method>
<method name="_DrawEllipseList" type="PyObject" overloaded="no">
- <autodoc>_DrawEllipseList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc>
+ <autodoc>_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc>
<paramlist>
<param name="pyCoords" type="PyObject" default=""/>
<param name="pyPens" type="PyObject" default=""/>
</paramlist>
</method>
<method name="_DrawPolygonList" type="PyObject" overloaded="no">
- <autodoc>_DrawPolygonList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc>
+ <autodoc>_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc>
<paramlist>
<param name="pyCoords" type="PyObject" default=""/>
<param name="pyPens" type="PyObject" default=""/>
</paramlist>
</method>
<method name="_DrawTextList" type="PyObject" overloaded="no">
- <autodoc>_DrawTextList(PyObject textList, PyObject pyPoints, PyObject foregroundList,
+ <autodoc>_DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
PyObject backgroundList) -> PyObject</autodoc>
<paramlist>
<param name="textList" type="PyObject" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MemoryDC" oldname="wxMemoryDC" module="gdi">
+ <class name="MemoryDC" oldname="wxMemoryDC" module="_gdi">
<baseclass name="DC"/>
<constructor name="MemoryDC" overloaded="no">
- <autodoc>__init__() -> MemoryDC</autodoc>
+ <autodoc>__init__(self) -> MemoryDC</autodoc>
</constructor>
<constructor name="MemoryDCFromDC" overloaded="no">
<autodoc>MemoryDCFromDC(DC oldDC) -> MemoryDC</autodoc>
</paramlist>
</constructor>
<method name="SelectObject" type="" overloaded="no">
- <autodoc>SelectObject(Bitmap bitmap)</autodoc>
+ <autodoc>SelectObject(self, Bitmap bitmap)</autodoc>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="BufferedDC" oldname="wxBufferedDC" module="gdi">
+ <class name="BufferedDC" oldname="wxBufferedDC" module="_gdi">
<baseclass name="MemoryDC"/>
<constructor name="BufferedDC" overloaded="yes">
<paramlist>
</paramlist>
</constructor>
<constructor name="BufferedDC" overloaded="yes">
- <autodoc>__init__(DC dc, Bitmap buffer) -> BufferedDC
-__init__(DC dc, Size area) -> BufferedDC</autodoc>
+ <autodoc>__init__(self, DC dc, Bitmap buffer) -> BufferedDC
+__init__(self, DC dc, Size area) -> BufferedDC</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="area" type="Size" default=""/>
</paramlist>
</constructor>
<destructor name="~wxBufferedDC" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="UnMask" type="" overloaded="no">
- <autodoc>UnMask()</autodoc>
+ <autodoc>UnMask(self)</autodoc>
</method>
</class>
- <class name="BufferedPaintDC" oldname="wxBufferedPaintDC" module="gdi">
+ <class name="BufferedPaintDC" oldname="wxBufferedPaintDC" module="_gdi">
<baseclass name="BufferedDC"/>
<constructor name="BufferedPaintDC" overloaded="no">
- <autodoc>__init__(Window window, Bitmap buffer=NullBitmap) -> BufferedPaintDC</autodoc>
+ <autodoc>__init__(self, Window window, Bitmap buffer=NullBitmap) -> BufferedPaintDC</autodoc>
<paramlist>
<param name="window" type="Window" default=""/>
<param name="buffer" type="Bitmap" default="wxNullBitmap"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ScreenDC" oldname="wxScreenDC" module="gdi">
+ <class name="ScreenDC" oldname="wxScreenDC" module="_gdi">
<baseclass name="DC"/>
<constructor name="ScreenDC" overloaded="no">
- <autodoc>__init__() -> ScreenDC</autodoc>
+ <autodoc>__init__(self) -> ScreenDC</autodoc>
</constructor>
<method name="StartDrawingOnTopWin" type="bool" overloaded="no">
- <autodoc>StartDrawingOnTopWin(Window window) -> bool</autodoc>
+ <autodoc>StartDrawingOnTopWin(self, Window window) -> bool</autodoc>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="StartDrawingOnTop" type="bool" overloaded="no">
- <autodoc>StartDrawingOnTop(Rect rect=None) -> bool</autodoc>
+ <autodoc>StartDrawingOnTop(self, Rect rect=None) -> bool</autodoc>
<paramlist>
<param name="rect" type="Rect" default="NULL"/>
</paramlist>
</method>
<method name="EndDrawingOnTop" type="bool" overloaded="no">
- <autodoc>EndDrawingOnTop() -> bool</autodoc>
+ <autodoc>EndDrawingOnTop(self) -> bool</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ClientDC" oldname="wxClientDC" module="gdi">
+ <class name="ClientDC" oldname="wxClientDC" module="_gdi">
<baseclass name="DC"/>
<constructor name="ClientDC" overloaded="no">
- <autodoc>__init__(Window win) -> ClientDC</autodoc>
+ <autodoc>__init__(self, Window win) -> ClientDC</autodoc>
<paramlist>
<param name="win" type="Window" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PaintDC" oldname="wxPaintDC" module="gdi">
+ <class name="PaintDC" oldname="wxPaintDC" module="_gdi">
<baseclass name="DC"/>
<constructor name="PaintDC" overloaded="no">
- <autodoc>__init__(Window win) -> PaintDC</autodoc>
+ <autodoc>__init__(self, Window win) -> PaintDC</autodoc>
<paramlist>
<param name="win" type="Window" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="WindowDC" oldname="wxWindowDC" module="gdi">
+ <class name="WindowDC" oldname="wxWindowDC" module="_gdi">
<baseclass name="DC"/>
<constructor name="WindowDC" overloaded="no">
- <autodoc>__init__(Window win) -> WindowDC</autodoc>
+ <autodoc>__init__(self, Window win) -> WindowDC</autodoc>
<paramlist>
<param name="win" type="Window" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MirrorDC" oldname="wxMirrorDC" module="gdi">
+ <class name="MirrorDC" oldname="wxMirrorDC" module="_gdi">
<baseclass name="DC"/>
<constructor name="MirrorDC" overloaded="no">
- <autodoc>__init__(DC dc, bool mirror) -> MirrorDC</autodoc>
+ <autodoc>__init__(self, DC dc, bool mirror) -> MirrorDC</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="mirror" type="bool" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PostScriptDC" oldname="wxPostScriptDC" module="gdi">
+ <class name="PostScriptDC" oldname="wxPostScriptDC" module="_gdi">
<baseclass name="DC"/>
<constructor name="PostScriptDC" overloaded="no">
- <autodoc>__init__(wxPrintData printData) -> PostScriptDC</autodoc>
+ <autodoc>__init__(self, wxPrintData printData) -> PostScriptDC</autodoc>
<paramlist>
<param name="printData" type="wxPrintData" default=""/>
</paramlist>
</constructor>
<method name="GetPrintData" type="wxPrintData" overloaded="no">
- <autodoc>GetPrintData() -> wxPrintData</autodoc>
+ <autodoc>GetPrintData(self) -> wxPrintData</autodoc>
</method>
<method name="SetPrintData" type="" overloaded="no">
- <autodoc>SetPrintData(wxPrintData data)</autodoc>
+ <autodoc>SetPrintData(self, wxPrintData data)</autodoc>
<paramlist>
<param name="data" type="wxPrintData" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MetaFile" oldname="wxMetaFile" module="gdi">
+ <class name="MetaFile" oldname="wxMetaFile" module="_gdi">
<baseclass name="Object"/>
<constructor name="MetaFile" overloaded="no">
- <autodoc>__init__(String filename=EmptyString) -> MetaFile</autodoc>
+ <autodoc>__init__(self, String filename=EmptyString) -> MetaFile</autodoc>
<paramlist>
<param name="filename" type="String" default="wxPyEmptyString"/>
</paramlist>
</constructor>
</class>
- <class name="MetaFileDC" oldname="wxMetaFileDC" module="gdi">
+ <class name="MetaFileDC" oldname="wxMetaFileDC" module="_gdi">
<baseclass name="DC"/>
<constructor name="MetaFileDC" overloaded="no">
- <autodoc>__init__(String filename=EmptyString, int width=0, int height=0,
+ <autodoc>__init__(self, String filename=EmptyString, int width=0, int height=0,
String description=EmptyString) -> MetaFileDC</autodoc>
<paramlist>
<param name="filename" type="String" default="wxPyEmptyString"/>
</paramlist>
</constructor>
</class>
- <class name="PrinterDC" oldname="wxPrinterDC" module="gdi">
+ <class name="PrinterDC" oldname="wxPrinterDC" module="_gdi">
<baseclass name="DC"/>
<constructor name="PrinterDC" overloaded="no">
- <autodoc>__init__(wxPrintData printData) -> PrinterDC</autodoc>
+ <autodoc>__init__(self, wxPrintData printData) -> PrinterDC</autodoc>
<paramlist>
<param name="printData" type="wxPrintData" default=""/>
</paramlist>
</constructor>
</class>
<pythoncode>
- class DC_old(DC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = DC.FloodFillXY
- GetPixel = DC.GetPixelXY
- DrawLine = DC.DrawLineXY
- CrossHair = DC.CrossHairXY
- DrawArc = DC.DrawArcXY
- DrawCheckMark = DC.DrawCheckMarkXY
- DrawEllipticArc = DC.DrawEllipticArcXY
- DrawPoint = DC.DrawPointXY
- DrawRectangle = DC.DrawRectangleXY
- DrawRoundedRectangle = DC.DrawRoundedRectangleXY
- DrawCircle = DC.DrawCircleXY
- DrawEllipse = DC.DrawEllipseXY
- DrawIcon = DC.DrawIconXY
- DrawBitmap = DC.DrawBitmapXY
- DrawText = DC.DrawTextXY
- DrawRotatedText = DC.DrawRotatedTextXY
- Blit = DC.BlitXY
- </pythoncode>
- <pythoncode>
- class MemoryDC_old(MemoryDC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = MemoryDC.FloodFillXY
- GetPixel = MemoryDC.GetPixelXY
- DrawLine = MemoryDC.DrawLineXY
- CrossHair = MemoryDC.CrossHairXY
- DrawArc = MemoryDC.DrawArcXY
- DrawCheckMark = MemoryDC.DrawCheckMarkXY
- DrawEllipticArc = MemoryDC.DrawEllipticArcXY
- DrawPoint = MemoryDC.DrawPointXY
- DrawRectangle = MemoryDC.DrawRectangleXY
- DrawRoundedRectangle = MemoryDC.DrawRoundedRectangleXY
- DrawCircle = MemoryDC.DrawCircleXY
- DrawEllipse = MemoryDC.DrawEllipseXY
- DrawIcon = MemoryDC.DrawIconXY
- DrawBitmap = MemoryDC.DrawBitmapXY
- DrawText = MemoryDC.DrawTextXY
- DrawRotatedText = MemoryDC.DrawRotatedTextXY
- Blit = MemoryDC.BlitXY
- </pythoncode>
- <pythoncode>
- class BufferedDC_old(BufferedDC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = BufferedDC.FloodFillXY
- GetPixel = BufferedDC.GetPixelXY
- DrawLine = BufferedDC.DrawLineXY
- CrossHair = BufferedDC.CrossHairXY
- DrawArc = BufferedDC.DrawArcXY
- DrawCheckMark = BufferedDC.DrawCheckMarkXY
- DrawEllipticArc = BufferedDC.DrawEllipticArcXY
- DrawPoint = BufferedDC.DrawPointXY
- DrawRectangle = BufferedDC.DrawRectangleXY
- DrawRoundedRectangle = BufferedDC.DrawRoundedRectangleXY
- DrawCircle = BufferedDC.DrawCircleXY
- DrawEllipse = BufferedDC.DrawEllipseXY
- DrawIcon = BufferedDC.DrawIconXY
- DrawBitmap = BufferedDC.DrawBitmapXY
- DrawText = BufferedDC.DrawTextXY
- DrawRotatedText = BufferedDC.DrawRotatedTextXY
- Blit = BufferedDC.BlitXY
- </pythoncode>
- <pythoncode>
- class BufferedPaintDC_old(BufferedPaintDC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = BufferedPaintDC.FloodFillXY
- GetPixel = BufferedPaintDC.GetPixelXY
- DrawLine = BufferedPaintDC.DrawLineXY
- CrossHair = BufferedPaintDC.CrossHairXY
- DrawArc = BufferedPaintDC.DrawArcXY
- DrawCheckMark = BufferedPaintDC.DrawCheckMarkXY
- DrawEllipticArc = BufferedPaintDC.DrawEllipticArcXY
- DrawPoint = BufferedPaintDC.DrawPointXY
- DrawRectangle = BufferedPaintDC.DrawRectangleXY
- DrawRoundedRectangle = BufferedPaintDC.DrawRoundedRectangleXY
- DrawCircle = BufferedPaintDC.DrawCircleXY
- DrawEllipse = BufferedPaintDC.DrawEllipseXY
- DrawIcon = BufferedPaintDC.DrawIconXY
- DrawBitmap = BufferedPaintDC.DrawBitmapXY
- DrawText = BufferedPaintDC.DrawTextXY
- DrawRotatedText = BufferedPaintDC.DrawRotatedTextXY
- Blit = BufferedPaintDC.BlitXY
- </pythoncode>
- <pythoncode>
- class ScreenDC_old(ScreenDC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = ScreenDC.FloodFillXY
- GetPixel = ScreenDC.GetPixelXY
- DrawLine = ScreenDC.DrawLineXY
- CrossHair = ScreenDC.CrossHairXY
- DrawArc = ScreenDC.DrawArcXY
- DrawCheckMark = ScreenDC.DrawCheckMarkXY
- DrawEllipticArc = ScreenDC.DrawEllipticArcXY
- DrawPoint = ScreenDC.DrawPointXY
- DrawRectangle = ScreenDC.DrawRectangleXY
- DrawRoundedRectangle = ScreenDC.DrawRoundedRectangleXY
- DrawCircle = ScreenDC.DrawCircleXY
- DrawEllipse = ScreenDC.DrawEllipseXY
- DrawIcon = ScreenDC.DrawIconXY
- DrawBitmap = ScreenDC.DrawBitmapXY
- DrawText = ScreenDC.DrawTextXY
- DrawRotatedText = ScreenDC.DrawRotatedTextXY
- Blit = ScreenDC.BlitXY
- </pythoncode>
- <pythoncode>
- class ClientDC_old(ClientDC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = ClientDC.FloodFillXY
- GetPixel = ClientDC.GetPixelXY
- DrawLine = ClientDC.DrawLineXY
- CrossHair = ClientDC.CrossHairXY
- DrawArc = ClientDC.DrawArcXY
- DrawCheckMark = ClientDC.DrawCheckMarkXY
- DrawEllipticArc = ClientDC.DrawEllipticArcXY
- DrawPoint = ClientDC.DrawPointXY
- DrawRectangle = ClientDC.DrawRectangleXY
- DrawRoundedRectangle = ClientDC.DrawRoundedRectangleXY
- DrawCircle = ClientDC.DrawCircleXY
- DrawEllipse = ClientDC.DrawEllipseXY
- DrawIcon = ClientDC.DrawIconXY
- DrawBitmap = ClientDC.DrawBitmapXY
- DrawText = ClientDC.DrawTextXY
- DrawRotatedText = ClientDC.DrawRotatedTextXY
- Blit = ClientDC.BlitXY
- </pythoncode>
- <pythoncode>
- class PaintDC_old(PaintDC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = PaintDC.FloodFillXY
- GetPixel = PaintDC.GetPixelXY
- DrawLine = PaintDC.DrawLineXY
- CrossHair = PaintDC.CrossHairXY
- DrawArc = PaintDC.DrawArcXY
- DrawCheckMark = PaintDC.DrawCheckMarkXY
- DrawEllipticArc = PaintDC.DrawEllipticArcXY
- DrawPoint = PaintDC.DrawPointXY
- DrawRectangle = PaintDC.DrawRectangleXY
- DrawRoundedRectangle = PaintDC.DrawRoundedRectangleXY
- DrawCircle = PaintDC.DrawCircleXY
- DrawEllipse = PaintDC.DrawEllipseXY
- DrawIcon = PaintDC.DrawIconXY
- DrawBitmap = PaintDC.DrawBitmapXY
- DrawText = PaintDC.DrawTextXY
- DrawRotatedText = PaintDC.DrawRotatedTextXY
- Blit = PaintDC.BlitXY
- </pythoncode>
- <pythoncode>
- class WindowDC_old(WindowDC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = WindowDC.FloodFillXY
- GetPixel = WindowDC.GetPixelXY
- DrawLine = WindowDC.DrawLineXY
- CrossHair = WindowDC.CrossHairXY
- DrawArc = WindowDC.DrawArcXY
- DrawCheckMark = WindowDC.DrawCheckMarkXY
- DrawEllipticArc = WindowDC.DrawEllipticArcXY
- DrawPoint = WindowDC.DrawPointXY
- DrawRectangle = WindowDC.DrawRectangleXY
- DrawRoundedRectangle = WindowDC.DrawRoundedRectangleXY
- DrawCircle = WindowDC.DrawCircleXY
- DrawEllipse = WindowDC.DrawEllipseXY
- DrawIcon = WindowDC.DrawIconXY
- DrawBitmap = WindowDC.DrawBitmapXY
- DrawText = WindowDC.DrawTextXY
- DrawRotatedText = WindowDC.DrawRotatedTextXY
- Blit = WindowDC.BlitXY
- </pythoncode>
- <pythoncode>
- class MirrorDC_old(MirrorDC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = MirrorDC.FloodFillXY
- GetPixel = MirrorDC.GetPixelXY
- DrawLine = MirrorDC.DrawLineXY
- CrossHair = MirrorDC.CrossHairXY
- DrawArc = MirrorDC.DrawArcXY
- DrawCheckMark = MirrorDC.DrawCheckMarkXY
- DrawEllipticArc = MirrorDC.DrawEllipticArcXY
- DrawPoint = MirrorDC.DrawPointXY
- DrawRectangle = MirrorDC.DrawRectangleXY
- DrawRoundedRectangle = MirrorDC.DrawRoundedRectangleXY
- DrawCircle = MirrorDC.DrawCircleXY
- DrawEllipse = MirrorDC.DrawEllipseXY
- DrawIcon = MirrorDC.DrawIconXY
- DrawBitmap = MirrorDC.DrawBitmapXY
- DrawText = MirrorDC.DrawTextXY
- DrawRotatedText = MirrorDC.DrawRotatedTextXY
- Blit = MirrorDC.BlitXY
- </pythoncode>
- <pythoncode>
- class PostScriptDC_old(PostScriptDC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = PostScriptDC.FloodFillXY
- GetPixel = PostScriptDC.GetPixelXY
- DrawLine = PostScriptDC.DrawLineXY
- CrossHair = PostScriptDC.CrossHairXY
- DrawArc = PostScriptDC.DrawArcXY
- DrawCheckMark = PostScriptDC.DrawCheckMarkXY
- DrawEllipticArc = PostScriptDC.DrawEllipticArcXY
- DrawPoint = PostScriptDC.DrawPointXY
- DrawRectangle = PostScriptDC.DrawRectangleXY
- DrawRoundedRectangle = PostScriptDC.DrawRoundedRectangleXY
- DrawCircle = PostScriptDC.DrawCircleXY
- DrawEllipse = PostScriptDC.DrawEllipseXY
- DrawIcon = PostScriptDC.DrawIconXY
- DrawBitmap = PostScriptDC.DrawBitmapXY
- DrawText = PostScriptDC.DrawTextXY
- DrawRotatedText = PostScriptDC.DrawRotatedTextXY
- Blit = PostScriptDC.BlitXY
- </pythoncode>
- <pythoncode>
- class MetaFileDC_old(MetaFileDC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = MetaFileDC.FloodFillXY
- GetPixel = MetaFileDC.GetPixelXY
- DrawLine = MetaFileDC.DrawLineXY
- CrossHair = MetaFileDC.CrossHairXY
- DrawArc = MetaFileDC.DrawArcXY
- DrawCheckMark = MetaFileDC.DrawCheckMarkXY
- DrawEllipticArc = MetaFileDC.DrawEllipticArcXY
- DrawPoint = MetaFileDC.DrawPointXY
- DrawRectangle = MetaFileDC.DrawRectangleXY
- DrawRoundedRectangle = MetaFileDC.DrawRoundedRectangleXY
- DrawCircle = MetaFileDC.DrawCircleXY
- DrawEllipse = MetaFileDC.DrawEllipseXY
- DrawIcon = MetaFileDC.DrawIconXY
- DrawBitmap = MetaFileDC.DrawBitmapXY
- DrawText = MetaFileDC.DrawTextXY
- DrawRotatedText = MetaFileDC.DrawRotatedTextXY
- Blit = MetaFileDC.BlitXY
- </pythoncode>
- <pythoncode>
- class PrinterDC_old(PrinterDC):
- """DC class that has methods with 2.4 compatible parameters."""
- FloodFill = PrinterDC.FloodFillXY
- GetPixel = PrinterDC.GetPixelXY
- DrawLine = PrinterDC.DrawLineXY
- CrossHair = PrinterDC.CrossHairXY
- DrawArc = PrinterDC.DrawArcXY
- DrawCheckMark = PrinterDC.DrawCheckMarkXY
- DrawEllipticArc = PrinterDC.DrawEllipticArcXY
- DrawPoint = PrinterDC.DrawPointXY
- DrawRectangle = PrinterDC.DrawRectangleXY
- DrawRoundedRectangle = PrinterDC.DrawRoundedRectangleXY
- DrawCircle = PrinterDC.DrawCircleXY
- DrawEllipse = PrinterDC.DrawEllipseXY
- DrawIcon = PrinterDC.DrawIconXY
- DrawBitmap = PrinterDC.DrawBitmapXY
- DrawText = PrinterDC.DrawTextXY
- DrawRotatedText = PrinterDC.DrawRotatedTextXY
- Blit = PrinterDC.BlitXY
- </pythoncode>
- <pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ImageList" oldname="wxImageList" module="gdi">
+ <class name="ImageList" oldname="wxImageList" module="_gdi">
<baseclass name="Object"/>
<constructor name="ImageList" overloaded="no">
- <autodoc>__init__(int width, int height, int mask=True, int initialCount=1) -> ImageList</autodoc>
+ <autodoc>__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</constructor>
<destructor name="~wxImageList" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Add" type="int" overloaded="no">
- <autodoc>Add(Bitmap bitmap, Bitmap mask=NullBitmap) -> int</autodoc>
+ <autodoc>Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int</autodoc>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
<param name="mask" type="Bitmap" default="wxNullBitmap"/>
</paramlist>
</method>
<method name="AddWithColourMask" type="int" overloaded="no">
- <autodoc>AddWithColourMask(Bitmap bitmap, Colour maskColour) -> int</autodoc>
+ <autodoc>AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int</autodoc>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
<param name="maskColour" type="Colour" default=""/>
</paramlist>
</method>
<method name="AddIcon" type="int" overloaded="no">
- <autodoc>AddIcon(Icon icon) -> int</autodoc>
+ <autodoc>AddIcon(self, Icon icon) -> int</autodoc>
<paramlist>
<param name="icon" type="Icon" default=""/>
</paramlist>
</method>
<method name="Replace" type="bool" overloaded="no">
- <autodoc>Replace(int index, Bitmap bitmap) -> bool</autodoc>
+ <autodoc>Replace(self, int index, Bitmap bitmap) -> bool</autodoc>
<paramlist>
<param name="index" type="int" default=""/>
<param name="bitmap" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="Draw" type="bool" overloaded="no">
- <autodoc>Draw(int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
+ <autodoc>Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
bool solidBackground=False) -> bool</autodoc>
<paramlist>
<param name="index" type="int" default=""/>
</paramlist>
</method>
<method name="GetImageCount" type="int" overloaded="no">
- <autodoc>GetImageCount() -> int</autodoc>
+ <autodoc>GetImageCount(self) -> int</autodoc>
</method>
<method name="Remove" type="bool" overloaded="no">
- <autodoc>Remove(int index) -> bool</autodoc>
+ <autodoc>Remove(self, int index) -> bool</autodoc>
<paramlist>
<param name="index" type="int" default=""/>
</paramlist>
</method>
<method name="RemoveAll" type="bool" overloaded="no">
- <autodoc>RemoveAll() -> bool</autodoc>
+ <autodoc>RemoveAll(self) -> bool</autodoc>
</method>
<method name="GetSize" type="" overloaded="no">
<autodoc>GetSize() -> (width,height)</autodoc>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PenList" oldname="wxPenList" module="gdi">
+ <class name="PenList" oldname="wxPenList" module="_gdi">
<baseclass name="Object"/>
<method name="AddPen" type="" overloaded="no">
- <autodoc>AddPen(Pen pen)</autodoc>
+ <autodoc>AddPen(self, Pen pen)</autodoc>
<paramlist>
<param name="pen" type="Pen" default=""/>
</paramlist>
</method>
<method name="FindOrCreatePen" type="Pen" overloaded="no">
- <autodoc>FindOrCreatePen(Colour colour, int width, int style) -> Pen</autodoc>
+ <autodoc>FindOrCreatePen(self, Colour colour, int width, int style) -> Pen</autodoc>
<paramlist>
<param name="colour" type="Colour" default=""/>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="RemovePen" type="" overloaded="no">
- <autodoc>RemovePen(Pen pen)</autodoc>
+ <autodoc>RemovePen(self, Pen pen)</autodoc>
<paramlist>
<param name="pen" type="Pen" default=""/>
</paramlist>
</method>
<method name="GetCount" type="int" overloaded="no">
- <autodoc>GetCount() -> int</autodoc>
+ <autodoc>GetCount(self) -> int</autodoc>
</method>
</class>
- <class name="BrushList" oldname="wxBrushList" module="gdi">
+ <class name="BrushList" oldname="wxBrushList" module="_gdi">
<baseclass name="Object"/>
<method name="AddBrush" type="" overloaded="no">
- <autodoc>AddBrush(Brush brush)</autodoc>
+ <autodoc>AddBrush(self, Brush brush)</autodoc>
<paramlist>
<param name="brush" type="Brush" default=""/>
</paramlist>
</method>
<method name="FindOrCreateBrush" type="Brush" overloaded="no">
- <autodoc>FindOrCreateBrush(Colour colour, int style) -> Brush</autodoc>
+ <autodoc>FindOrCreateBrush(self, Colour colour, int style) -> Brush</autodoc>
<paramlist>
<param name="colour" type="Colour" default=""/>
<param name="style" type="int" default=""/>
</paramlist>
</method>
<method name="RemoveBrush" type="" overloaded="no">
- <autodoc>RemoveBrush(Brush brush)</autodoc>
+ <autodoc>RemoveBrush(self, Brush brush)</autodoc>
<paramlist>
<param name="brush" type="Brush" default=""/>
</paramlist>
</method>
<method name="GetCount" type="int" overloaded="no">
- <autodoc>GetCount() -> int</autodoc>
+ <autodoc>GetCount(self) -> int</autodoc>
</method>
</class>
- <class name="ColourDatabase" oldname="wxColourDatabase" module="gdi">
+ <class name="ColourDatabase" oldname="wxColourDatabase" module="_gdi">
<baseclass name="Object"/>
<constructor name="ColourDatabase" overloaded="no">
- <autodoc>__init__() -> ColourDatabase</autodoc>
+ <autodoc>__init__(self) -> ColourDatabase</autodoc>
</constructor>
<destructor name="~wxColourDatabase" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Find" type="Colour" overloaded="no">
- <autodoc>Find(String name) -> Colour</autodoc>
+ <autodoc>Find(self, String name) -> Colour</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="FindName" type="String" overloaded="no">
- <autodoc>FindName(Colour colour) -> String</autodoc>
+ <autodoc>FindName(self, Colour colour) -> String</autodoc>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="AddColour" type="" overloaded="no">
- <autodoc>AddColour(String name, Colour colour)</autodoc>
+ <autodoc>AddColour(self, String name, Colour colour)</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="Append" type="" overloaded="no">
- <autodoc>Append(String name, int red, int green, int blue)</autodoc>
+ <autodoc>Append(self, String name, int red, int green, int blue)</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="red" type="int" default=""/>
</paramlist>
</method>
</class>
- <class name="FontList" oldname="wxFontList" module="gdi">
+ <class name="FontList" oldname="wxFontList" module="_gdi">
<baseclass name="Object"/>
<method name="AddFont" type="" overloaded="no">
- <autodoc>AddFont(Font font)</autodoc>
+ <autodoc>AddFont(self, Font font)</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="FindOrCreateFont" type="Font" overloaded="no">
- <autodoc>FindOrCreateFont(int point_size, int family, int style, int weight,
+ <autodoc>FindOrCreateFont(self, int point_size, int family, int style, int weight,
bool underline=False, String facename=EmptyString,
int encoding=FONTENCODING_DEFAULT) -> Font</autodoc>
<paramlist>
</paramlist>
</method>
<method name="RemoveFont" type="" overloaded="no">
- <autodoc>RemoveFont(Font font)</autodoc>
+ <autodoc>RemoveFont(self, Font font)</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="GetCount" type="int" overloaded="no">
- <autodoc>GetCount() -> int</autodoc>
+ <autodoc>GetCount(self) -> int</autodoc>
</method>
</class>
<pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Effects" oldname="wxEffects" module="gdi">
+ <class name="Effects" oldname="wxEffects" module="_gdi">
<baseclass name="Object"/>
<constructor name="Effects" overloaded="no">
- <autodoc>__init__() -> Effects</autodoc>
+ <autodoc>__init__(self) -> Effects</autodoc>
</constructor>
<method name="GetHighlightColour" type="Colour" overloaded="no">
- <autodoc>GetHighlightColour() -> Colour</autodoc>
+ <autodoc>GetHighlightColour(self) -> Colour</autodoc>
</method>
<method name="GetLightShadow" type="Colour" overloaded="no">
- <autodoc>GetLightShadow() -> Colour</autodoc>
+ <autodoc>GetLightShadow(self) -> Colour</autodoc>
</method>
<method name="GetFaceColour" type="Colour" overloaded="no">
- <autodoc>GetFaceColour() -> Colour</autodoc>
+ <autodoc>GetFaceColour(self) -> Colour</autodoc>
</method>
<method name="GetMediumShadow" type="Colour" overloaded="no">
- <autodoc>GetMediumShadow() -> Colour</autodoc>
+ <autodoc>GetMediumShadow(self) -> Colour</autodoc>
</method>
<method name="GetDarkShadow" type="Colour" overloaded="no">
- <autodoc>GetDarkShadow() -> Colour</autodoc>
+ <autodoc>GetDarkShadow(self) -> Colour</autodoc>
</method>
<method name="SetHighlightColour" type="" overloaded="no">
- <autodoc>SetHighlightColour(Colour c)</autodoc>
+ <autodoc>SetHighlightColour(self, Colour c)</autodoc>
<paramlist>
<param name="c" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetLightShadow" type="" overloaded="no">
- <autodoc>SetLightShadow(Colour c)</autodoc>
+ <autodoc>SetLightShadow(self, Colour c)</autodoc>
<paramlist>
<param name="c" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetFaceColour" type="" overloaded="no">
- <autodoc>SetFaceColour(Colour c)</autodoc>
+ <autodoc>SetFaceColour(self, Colour c)</autodoc>
<paramlist>
<param name="c" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetMediumShadow" type="" overloaded="no">
- <autodoc>SetMediumShadow(Colour c)</autodoc>
+ <autodoc>SetMediumShadow(self, Colour c)</autodoc>
<paramlist>
<param name="c" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetDarkShadow" type="" overloaded="no">
- <autodoc>SetDarkShadow(Colour c)</autodoc>
+ <autodoc>SetDarkShadow(self, Colour c)</autodoc>
<paramlist>
<param name="c" type="Colour" default=""/>
</paramlist>
</method>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(Colour highlightColour, Colour lightShadow, Colour faceColour,
+ <autodoc>Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
Colour mediumShadow, Colour darkShadow)</autodoc>
<paramlist>
<param name="highlightColour" type="Colour" default=""/>
</paramlist>
</method>
<method name="DrawSunkenEdge" type="" overloaded="no">
- <autodoc>DrawSunkenEdge(DC dc, Rect rect, int borderSize=1)</autodoc>
+ <autodoc>DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="TileBitmap" type="bool" overloaded="no">
- <autodoc>TileBitmap(Rect rect, DC dc, Bitmap bitmap) -> bool</autodoc>
+ <autodoc>TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
<param name="dc" type="DC" default=""/>
</method>
</class>
</module>
- <module name="windows">
- <import name="core"/>
- <pythoncode> wx = core </pythoncode>
+ <module name="_windows">
+ <import name="_core"/>
+ <pythoncode> wx = _core </pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Panel" oldname="wxPanel" module="windows">
+ <class name="Panel" oldname="wxPanel" module="_windows">
<baseclass name="Window"/>
<constructor name="Panel" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER,
String name=PanelNameStr) -> Panel</autodoc>
<paramlist>
<autodoc>PrePanel() -> Panel</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=wxTAB_TRAVERSAL|wxNO_BORDER,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER,
String name=PanelNameStr) -> bool</autodoc>
- <docstring>Create the GUI part of the Window for 2-phase creation mode.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxTAB_TRAVERSAL|wxNO_BORDER"/>
</paramlist>
</method>
<method name="InitDialog" type="" overloaded="no">
- <autodoc>InitDialog()</autodoc>
+ <autodoc>InitDialog(self)</autodoc>
+ <docstring>Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
+to the dialog via validators.</docstring>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ScrolledWindow" oldname="wxScrolledWindow" module="windows">
+ <class name="ScrolledWindow" oldname="wxScrolledWindow" module="_windows">
<baseclass name="Panel"/>
<constructor name="ScrolledWindow" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL,
String name=PanelNameStr) -> ScrolledWindow</autodoc>
<paramlist>
<autodoc>PreScrolledWindow() -> ScrolledWindow</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL,
String name=PanelNameStr) -> bool</autodoc>
- <docstring>Create the GUI part of the Window for 2-phase creation mode.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default="-1"/>
</paramlist>
</method>
<method name="SetScrollbars" type="" overloaded="no">
- <autodoc>SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX,
+ <autodoc>SetScrollbars(self, int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX,
int noUnitsY, int xPos=0, int yPos=0, bool noRefresh=False)</autodoc>
<paramlist>
<param name="pixelsPerUnitX" type="int" default=""/>
</paramlist>
</method>
<method name="Scroll" type="" overloaded="no">
- <autodoc>Scroll(int x, int y)</autodoc>
+ <autodoc>Scroll(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="GetScrollPageSize" type="int" overloaded="no">
- <autodoc>GetScrollPageSize(int orient) -> int</autodoc>
+ <autodoc>GetScrollPageSize(self, int orient) -> int</autodoc>
<paramlist>
<param name="orient" type="int" default=""/>
</paramlist>
</method>
<method name="SetScrollPageSize" type="" overloaded="no">
- <autodoc>SetScrollPageSize(int orient, int pageSize)</autodoc>
+ <autodoc>SetScrollPageSize(self, int orient, int pageSize)</autodoc>
<paramlist>
<param name="orient" type="int" default=""/>
<param name="pageSize" type="int" default=""/>
</paramlist>
</method>
<method name="SetScrollRate" type="" overloaded="no">
- <autodoc>SetScrollRate(int xstep, int ystep)</autodoc>
+ <autodoc>SetScrollRate(self, int xstep, int ystep)</autodoc>
<paramlist>
<param name="xstep" type="int" default=""/>
<param name="ystep" type="int" default=""/>
</method>
<method name="GetScrollPixelsPerUnit" type="" overloaded="no">
<autodoc>GetScrollPixelsPerUnit() -> (xUnit, yUnit)</autodoc>
- <docstring>Get the size of one logical unit in physical units.</docstring>
<paramlist>
<param name="OUTPUT" type="int" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="EnableScrolling" type="" overloaded="no">
- <autodoc>EnableScrolling(bool x_scrolling, bool y_scrolling)</autodoc>
+ <autodoc>EnableScrolling(self, bool x_scrolling, bool y_scrolling)</autodoc>
<paramlist>
<param name="x_scrolling" type="bool" default=""/>
<param name="y_scrolling" type="bool" default=""/>
</method>
<method name="GetViewStart" type="" overloaded="no">
<autodoc>GetViewStart() -> (x,y)</autodoc>
- <docstring>Get the view start</docstring>
<paramlist>
<param name="OUTPUT" type="int" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="SetScale" type="" overloaded="no">
- <autodoc>SetScale(double xs, double ys)</autodoc>
+ <autodoc>SetScale(self, double xs, double ys)</autodoc>
<paramlist>
<param name="xs" type="double" default=""/>
<param name="ys" type="double" default=""/>
</paramlist>
</method>
<method name="GetScaleX" type="double" overloaded="no">
- <autodoc>GetScaleX() -> double</autodoc>
+ <autodoc>GetScaleX(self) -> double</autodoc>
</method>
<method name="GetScaleY" type="double" overloaded="no">
- <autodoc>GetScaleY() -> double</autodoc>
+ <autodoc>GetScaleY(self) -> double</autodoc>
</method>
<method name="CalcScrolledPosition" type="Point" overloaded="yes">
<docstring>Translate between scrolled and unscrolled coordinates.</docstring>
</paramlist>
</method>
<method name="CalcScrolledPosition" type="" overloaded="yes">
- <autodoc>CalcScrolledPosition(Point pt) -> Point
+ <autodoc>CalcScrolledPosition(self, Point pt) -> Point
CalcScrolledPosition(int x, int y) -> (sx, sy)</autodoc>
<docstring>Translate between scrolled and unscrolled coordinates.</docstring>
<paramlist>
</paramlist>
</method>
<method name="CalcUnscrolledPosition" type="" overloaded="yes">
- <autodoc>CalcUnscrolledPosition(Point pt) -> Point
+ <autodoc>CalcUnscrolledPosition(self, Point pt) -> Point
CalcUnscrolledPosition(int x, int y) -> (ux, uy)</autodoc>
<docstring>Translate between scrolled and unscrolled coordinates.</docstring>
<paramlist>
</paramlist>
</method>
<method name="AdjustScrollbars" type="" overloaded="no">
- <autodoc>AdjustScrollbars()</autodoc>
+ <autodoc>AdjustScrollbars(self)</autodoc>
</method>
<method name="CalcScrollInc" type="int" overloaded="no">
- <autodoc>CalcScrollInc(ScrollWinEvent event) -> int</autodoc>
+ <autodoc>CalcScrollInc(self, ScrollWinEvent event) -> int</autodoc>
<paramlist>
<param name="event" type="ScrollWinEvent" default=""/>
</paramlist>
</method>
<method name="SetTargetWindow" type="" overloaded="no">
- <autodoc>SetTargetWindow(Window target)</autodoc>
+ <autodoc>SetTargetWindow(self, Window target)</autodoc>
<paramlist>
<param name="target" type="Window" default=""/>
</paramlist>
</method>
<method name="GetTargetWindow" type="Window" overloaded="no">
- <autodoc>GetTargetWindow() -> Window</autodoc>
+ <autodoc>GetTargetWindow(self) -> Window</autodoc>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="TopLevelWindow" oldname="wxTopLevelWindow" module="windows">
+ <class name="TopLevelWindow" oldname="wxTopLevelWindow" module="_windows">
<baseclass name="Window"/>
<method name="Maximize" type="" overloaded="no">
- <autodoc>Maximize(bool maximize=True)</autodoc>
+ <autodoc>Maximize(self, bool maximize=True)</autodoc>
<paramlist>
<param name="maximize" type="bool" default="True"/>
</paramlist>
</method>
<method name="Restore" type="" overloaded="no">
- <autodoc>Restore()</autodoc>
+ <autodoc>Restore(self)</autodoc>
</method>
<method name="Iconize" type="" overloaded="no">
- <autodoc>Iconize(bool iconize=True)</autodoc>
+ <autodoc>Iconize(self, bool iconize=True)</autodoc>
<paramlist>
<param name="iconize" type="bool" default="True"/>
</paramlist>
</method>
<method name="IsMaximized" type="bool" overloaded="no">
- <autodoc>IsMaximized() -> bool</autodoc>
+ <autodoc>IsMaximized(self) -> bool</autodoc>
</method>
<method name="IsIconized" type="bool" overloaded="no">
- <autodoc>IsIconized() -> bool</autodoc>
+ <autodoc>IsIconized(self) -> bool</autodoc>
</method>
<method name="GetIcon" type="Icon" overloaded="no">
- <autodoc>GetIcon() -> Icon</autodoc>
+ <autodoc>GetIcon(self) -> Icon</autodoc>
</method>
<method name="SetIcon" type="" overloaded="no">
- <autodoc>SetIcon(Icon icon)</autodoc>
+ <autodoc>SetIcon(self, Icon icon)</autodoc>
<paramlist>
<param name="icon" type="Icon" default=""/>
</paramlist>
</method>
<method name="SetIcons" type="" overloaded="no">
- <autodoc>SetIcons(wxIconBundle icons)</autodoc>
+ <autodoc>SetIcons(self, wxIconBundle icons)</autodoc>
<paramlist>
<param name="icons" type="IconBundle" default=""/>
</paramlist>
</method>
<method name="ShowFullScreen" type="bool" overloaded="no">
- <autodoc>ShowFullScreen(bool show, long style=FULLSCREEN_ALL) -> bool</autodoc>
+ <autodoc>ShowFullScreen(self, bool show, long style=FULLSCREEN_ALL) -> bool</autodoc>
<paramlist>
<param name="show" type="bool" default=""/>
<param name="style" type="long" default="wxFULLSCREEN_ALL"/>
</paramlist>
</method>
<method name="IsFullScreen" type="bool" overloaded="no">
- <autodoc>IsFullScreen() -> bool</autodoc>
+ <autodoc>IsFullScreen(self) -> bool</autodoc>
</method>
<method name="SetTitle" type="" overloaded="no">
- <autodoc>SetTitle(String title)</autodoc>
+ <autodoc>SetTitle(self, String title)</autodoc>
<docstring>Sets the window's title. Applicable only to frames and dialogs.</docstring>
<paramlist>
<param name="title" type="String" default=""/>
</paramlist>
</method>
<method name="GetTitle" type="String" overloaded="no">
- <autodoc>GetTitle() -> String</autodoc>
+ <autodoc>GetTitle(self) -> String</autodoc>
<docstring>Gets the window's title. Applicable only to frames and dialogs.</docstring>
</method>
<method name="SetShape" type="bool" overloaded="no">
- <autodoc>SetShape(Region region) -> bool</autodoc>
+ <autodoc>SetShape(self, Region region) -> bool</autodoc>
<paramlist>
<param name="region" type="Region" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Frame" oldname="wxFrame" module="windows">
+ <class name="Frame" oldname="wxFrame" module="_windows">
<baseclass name="TopLevelWindow"/>
<constructor name="Frame" overloaded="no">
- <autodoc>__init__(Window parent, int id, String title, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
- String name=FrameNameStr) -> Frame</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, String title=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> Frame</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="title" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="title" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxDEFAULT_FRAME_STYLE"/>
<autodoc>PreFrame() -> Frame</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String title, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
- String name=FrameNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, String title=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="title" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="title" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxDEFAULT_FRAME_STYLE"/>
</paramlist>
</method>
<method name="GetClientAreaOrigin" type="Point" overloaded="no">
- <autodoc>GetClientAreaOrigin() -> Point</autodoc>
+ <autodoc>GetClientAreaOrigin(self) -> Point</autodoc>
<docstring>Get the origin of the client area of the window relative to the
window's top left corner (the client area may be shifted because of
the borders, scrollbars, other decorations...)</docstring>
</method>
<method name="SendSizeEvent" type="" overloaded="no">
- <autodoc>SendSizeEvent()</autodoc>
+ <autodoc>SendSizeEvent(self)</autodoc>
</method>
<method name="SetMenuBar" type="" overloaded="no">
- <autodoc>SetMenuBar(MenuBar menubar)</autodoc>
+ <autodoc>SetMenuBar(self, MenuBar menubar)</autodoc>
<paramlist>
<param name="menubar" type="MenuBar" default=""/>
</paramlist>
</method>
<method name="GetMenuBar" type="MenuBar" overloaded="no">
- <autodoc>GetMenuBar() -> MenuBar</autodoc>
+ <autodoc>GetMenuBar(self) -> MenuBar</autodoc>
</method>
<method name="ProcessCommand" type="bool" overloaded="no">
- <autodoc>ProcessCommand(int winid) -> bool</autodoc>
+ <autodoc>ProcessCommand(self, int winid) -> bool</autodoc>
<paramlist>
<param name="winid" type="int" default=""/>
</paramlist>
</method>
<method name="CreateStatusBar" type="wxStatusBar" overloaded="no">
- <autodoc>CreateStatusBar(int number=1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
+ <autodoc>CreateStatusBar(self, int number=1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
int winid=0, String name=StatusLineNameStr) -> StatusBar</autodoc>
<paramlist>
<param name="number" type="int" default="1"/>
</paramlist>
</method>
<method name="GetStatusBar" type="wxStatusBar" overloaded="no">
- <autodoc>GetStatusBar() -> StatusBar</autodoc>
+ <autodoc>GetStatusBar(self) -> StatusBar</autodoc>
</method>
<method name="SetStatusBar" type="" overloaded="no">
- <autodoc>SetStatusBar(StatusBar statBar)</autodoc>
+ <autodoc>SetStatusBar(self, StatusBar statBar)</autodoc>
<paramlist>
<param name="statBar" type="wxStatusBar" default=""/>
</paramlist>
</method>
<method name="SetStatusText" type="" overloaded="no">
- <autodoc>SetStatusText(String text, int number=0)</autodoc>
+ <autodoc>SetStatusText(self, String text, int number=0)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="number" type="int" default="0"/>
</paramlist>
</method>
<method name="SetStatusWidths" type="" overloaded="no">
- <autodoc>SetStatusWidths(int widths, int widths_field)</autodoc>
+ <autodoc>SetStatusWidths(self, int widths, int widths_field)</autodoc>
<paramlist>
<param name="widths" type="int" default=""/>
<param name="widths_field" type="int" default=""/>
</paramlist>
</method>
<method name="PushStatusText" type="" overloaded="no">
- <autodoc>PushStatusText(String text, int number=0)</autodoc>
+ <autodoc>PushStatusText(self, String text, int number=0)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="number" type="int" default="0"/>
</paramlist>
</method>
<method name="PopStatusText" type="" overloaded="no">
- <autodoc>PopStatusText(int number=0)</autodoc>
+ <autodoc>PopStatusText(self, int number=0)</autodoc>
<paramlist>
<param name="number" type="int" default="0"/>
</paramlist>
</method>
<method name="SetStatusBarPane" type="" overloaded="no">
- <autodoc>SetStatusBarPane(int n)</autodoc>
+ <autodoc>SetStatusBarPane(self, int n)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetStatusBarPane" type="int" overloaded="no">
- <autodoc>GetStatusBarPane() -> int</autodoc>
+ <autodoc>GetStatusBarPane(self) -> int</autodoc>
</method>
<method name="CreateToolBar" type="wxToolBar" overloaded="no">
- <autodoc>CreateToolBar(long style=-1, int winid=-1, String name=ToolBarNameStr) -> wxToolBar</autodoc>
+ <autodoc>CreateToolBar(self, long style=-1, int winid=-1, String name=ToolBarNameStr) -> wxToolBar</autodoc>
<paramlist>
<param name="style" type="long" default="-1"/>
<param name="winid" type="int" default="-1"/>
</paramlist>
</method>
<method name="GetToolBar" type="wxToolBar" overloaded="no">
- <autodoc>GetToolBar() -> wxToolBar</autodoc>
+ <autodoc>GetToolBar(self) -> wxToolBar</autodoc>
</method>
<method name="SetToolBar" type="" overloaded="no">
- <autodoc>SetToolBar(wxToolBar toolbar)</autodoc>
+ <autodoc>SetToolBar(self, wxToolBar toolbar)</autodoc>
<paramlist>
<param name="toolbar" type="wxToolBar" default=""/>
</paramlist>
</method>
<method name="DoGiveHelp" type="" overloaded="no">
- <autodoc>DoGiveHelp(String text, bool show)</autodoc>
+ <autodoc>DoGiveHelp(self, String text, bool show)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="show" type="bool" default=""/>
</paramlist>
</method>
<method name="DoMenuUpdates" type="" overloaded="no">
- <autodoc>DoMenuUpdates(Menu menu=None)</autodoc>
+ <autodoc>DoMenuUpdates(self, Menu menu=None)</autodoc>
<paramlist>
<param name="menu" type="Menu" default="NULL"/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Dialog" oldname="wxDialog" module="windows">
+ <class name="Dialog" oldname="wxDialog" module="_windows">
<baseclass name="TopLevelWindow"/>
<constructor name="Dialog" overloaded="no">
- <autodoc>__init__(Window parent, int id, String title, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=DEFAULT_DIALOG_STYLE,
- String name=DialogNameStr) -> Dialog</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, String title=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=DEFAULT_DIALOG_STYLE, String name=DialogNameStr) -> Dialog</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="title" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="title" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxDEFAULT_DIALOG_STYLE"/>
<autodoc>PreDialog() -> Dialog</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String title, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=DEFAULT_DIALOG_STYLE,
- String name=DialogNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, String title=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=DEFAULT_DIALOG_STYLE, String name=DialogNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="title" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="title" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxDEFAULT_DIALOG_STYLE"/>
</paramlist>
</method>
<method name="SetReturnCode" type="" overloaded="no">
- <autodoc>SetReturnCode(int returnCode)</autodoc>
+ <autodoc>SetReturnCode(self, int returnCode)</autodoc>
<paramlist>
<param name="returnCode" type="int" default=""/>
</paramlist>
</method>
<method name="GetReturnCode" type="int" overloaded="no">
- <autodoc>GetReturnCode() -> int</autodoc>
+ <autodoc>GetReturnCode(self) -> int</autodoc>
</method>
<method name="CreateTextSizer" type="Sizer" overloaded="no">
- <autodoc>CreateTextSizer(String message) -> Sizer</autodoc>
+ <autodoc>CreateTextSizer(self, String message) -> Sizer</autodoc>
<paramlist>
<param name="message" type="String" default=""/>
</paramlist>
</method>
<method name="CreateButtonSizer" type="Sizer" overloaded="no">
- <autodoc>CreateButtonSizer(long flags) -> Sizer</autodoc>
+ <autodoc>CreateButtonSizer(self, long flags) -> Sizer</autodoc>
<paramlist>
<param name="flags" type="long" default=""/>
</paramlist>
</method>
<method name="IsModal" type="bool" overloaded="no">
- <autodoc>IsModal() -> bool</autodoc>
+ <autodoc>IsModal(self) -> bool</autodoc>
</method>
<method name="ShowModal" type="int" overloaded="no">
- <autodoc>ShowModal() -> int</autodoc>
+ <autodoc>ShowModal(self) -> int</autodoc>
</method>
<method name="EndModal" type="" overloaded="no">
- <autodoc>EndModal(int retCode)</autodoc>
+ <autodoc>EndModal(self, int retCode)</autodoc>
<paramlist>
<param name="retCode" type="int" default=""/>
</paramlist>
</method>
- <method name="IsModalShowing" type="bool" overloaded="no">
- <autodoc>IsModalShowing() -> bool</autodoc>
- </method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MiniFrame" oldname="wxMiniFrame" module="windows">
+ <class name="MiniFrame" oldname="wxMiniFrame" module="_windows">
<baseclass name="Frame"/>
<constructor name="MiniFrame" overloaded="no">
- <autodoc>__init__(Window parent, int id, String title, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
- String name=FrameNameStr) -> MiniFrame</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, String title=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> MiniFrame</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="title" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="title" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxDEFAULT_FRAME_STYLE"/>
<autodoc>PreMiniFrame() -> MiniFrame</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String title, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
- String name=FrameNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, String title=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="title" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="title" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxDEFAULT_FRAME_STYLE"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="SplashScreenWindow" oldname="wxSplashScreenWindow" module="windows">
+ <class name="SplashScreenWindow" oldname="wxSplashScreenWindow" module="_windows">
<baseclass name="Window"/>
<constructor name="SplashScreenWindow" overloaded="no">
- <autodoc>__init__(Bitmap bitmap, Window parent, int id, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Bitmap bitmap, Window parent, int id, Point pos=DefaultPosition,
Size size=DefaultSize, long style=NO_BORDER) -> SplashScreenWindow</autodoc>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
</paramlist>
</constructor>
<method name="SetBitmap" type="" overloaded="no">
- <autodoc>SetBitmap(Bitmap bitmap)</autodoc>
+ <autodoc>SetBitmap(self, Bitmap bitmap)</autodoc>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="GetBitmap" type="Bitmap" overloaded="no">
- <autodoc>GetBitmap() -> Bitmap</autodoc>
+ <autodoc>GetBitmap(self) -> Bitmap</autodoc>
</method>
</class>
- <class name="SplashScreen" oldname="wxSplashScreen" module="windows">
+ <class name="SplashScreen" oldname="wxSplashScreen" module="_windows">
<baseclass name="Frame"/>
<constructor name="SplashScreen" overloaded="no">
- <autodoc>__init__(Bitmap bitmap, long splashStyle, int milliseconds,
- Window parent, int id, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Bitmap bitmap, long splashStyle, int milliseconds,
+ Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=wxSIMPLE_BORDER|wxFRAME_NO_TASKBAR|wxSTAY_ON_TOP) -> SplashScreen</autodoc>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
<param name="splashStyle" type="long" default=""/>
<param name="milliseconds" type="int" default=""/>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxSIMPLE_BORDER|wxFRAME_NO_TASKBAR|wxSTAY_ON_TOP"/>
</paramlist>
</constructor>
<method name="GetSplashStyle" type="long" overloaded="no">
- <autodoc>GetSplashStyle() -> long</autodoc>
+ <autodoc>GetSplashStyle(self) -> long</autodoc>
</method>
<method name="GetSplashWindow" type="SplashScreenWindow" overloaded="no">
- <autodoc>GetSplashWindow() -> SplashScreenWindow</autodoc>
+ <autodoc>GetSplashWindow(self) -> SplashScreenWindow</autodoc>
</method>
<method name="GetTimeout" type="int" overloaded="no">
- <autodoc>GetTimeout() -> int</autodoc>
+ <autodoc>GetTimeout(self) -> int</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="StatusBar" oldname="wxStatusBar" module="windows">
+ <class name="StatusBar" oldname="wxStatusBar" module="_windows">
<baseclass name="Window"/>
<constructor name="StatusBar" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
+ <autodoc>__init__(self, Window parent, int id=-1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
String name=StatusLineNameStr) -> StatusBar</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<autodoc>PreStatusBar() -> StatusBar</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="style" type="long" default="wxST_SIZEGRIP"/>
<param name="name" type="String" default="wxPyStatusLineNameStr"/>
</paramlist>
</method>
<method name="SetFieldsCount" type="" overloaded="no">
- <autodoc>SetFieldsCount(int number=1)</autodoc>
+ <autodoc>SetFieldsCount(self, int number=1)</autodoc>
<paramlist>
<param name="number" type="int" default="1"/>
</paramlist>
</method>
<method name="GetFieldsCount" type="int" overloaded="no">
- <autodoc>GetFieldsCount() -> int</autodoc>
+ <autodoc>GetFieldsCount(self) -> int</autodoc>
</method>
<method name="SetStatusText" type="" overloaded="no">
- <autodoc>SetStatusText(String text, int number=0)</autodoc>
+ <autodoc>SetStatusText(self, String text, int number=0)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="number" type="int" default="0"/>
</paramlist>
</method>
<method name="GetStatusText" type="String" overloaded="no">
- <autodoc>GetStatusText(int number=0) -> String</autodoc>
+ <autodoc>GetStatusText(self, int number=0) -> String</autodoc>
<paramlist>
<param name="number" type="int" default="0"/>
</paramlist>
</method>
<method name="PushStatusText" type="" overloaded="no">
- <autodoc>PushStatusText(String text, int number=0)</autodoc>
+ <autodoc>PushStatusText(self, String text, int number=0)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="number" type="int" default="0"/>
</paramlist>
</method>
<method name="PopStatusText" type="" overloaded="no">
- <autodoc>PopStatusText(int number=0)</autodoc>
+ <autodoc>PopStatusText(self, int number=0)</autodoc>
<paramlist>
<param name="number" type="int" default="0"/>
</paramlist>
</method>
<method name="SetStatusWidths" type="" overloaded="no">
- <autodoc>SetStatusWidths(int widths, int widths_field)</autodoc>
+ <autodoc>SetStatusWidths(self, int widths, int widths_field)</autodoc>
<paramlist>
<param name="widths" type="int" default=""/>
<param name="widths_field" type="int" default=""/>
</paramlist>
</method>
<method name="GetFieldRect" type="Rect" overloaded="no">
- <autodoc>GetFieldRect(int i) -> Rect</autodoc>
+ <autodoc>GetFieldRect(self, int i) -> Rect</autodoc>
<paramlist>
<param name="i" type="int" default=""/>
</paramlist>
</method>
<method name="SetMinHeight" type="" overloaded="no">
- <autodoc>SetMinHeight(int height)</autodoc>
+ <autodoc>SetMinHeight(self, int height)</autodoc>
<paramlist>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="GetBorderX" type="int" overloaded="no">
- <autodoc>GetBorderX() -> int</autodoc>
+ <autodoc>GetBorderX(self) -> int</autodoc>
</method>
<method name="GetBorderY" type="int" overloaded="no">
- <autodoc>GetBorderY() -> int</autodoc>
+ <autodoc>GetBorderY(self) -> int</autodoc>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="SplitterWindow" oldname="wxSplitterWindow" module="windows">
- <docstring>wx.SplitterWindow manages up to two subwindows or panes,
-with an optional vertical or horizontal split which can be
-used with the mouse or programmatically.
-</docstring>
- <refdoc>
- Styles
- wx.SP_3D Draws a 3D effect border and sash.
- wx.SP_3DSASH Draws a 3D effect sash.
- wx.SP_3DBORDER Synonym for wxSP_BORDER.
- wx.SP_BORDER Draws a standard border.
- wx.SP_NOBORDER No border (default).
- wx.SP_NO_XP_THEME Under Windows XP, switches off the
- attempt to draw the splitter
- using Windows XP theming, so the
- borders and sash will take on the
- pre-XP look.
- wx.SP_PERMIT_UNSPLIT Always allow to unsplit, even with
- the minimum pane size other than zero.
- wx.SP_LIVE_UPDATE Don't draw XOR line but resize the
- child windows immediately.
-
- Events
-
- EVT_SPLITTER_SASH_POS_CHANGING
- The sash position is in the
- process of being changed. May be
- used to modify the position of
- the tracking bar to properly
- reflect the position that would
- be set if the drag were to be
- completed at this point.
-
- EVT_SPLITTER_SASH_POS_CHANGED
- The sash position was
- changed. May be used to modify
- the sash position before it is
- set, or to prevent the change
- from taking place.
-
- EVT_SPLITTER_UNSPLIT The splitter has been just unsplit.
-
- EVT_SPLITTER_DCLICK The sash was double clicked. The
- default behaviour is to unsplit
- the window when this happens
- (unless the minimum pane size has
- been set to a value greater than
- zero.)
-
-</refdoc>
+ <class name="SplitterWindow" oldname="wxSplitterWindow" module="_windows">
+ <docstring>wx.SplitterWindow manages up to two subwindows or panes, with an
+optional vertical or horizontal split which can be used with the mouse
+or programmatically.</docstring>
<baseclass name="Window"/>
<constructor name="SplitterWindow" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=SP_3D, String name=SplitterNameStr) -> SplitterWindow</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=SP_3D, String name=SplitterNameStr) -> SplitterWindow</autodoc>
<docstring>Constructor. Creates and shows a SplitterWindow.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxSP_3D"/>
<docstring>Precreate a SplitterWindow for 2-phase creation.</docstring>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=SP_3D, String name=SplitterNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=SP_3D, String name=SplitterNameStr) -> bool</autodoc>
<docstring>Create the GUI part of the SplitterWindow for the 2-phase create.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxSP_3D"/>
</paramlist>
</method>
<method name="GetWindow1" type="Window" overloaded="no">
- <autodoc>GetWindow1() -> Window</autodoc>
+ <autodoc>GetWindow1(self) -> Window</autodoc>
<docstring>Gets the only or left/top pane.</docstring>
</method>
<method name="GetWindow2" type="Window" overloaded="no">
- <autodoc>GetWindow2() -> Window</autodoc>
+ <autodoc>GetWindow2(self) -> Window</autodoc>
<docstring>Gets the right/bottom pane.</docstring>
</method>
<method name="SetSplitMode" type="" overloaded="no">
- <autodoc>SetSplitMode(int mode)</autodoc>
+ <autodoc>SetSplitMode(self, int mode)</autodoc>
<docstring>Sets the split mode. The mode can be wx.SPLIT_VERTICAL or
-wx.SPLIT_HORIZONTAL. This only sets the internal variable;
-does not update the display.</docstring>
+wx.SPLIT_HORIZONTAL. This only sets the internal variable; does not
+update the display.</docstring>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="GetSplitMode" type="wxSplitMode" overloaded="no">
- <autodoc>GetSplitMode() -> int</autodoc>
+ <autodoc>GetSplitMode(self) -> int</autodoc>
<docstring>Gets the split mode</docstring>
</method>
<method name="Initialize" type="" overloaded="no">
- <autodoc>Initialize(Window window)</autodoc>
- <docstring>Initializes the splitter window to have one pane. This
-should be called if you wish to initially view only a single
-pane in the splitter window.</docstring>
+ <autodoc>Initialize(self, Window window)</autodoc>
+ <docstring>Initializes the splitter window to have one pane. This should be
+called if you wish to initially view only a single pane in the
+splitter window.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="SplitVertically" type="bool" overloaded="no">
- <autodoc>SplitVertically(Window window1, Window window2, int sashPosition=0) -> bool</autodoc>
- <docstring>Initializes the left and right panes of the splitter window.
-
- window1 The left pane.
- window2 The right pane.
- sashPosition The initial position of the sash. If this
- value is positive, it specifies the size
- of the left pane. If it is negative, it is
- absolute value gives the size of the right
- pane. Finally, specify 0 (default) to
- choose the default position (half of the
- total window width).
-
-Returns True if successful, False otherwise (the window was
-already split).
-
-SplitVertically should be called if you wish to initially
-view two panes. It can also be called at any subsequent
-time, but the application should check that the window is
-not currently split using IsSplit.</docstring>
+ <autodoc>SplitVertically(self, Window window1, Window window2, int sashPosition=0) -> bool</autodoc>
+ <docstring>Initializes the left and right panes of the splitter window.</docstring>
<paramlist>
<param name="window1" type="Window" default=""/>
<param name="window2" type="Window" default=""/>
</paramlist>
</method>
<method name="SplitHorizontally" type="bool" overloaded="no">
- <autodoc>SplitHorizontally(Window window1, Window window2, int sashPosition=0) -> bool</autodoc>
- <docstring>Initializes the top and bottom panes of the splitter window.
-
- window1 The top pane.
- window2 The bottom pane.
- sashPosition The initial position of the sash. If this
- value is positive, it specifies the size
- of the upper pane. If it is negative, it
- is absolute value gives the size of the
- lower pane. Finally, specify 0 (default)
- to choose the default position (half of
- the total window height).
-
-Returns True if successful, False otherwise (the window was
-already split).
-
-SplitHorizontally should be called if you wish to initially
-view two panes. It can also be called at any subsequent
-time, but the application should check that the window is
-not currently split using IsSplit.</docstring>
+ <autodoc>SplitHorizontally(self, Window window1, Window window2, int sashPosition=0) -> bool</autodoc>
+ <docstring>Initializes the top and bottom panes of the splitter window.</docstring>
<paramlist>
<param name="window1" type="Window" default=""/>
<param name="window2" type="Window" default=""/>
</paramlist>
</method>
<method name="Unsplit" type="bool" overloaded="no">
- <autodoc>Unsplit(Window toRemove=None) -> bool</autodoc>
- <docstring>Unsplits the window. Pass the pane to remove, or None to
-remove the right or bottom pane. Returns True if
-successful, False otherwise (the window was not split).
+ <autodoc>Unsplit(self, Window toRemove=None) -> bool</autodoc>
+ <docstring>Unsplits the window. Pass the pane to remove, or None to remove the
+right or bottom pane. Returns True if successful, False otherwise (the
+window was not split).
This function will not actually delete the pane being
removed; it sends EVT_SPLITTER_UNSPLIT which can be handled
</paramlist>
</method>
<method name="ReplaceWindow" type="bool" overloaded="no">
- <autodoc>ReplaceWindow(Window winOld, Window winNew) -> bool</autodoc>
+ <autodoc>ReplaceWindow(self, Window winOld, Window winNew) -> bool</autodoc>
<docstring>This function replaces one of the windows managed by the
-SplitterWindow with another one. It is in general better to
-use it instead of calling Unsplit() and then resplitting the
-window back because it will provoke much less flicker. It is
-valid to call this function whether the splitter has two
-windows or only one.
-
-Both parameters should be non-None and winOld must specify
-one of the windows managed by the splitter. If the
-parameters are incorrect or the window couldn't be replaced,
-False is returned. Otherwise the function will return True,
-but please notice that it will not Destroy the replaced
-window and you may wish to do it yourself.</docstring>
+SplitterWindow with another one. It is in general better to use it
+instead of calling Unsplit() and then resplitting the window back
+because it will provoke much less flicker. It is valid to call this
+function whether the splitter has two windows or only one.
+
+Both parameters should be non-None and winOld must specify one of the
+windows managed by the splitter. If the parameters are incorrect or
+the window couldn't be replaced, False is returned. Otherwise the
+function will return True, but please notice that it will not Destroy
+the replaced window and you may wish to do it yourself.</docstring>
<paramlist>
<param name="winOld" type="Window" default=""/>
<param name="winNew" type="Window" default=""/>
</paramlist>
</method>
<method name="UpdateSize" type="" overloaded="no">
- <autodoc>UpdateSize()</autodoc>
- <docstring>Causes any pending sizing of the sash and child panes to
-take place immediately.
-
-Such resizing normally takes place in idle time, in order to
-wait for layout to be completed. However, this can cause
-unacceptable flicker as the panes are resized after the
-window has been shown. To work around this, you can perform
-window layout (for example by sending a size event to the
-parent window), and then call this function, before showing
-the top-level window.</docstring>
+ <autodoc>UpdateSize(self)</autodoc>
+ <docstring>Causes any pending sizing of the sash and child panes to take place
+immediately.
+
+Such resizing normally takes place in idle time, in order to wait for
+layout to be completed. However, this can cause unacceptable flicker
+as the panes are resized after the window has been shown. To work
+around this, you can perform window layout (for example by sending a
+size event to the parent window), and then call this function, before
+showing the top-level window.</docstring>
</method>
<method name="IsSplit" type="bool" overloaded="no">
- <autodoc>IsSplit() -> bool</autodoc>
+ <autodoc>IsSplit(self) -> bool</autodoc>
<docstring>Is the window split?</docstring>
</method>
<method name="SetSashSize" type="" overloaded="no">
- <autodoc>SetSashSize(int width)</autodoc>
+ <autodoc>SetSashSize(self, int width)</autodoc>
<docstring>Sets the sash size</docstring>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="SetBorderSize" type="" overloaded="no">
- <autodoc>SetBorderSize(int width)</autodoc>
+ <autodoc>SetBorderSize(self, int width)</autodoc>
<docstring>Sets the border size</docstring>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="GetSashSize" type="int" overloaded="no">
- <autodoc>GetSashSize() -> int</autodoc>
+ <autodoc>GetSashSize(self) -> int</autodoc>
<docstring>Gets the sash size</docstring>
</method>
<method name="GetBorderSize" type="int" overloaded="no">
- <autodoc>GetBorderSize() -> int</autodoc>
+ <autodoc>GetBorderSize(self) -> int</autodoc>
<docstring>Gets the border size</docstring>
</method>
<method name="SetSashPosition" type="" overloaded="no">
- <autodoc>SetSashPosition(int position, bool redraw=True)</autodoc>
- <docstring>Sets the sash position, in pixels. If redraw is Ttrue then
-the panes are resized and the sash and border are redrawn.</docstring>
+ <autodoc>SetSashPosition(self, int position, bool redraw=True)</autodoc>
+ <docstring>Sets the sash position, in pixels. If redraw is Ttrue then the panes
+are resized and the sash and border are redrawn.</docstring>
<paramlist>
<param name="position" type="int" default=""/>
<param name="redraw" type="bool" default="True"/>
</paramlist>
</method>
<method name="GetSashPosition" type="int" overloaded="no">
- <autodoc>GetSashPosition() -> int</autodoc>
+ <autodoc>GetSashPosition(self) -> int</autodoc>
<docstring>Returns the surrent sash position.</docstring>
</method>
<method name="SetMinimumPaneSize" type="" overloaded="no">
- <autodoc>SetMinimumPaneSize(int min)</autodoc>
+ <autodoc>SetMinimumPaneSize(self, int min)</autodoc>
<docstring>Sets the minimum pane size in pixels.
-The default minimum pane size is zero, which means that
-either pane can be reduced to zero by dragging the sash,
-thus removing one of the panes. To prevent this behaviour (and
-veto out-of-range sash dragging), set a minimum size,
-for example 20 pixels. If the wx.SP_PERMIT_UNSPLIT style is
-used when a splitter window is created, the window may be
-unsplit even if minimum size is non-zero.</docstring>
+The default minimum pane size is zero, which means that either pane
+can be reduced to zero by dragging the sash, thus removing one of the
+panes. To prevent this behaviour (and veto out-of-range sash
+dragging), set a minimum size, for example 20 pixels. If the
+wx.SP_PERMIT_UNSPLIT style is used when a splitter window is created,
+the window may be unsplit even if minimum size is non-zero.</docstring>
<paramlist>
<param name="min" type="int" default=""/>
</paramlist>
</method>
<method name="GetMinimumPaneSize" type="int" overloaded="no">
- <autodoc>GetMinimumPaneSize() -> int</autodoc>
+ <autodoc>GetMinimumPaneSize(self) -> int</autodoc>
<docstring>Gets the minimum pane size in pixels.</docstring>
</method>
<method name="SashHitTest" type="bool" overloaded="no">
- <autodoc>SashHitTest(int x, int y, int tolerance=5) -> bool</autodoc>
+ <autodoc>SashHitTest(self, int x, int y, int tolerance=5) -> bool</autodoc>
<docstring>Tests for x, y over the sash</docstring>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="SizeWindows" type="" overloaded="no">
- <autodoc>SizeWindows()</autodoc>
+ <autodoc>SizeWindows(self)</autodoc>
<docstring>Resizes subwindows</docstring>
</method>
<method name="SetNeedUpdating" type="" overloaded="no">
- <autodoc>SetNeedUpdating(bool needUpdating)</autodoc>
+ <autodoc>SetNeedUpdating(self, bool needUpdating)</autodoc>
<paramlist>
<param name="needUpdating" type="bool" default=""/>
</paramlist>
</method>
<method name="GetNeedUpdating" type="bool" overloaded="no">
- <autodoc>GetNeedUpdating() -> bool</autodoc>
+ <autodoc>GetNeedUpdating(self) -> bool</autodoc>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
- <class name="SplitterEvent" oldname="wxSplitterEvent" module="windows">
+ <class name="SplitterEvent" oldname="wxSplitterEvent" module="_windows">
<docstring>This class represents the events generated by a splitter control.</docstring>
<baseclass name="NotifyEvent"/>
<constructor name="SplitterEvent" overloaded="no">
- <autodoc>__init__(wxEventType type=wxEVT_NULL, SplitterWindow splitter=(wxSplitterWindow *) NULL) -> SplitterEvent</autodoc>
+ <autodoc>__init__(self, wxEventType type=wxEVT_NULL, SplitterWindow splitter=(wxSplitterWindow *) NULL) -> SplitterEvent</autodoc>
<docstring>This class represents the events generated by a splitter control.</docstring>
<paramlist>
<param name="type" type="wxEventType" default="wxEVT_NULL"/>
</paramlist>
</constructor>
<method name="SetSashPosition" type="" overloaded="no">
- <autodoc>SetSashPosition(int pos)</autodoc>
- <docstring>This funciton is only meaningful during
-EVT_SPLITTER_SASH_POS_CHANGING and
-EVT_SPLITTER_SASH_POS_CHANGED events. In the case of
-_CHANGED events, sets the the new sash position. In the case
-of _CHANGING events, sets the new tracking bar position so
-visual feedback during dragging will represent that change
-that will actually take place. Set to -1 from the event
-handler code to prevent repositioning.</docstring>
+ <autodoc>SetSashPosition(self, int pos)</autodoc>
+ <docstring>This funciton is only meaningful during EVT_SPLITTER_SASH_POS_CHANGING
+and EVT_SPLITTER_SASH_POS_CHANGED events. In the case of _CHANGED
+events, sets the the new sash position. In the case of _CHANGING
+events, sets the new tracking bar position so visual feedback during
+dragging will represent that change that will actually take place. Set
+to -1 from the event handler code to prevent repositioning.</docstring>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="GetSashPosition" type="int" overloaded="no">
- <autodoc>GetSashPosition() -> int</autodoc>
- <docstring>Returns the new sash position while in
-EVT_SPLITTER_SASH_POS_CHANGING and
-EVT_SPLITTER_SASH_POS_CHANGED events.</docstring>
+ <autodoc>GetSashPosition(self) -> int</autodoc>
+ <docstring>Returns the new sash position while in EVT_SPLITTER_SASH_POS_CHANGING
+and EVT_SPLITTER_SASH_POS_CHANGED events.</docstring>
</method>
<method name="GetWindowBeingRemoved" type="Window" overloaded="no">
- <autodoc>GetWindowBeingRemoved() -> Window</autodoc>
- <docstring>Returns a pointer to the window being removed when a
-splitter window is unsplit.</docstring>
+ <autodoc>GetWindowBeingRemoved(self) -> Window</autodoc>
+ <docstring>Returns a pointer to the window being removed when a splitter window
+is unsplit.</docstring>
</method>
<method name="GetX" type="int" overloaded="no">
- <autodoc>GetX() -> int</autodoc>
+ <autodoc>GetX(self) -> int</autodoc>
<docstring>Returns the x coordinate of the double-click point in a
EVT_SPLITTER_DCLICK event.</docstring>
</method>
<method name="GetY" type="int" overloaded="no">
- <autodoc>GetY() -> int</autodoc>
+ <autodoc>GetY(self) -> int</autodoc>
<docstring>Returns the y coordinate of the double-click point in a
EVT_SPLITTER_DCLICK event.</docstring>
</method>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="SashWindow" oldname="wxSashWindow" module="windows">
+ <class name="SashWindow" oldname="wxSashWindow" module="_windows">
<baseclass name="Window"/>
<constructor name="SashWindow" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=wxCLIP_CHILDREN|wxSW_3D,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D,
String name=SashNameStr) -> SashWindow</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxCLIP_CHILDREN|wxSW_3D"/>
<autodoc>PreSashWindow() -> SashWindow</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=wxCLIP_CHILDREN|wxSW_3D,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D,
String name=SashNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxCLIP_CHILDREN|wxSW_3D"/>
</paramlist>
</method>
<method name="SetSashVisible" type="" overloaded="no">
- <autodoc>SetSashVisible(int edge, bool sash)</autodoc>
+ <autodoc>SetSashVisible(self, int edge, bool sash)</autodoc>
<paramlist>
<param name="edge" type="wxSashEdgePosition" default=""/>
<param name="sash" type="bool" default=""/>
</paramlist>
</method>
<method name="GetSashVisible" type="bool" overloaded="no">
- <autodoc>GetSashVisible(int edge) -> bool</autodoc>
+ <autodoc>GetSashVisible(self, int edge) -> bool</autodoc>
<paramlist>
<param name="edge" type="wxSashEdgePosition" default=""/>
</paramlist>
</method>
<method name="SetSashBorder" type="" overloaded="no">
- <autodoc>SetSashBorder(int edge, bool border)</autodoc>
+ <autodoc>SetSashBorder(self, int edge, bool border)</autodoc>
<paramlist>
<param name="edge" type="wxSashEdgePosition" default=""/>
<param name="border" type="bool" default=""/>
</paramlist>
</method>
<method name="HasBorder" type="bool" overloaded="no">
- <autodoc>HasBorder(int edge) -> bool</autodoc>
+ <autodoc>HasBorder(self, int edge) -> bool</autodoc>
<paramlist>
<param name="edge" type="wxSashEdgePosition" default=""/>
</paramlist>
</method>
<method name="GetEdgeMargin" type="int" overloaded="no">
- <autodoc>GetEdgeMargin(int edge) -> int</autodoc>
+ <autodoc>GetEdgeMargin(self, int edge) -> int</autodoc>
<paramlist>
<param name="edge" type="wxSashEdgePosition" default=""/>
</paramlist>
</method>
<method name="SetDefaultBorderSize" type="" overloaded="no">
- <autodoc>SetDefaultBorderSize(int width)</autodoc>
+ <autodoc>SetDefaultBorderSize(self, int width)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="GetDefaultBorderSize" type="int" overloaded="no">
- <autodoc>GetDefaultBorderSize() -> int</autodoc>
+ <autodoc>GetDefaultBorderSize(self) -> int</autodoc>
</method>
<method name="SetExtraBorderSize" type="" overloaded="no">
- <autodoc>SetExtraBorderSize(int width)</autodoc>
+ <autodoc>SetExtraBorderSize(self, int width)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="GetExtraBorderSize" type="int" overloaded="no">
- <autodoc>GetExtraBorderSize() -> int</autodoc>
+ <autodoc>GetExtraBorderSize(self) -> int</autodoc>
</method>
<method name="SetMinimumSizeX" type="" overloaded="no">
- <autodoc>SetMinimumSizeX(int min)</autodoc>
+ <autodoc>SetMinimumSizeX(self, int min)</autodoc>
<paramlist>
<param name="min" type="int" default=""/>
</paramlist>
</method>
<method name="SetMinimumSizeY" type="" overloaded="no">
- <autodoc>SetMinimumSizeY(int min)</autodoc>
+ <autodoc>SetMinimumSizeY(self, int min)</autodoc>
<paramlist>
<param name="min" type="int" default=""/>
</paramlist>
</method>
<method name="GetMinimumSizeX" type="int" overloaded="no">
- <autodoc>GetMinimumSizeX() -> int</autodoc>
+ <autodoc>GetMinimumSizeX(self) -> int</autodoc>
</method>
<method name="GetMinimumSizeY" type="int" overloaded="no">
- <autodoc>GetMinimumSizeY() -> int</autodoc>
+ <autodoc>GetMinimumSizeY(self) -> int</autodoc>
</method>
<method name="SetMaximumSizeX" type="" overloaded="no">
- <autodoc>SetMaximumSizeX(int max)</autodoc>
+ <autodoc>SetMaximumSizeX(self, int max)</autodoc>
<paramlist>
<param name="max" type="int" default=""/>
</paramlist>
</method>
<method name="SetMaximumSizeY" type="" overloaded="no">
- <autodoc>SetMaximumSizeY(int max)</autodoc>
+ <autodoc>SetMaximumSizeY(self, int max)</autodoc>
<paramlist>
<param name="max" type="int" default=""/>
</paramlist>
</method>
<method name="GetMaximumSizeX" type="int" overloaded="no">
- <autodoc>GetMaximumSizeX() -> int</autodoc>
+ <autodoc>GetMaximumSizeX(self) -> int</autodoc>
</method>
<method name="GetMaximumSizeY" type="int" overloaded="no">
- <autodoc>GetMaximumSizeY() -> int</autodoc>
+ <autodoc>GetMaximumSizeY(self) -> int</autodoc>
</method>
<method name="SashHitTest" type="wxSashEdgePosition" overloaded="no">
- <autodoc>SashHitTest(int x, int y, int tolerance=2) -> int</autodoc>
+ <autodoc>SashHitTest(self, int x, int y, int tolerance=2) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="SizeWindows" type="" overloaded="no">
- <autodoc>SizeWindows()</autodoc>
+ <autodoc>SizeWindows(self)</autodoc>
</method>
</class>
- <class name="SashEvent" oldname="wxSashEvent" module="windows">
+ <class name="SashEvent" oldname="wxSashEvent" module="_windows">
<baseclass name="CommandEvent"/>
<constructor name="SashEvent" overloaded="no">
- <autodoc>__init__(int id=0, int edge=SASH_NONE) -> SashEvent</autodoc>
+ <autodoc>__init__(self, int id=0, int edge=SASH_NONE) -> SashEvent</autodoc>
<paramlist>
<param name="id" type="int" default="0"/>
<param name="edge" type="wxSashEdgePosition" default="wxSASH_NONE"/>
</paramlist>
</constructor>
<method name="SetEdge" type="" overloaded="no">
- <autodoc>SetEdge(int edge)</autodoc>
+ <autodoc>SetEdge(self, int edge)</autodoc>
<paramlist>
<param name="edge" type="wxSashEdgePosition" default=""/>
</paramlist>
</method>
<method name="GetEdge" type="wxSashEdgePosition" overloaded="no">
- <autodoc>GetEdge() -> int</autodoc>
+ <autodoc>GetEdge(self) -> int</autodoc>
</method>
<method name="SetDragRect" type="" overloaded="no">
- <autodoc>SetDragRect(Rect rect)</autodoc>
+ <autodoc>SetDragRect(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="GetDragRect" type="Rect" overloaded="no">
- <autodoc>GetDragRect() -> Rect</autodoc>
+ <autodoc>GetDragRect(self) -> Rect</autodoc>
</method>
<method name="SetDragStatus" type="" overloaded="no">
- <autodoc>SetDragStatus(int status)</autodoc>
+ <autodoc>SetDragStatus(self, int status)</autodoc>
<paramlist>
<param name="status" type="wxSashDragStatus" default=""/>
</paramlist>
</method>
<method name="GetDragStatus" type="wxSashDragStatus" overloaded="no">
- <autodoc>GetDragStatus() -> int</autodoc>
+ <autodoc>GetDragStatus(self) -> int</autodoc>
</method>
</class>
<pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="QueryLayoutInfoEvent" oldname="wxQueryLayoutInfoEvent" module="windows">
+ <class name="QueryLayoutInfoEvent" oldname="wxQueryLayoutInfoEvent" module="_windows">
<baseclass name="Event"/>
<constructor name="QueryLayoutInfoEvent" overloaded="no">
- <autodoc>__init__(int id=0) -> QueryLayoutInfoEvent</autodoc>
+ <autodoc>__init__(self, int id=0) -> QueryLayoutInfoEvent</autodoc>
<paramlist>
<param name="id" type="int" default="0"/>
</paramlist>
</constructor>
<method name="SetRequestedLength" type="" overloaded="no">
- <autodoc>SetRequestedLength(int length)</autodoc>
+ <autodoc>SetRequestedLength(self, int length)</autodoc>
<paramlist>
<param name="length" type="int" default=""/>
</paramlist>
</method>
<method name="GetRequestedLength" type="int" overloaded="no">
- <autodoc>GetRequestedLength() -> int</autodoc>
+ <autodoc>GetRequestedLength(self) -> int</autodoc>
</method>
<method name="SetFlags" type="" overloaded="no">
- <autodoc>SetFlags(int flags)</autodoc>
+ <autodoc>SetFlags(self, int flags)</autodoc>
<paramlist>
<param name="flags" type="int" default=""/>
</paramlist>
</method>
<method name="GetFlags" type="int" overloaded="no">
- <autodoc>GetFlags() -> int</autodoc>
+ <autodoc>GetFlags(self) -> int</autodoc>
</method>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(Size size)</autodoc>
+ <autodoc>SetSize(self, Size size)</autodoc>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="GetSize" type="Size" overloaded="no">
- <autodoc>GetSize() -> Size</autodoc>
+ <autodoc>GetSize(self) -> Size</autodoc>
</method>
<method name="SetOrientation" type="" overloaded="no">
- <autodoc>SetOrientation(int orient)</autodoc>
+ <autodoc>SetOrientation(self, int orient)</autodoc>
<paramlist>
<param name="orient" type="wxLayoutOrientation" default=""/>
</paramlist>
</method>
<method name="GetOrientation" type="wxLayoutOrientation" overloaded="no">
- <autodoc>GetOrientation() -> int</autodoc>
+ <autodoc>GetOrientation(self) -> int</autodoc>
</method>
<method name="SetAlignment" type="" overloaded="no">
- <autodoc>SetAlignment(int align)</autodoc>
+ <autodoc>SetAlignment(self, int align)</autodoc>
<paramlist>
<param name="align" type="wxLayoutAlignment" default=""/>
</paramlist>
</method>
<method name="GetAlignment" type="wxLayoutAlignment" overloaded="no">
- <autodoc>GetAlignment() -> int</autodoc>
+ <autodoc>GetAlignment(self) -> int</autodoc>
</method>
</class>
- <class name="CalculateLayoutEvent" oldname="wxCalculateLayoutEvent" module="windows">
+ <class name="CalculateLayoutEvent" oldname="wxCalculateLayoutEvent" module="_windows">
<baseclass name="Event"/>
<constructor name="CalculateLayoutEvent" overloaded="no">
- <autodoc>__init__(int id=0) -> CalculateLayoutEvent</autodoc>
+ <autodoc>__init__(self, int id=0) -> CalculateLayoutEvent</autodoc>
<paramlist>
<param name="id" type="int" default="0"/>
</paramlist>
</constructor>
<method name="SetFlags" type="" overloaded="no">
- <autodoc>SetFlags(int flags)</autodoc>
+ <autodoc>SetFlags(self, int flags)</autodoc>
<paramlist>
<param name="flags" type="int" default=""/>
</paramlist>
</method>
<method name="GetFlags" type="int" overloaded="no">
- <autodoc>GetFlags() -> int</autodoc>
+ <autodoc>GetFlags(self) -> int</autodoc>
</method>
<method name="SetRect" type="" overloaded="no">
- <autodoc>SetRect(Rect rect)</autodoc>
+ <autodoc>SetRect(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="GetRect" type="Rect" overloaded="no">
- <autodoc>GetRect() -> Rect</autodoc>
+ <autodoc>GetRect(self) -> Rect</autodoc>
</method>
</class>
<pythoncode>
EVT_QUERY_LAYOUT_INFO = wx.PyEventBinder( wxEVT_QUERY_LAYOUT_INFO )
EVT_CALCULATE_LAYOUT = wx.PyEventBinder( wxEVT_CALCULATE_LAYOUT )
</pythoncode>
- <class name="SashLayoutWindow" oldname="wxSashLayoutWindow" module="windows">
+ <class name="SashLayoutWindow" oldname="wxSashLayoutWindow" module="_windows">
<baseclass name="SashWindow"/>
<constructor name="SashLayoutWindow" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=wxCLIP_CHILDREN|wxSW_3D,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D,
String name=SashLayoutNameStr) -> SashLayoutWindow</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxCLIP_CHILDREN|wxSW_3D"/>
<autodoc>PreSashLayoutWindow() -> SashLayoutWindow</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=wxCLIP_CHILDREN|wxSW_3D,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D,
String name=SashLayoutNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxCLIP_CHILDREN|wxSW_3D"/>
</paramlist>
</method>
<method name="GetAlignment" type="wxLayoutAlignment" overloaded="no">
- <autodoc>GetAlignment() -> int</autodoc>
+ <autodoc>GetAlignment(self) -> int</autodoc>
</method>
<method name="GetOrientation" type="wxLayoutOrientation" overloaded="no">
- <autodoc>GetOrientation() -> int</autodoc>
+ <autodoc>GetOrientation(self) -> int</autodoc>
</method>
<method name="SetAlignment" type="" overloaded="no">
- <autodoc>SetAlignment(int alignment)</autodoc>
+ <autodoc>SetAlignment(self, int alignment)</autodoc>
<paramlist>
<param name="alignment" type="wxLayoutAlignment" default=""/>
</paramlist>
</method>
<method name="SetDefaultSize" type="" overloaded="no">
- <autodoc>SetDefaultSize(Size size)</autodoc>
+ <autodoc>SetDefaultSize(self, Size size)</autodoc>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="SetOrientation" type="" overloaded="no">
- <autodoc>SetOrientation(int orientation)</autodoc>
+ <autodoc>SetOrientation(self, int orientation)</autodoc>
<paramlist>
<param name="orientation" type="wxLayoutOrientation" default=""/>
</paramlist>
</method>
</class>
- <class name="LayoutAlgorithm" oldname="wxLayoutAlgorithm" module="windows">
+ <class name="LayoutAlgorithm" oldname="wxLayoutAlgorithm" module="_windows">
<baseclass name="Object"/>
<constructor name="LayoutAlgorithm" overloaded="no">
- <autodoc>__init__() -> LayoutAlgorithm</autodoc>
+ <autodoc>__init__(self) -> LayoutAlgorithm</autodoc>
</constructor>
<destructor name="~wxLayoutAlgorithm" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="LayoutMDIFrame" type="bool" overloaded="no">
- <autodoc>LayoutMDIFrame(MDIParentFrame frame, Rect rect=None) -> bool</autodoc>
+ <autodoc>LayoutMDIFrame(self, MDIParentFrame frame, Rect rect=None) -> bool</autodoc>
<paramlist>
<param name="frame" type="wxMDIParentFrame" default=""/>
<param name="rect" type="Rect" default="NULL"/>
</paramlist>
</method>
<method name="LayoutFrame" type="bool" overloaded="no">
- <autodoc>LayoutFrame(Frame frame, Window mainWindow=None) -> bool</autodoc>
+ <autodoc>LayoutFrame(self, Frame frame, Window mainWindow=None) -> bool</autodoc>
<paramlist>
<param name="frame" type="Frame" default=""/>
<param name="mainWindow" type="Window" default="NULL"/>
</paramlist>
</method>
<method name="LayoutWindow" type="bool" overloaded="no">
- <autodoc>LayoutWindow(Window parent, Window mainWindow=None) -> bool</autodoc>
+ <autodoc>LayoutWindow(self, Window parent, Window mainWindow=None) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="mainWindow" type="Window" default="NULL"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PopupWindow" oldname="wxPopupWindow" module="windows">
+ <class name="PopupWindow" oldname="wxPopupWindow" module="_windows">
<baseclass name="Window"/>
<constructor name="PopupWindow" overloaded="no">
- <autodoc>__init__(Window parent, int flags=BORDER_NONE) -> PopupWindow</autodoc>
+ <autodoc>__init__(self, Window parent, int flags=BORDER_NONE) -> PopupWindow</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="flags" type="int" default="wxBORDER_NONE"/>
<autodoc>PrePopupWindow() -> PopupWindow</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int flags=BORDER_NONE) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int flags=BORDER_NONE) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="flags" type="int" default="wxBORDER_NONE"/>
</paramlist>
</method>
<method name="Position" type="" overloaded="no">
- <autodoc>Position(Point ptOrigin, Size size)</autodoc>
+ <autodoc>Position(self, Point ptOrigin, Size size)</autodoc>
<paramlist>
<param name="ptOrigin" type="Point" default=""/>
<param name="size" type="Size" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PopupTransientWindow" oldname="wxPyPopupTransientWindow" module="windows">
+ <class name="PopupTransientWindow" oldname="wxPyPopupTransientWindow" module="_windows">
<baseclass name="PopupWindow"/>
<constructor name="wxPyPopupTransientWindow" overloaded="no">
- <autodoc>__init__(Window parent, int style=BORDER_NONE) -> PopupTransientWindow</autodoc>
+ <autodoc>__init__(self, Window parent, int style=BORDER_NONE) -> PopupTransientWindow</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="style" type="int" default="wxBORDER_NONE"/>
<autodoc>PrePopupTransientWindow() -> PopupTransientWindow</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="Popup" type="" overloaded="no">
- <autodoc>Popup(Window focus=None)</autodoc>
+ <autodoc>Popup(self, Window focus=None)</autodoc>
<paramlist>
<param name="focus" type="Window" default="NULL"/>
</paramlist>
</method>
<method name="Dismiss" type="" overloaded="no">
- <autodoc>Dismiss()</autodoc>
+ <autodoc>Dismiss(self)</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="TipWindow" oldname="wxTipWindow" module="windows">
+ <class name="TipWindow" oldname="wxTipWindow" module="_windows">
<baseclass name="PopupTransientWindow"/>
<constructor name="TipWindow" overloaded="no">
- <autodoc>__init__(Window parent, String text, int maxLength=100, Rect rectBound=None) -> TipWindow</autodoc>
+ <autodoc>__init__(self, Window parent, String text, int maxLength=100, Rect rectBound=None) -> TipWindow</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</constructor>
<method name="SetBoundingRect" type="" overloaded="no">
- <autodoc>SetBoundingRect(Rect rectBound)</autodoc>
+ <autodoc>SetBoundingRect(self, Rect rectBound)</autodoc>
<paramlist>
<param name="rectBound" type="Rect" default=""/>
</paramlist>
</method>
<method name="Close" type="" overloaded="no">
- <autodoc>Close()</autodoc>
+ <autodoc>Close(self)</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="VScrolledWindow" oldname="wxPyVScrolledWindow" module="windows">
+ <class name="VScrolledWindow" oldname="wxPyVScrolledWindow" module="_windows">
<baseclass name="Panel"/>
<constructor name="wxPyVScrolledWindow" overloaded="no">
- <autodoc>__init__(Window parent, int id=ID_ANY, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=PanelNameStr) -> VScrolledWindow</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<autodoc>PreVScrolledWindow() -> VScrolledWindow</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=ID_ANY, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="SetLineCount" type="" overloaded="no">
- <autodoc>SetLineCount(size_t count)</autodoc>
+ <autodoc>SetLineCount(self, size_t count)</autodoc>
<paramlist>
<param name="count" type="size_t" default=""/>
</paramlist>
</method>
<method name="ScrollToLine" type="bool" overloaded="no">
- <autodoc>ScrollToLine(size_t line) -> bool</autodoc>
+ <autodoc>ScrollToLine(self, size_t line) -> bool</autodoc>
<paramlist>
<param name="line" type="size_t" default=""/>
</paramlist>
</method>
<method name="ScrollLines" type="bool" overloaded="no">
- <autodoc>ScrollLines(int lines) -> bool</autodoc>
+ <autodoc>ScrollLines(self, int lines) -> bool</autodoc>
<docstring>If the platform and window class supports it, scrolls the window by
the given number of lines down, if lines is positive, or up if lines
is negative. Returns True if the window was scrolled, False if it was
</paramlist>
</method>
<method name="ScrollPages" type="bool" overloaded="no">
- <autodoc>ScrollPages(int pages) -> bool</autodoc>
- <docstring>If the platform and window class supports it, scrolls the window by
+ <autodoc>ScrollPages(self, int pages) -> bool</autodoc>
+ <docstring>If the platform and window class supports it, scrolls the window by
the given number of pages down, if pages is positive, or up if pages
is negative. Returns True if the window was scrolled, False if it was
already on top/bottom and nothing was done.</docstring>
</paramlist>
</method>
<method name="RefreshLine" type="" overloaded="no">
- <autodoc>RefreshLine(size_t line)</autodoc>
+ <autodoc>RefreshLine(self, size_t line)</autodoc>
<paramlist>
<param name="line" type="size_t" default=""/>
</paramlist>
</method>
<method name="RefreshLines" type="" overloaded="no">
- <autodoc>RefreshLines(size_t from, size_t to)</autodoc>
+ <autodoc>RefreshLines(self, size_t from, size_t to)</autodoc>
<paramlist>
<param name="from" type="size_t" default=""/>
<param name="to" type="size_t" default=""/>
</paramlist>
</method>
<method name="HitTestXT" type="int" overloaded="no">
- <autodoc>HitTestXT(int x, int y) -> int</autodoc>
+ <autodoc>HitTestXT(self, int x, int y) -> int</autodoc>
<docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="HitTest" type="int" overloaded="no">
- <autodoc>HitTest(Point pt) -> int</autodoc>
+ <autodoc>HitTest(self, Point pt) -> int</autodoc>
<docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="RefreshAll" type="" overloaded="no">
- <autodoc>RefreshAll()</autodoc>
+ <autodoc>RefreshAll(self)</autodoc>
</method>
<method name="GetLineCount" type="size_t" overloaded="no">
- <autodoc>GetLineCount() -> size_t</autodoc>
+ <autodoc>GetLineCount(self) -> size_t</autodoc>
</method>
<method name="GetFirstVisibleLine" type="size_t" overloaded="no">
- <autodoc>GetFirstVisibleLine() -> size_t</autodoc>
+ <autodoc>GetFirstVisibleLine(self) -> size_t</autodoc>
</method>
<method name="GetLastVisibleLine" type="size_t" overloaded="no">
- <autodoc>GetLastVisibleLine() -> size_t</autodoc>
+ <autodoc>GetLastVisibleLine(self) -> size_t</autodoc>
</method>
<method name="IsVisible" type="bool" overloaded="no">
- <autodoc>IsVisible(size_t line) -> bool</autodoc>
+ <autodoc>IsVisible(self, size_t line) -> bool</autodoc>
<paramlist>
<param name="line" type="size_t" default=""/>
</paramlist>
</method>
</class>
- <class name="VListBox" oldname="wxPyVListBox" module="windows">
+ <class name="VListBox" oldname="wxPyVListBox" module="_windows">
<baseclass name="VScrolledWindow"/>
<constructor name="wxPyVListBox" overloaded="no">
- <autodoc>__init__(Window parent, int id=ID_ANY, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> VListBox</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<autodoc>PreVListBox() -> VListBox</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=ID_ANY, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="GetItemCount" type="size_t" overloaded="no">
- <autodoc>GetItemCount() -> size_t</autodoc>
+ <autodoc>GetItemCount(self) -> size_t</autodoc>
</method>
<method name="HasMultipleSelection" type="bool" overloaded="no">
- <autodoc>HasMultipleSelection() -> bool</autodoc>
+ <autodoc>HasMultipleSelection(self) -> bool</autodoc>
</method>
<method name="GetSelection" type="int" overloaded="no">
- <autodoc>GetSelection() -> int</autodoc>
+ <autodoc>GetSelection(self) -> int</autodoc>
</method>
<method name="IsCurrent" type="bool" overloaded="no">
- <autodoc>IsCurrent(size_t item) -> bool</autodoc>
+ <autodoc>IsCurrent(self, size_t item) -> bool</autodoc>
<paramlist>
<param name="item" type="size_t" default=""/>
</paramlist>
</method>
<method name="IsSelected" type="bool" overloaded="no">
- <autodoc>IsSelected(size_t item) -> bool</autodoc>
+ <autodoc>IsSelected(self, size_t item) -> bool</autodoc>
<paramlist>
<param name="item" type="size_t" default=""/>
</paramlist>
</method>
<method name="GetSelectedCount" type="size_t" overloaded="no">
- <autodoc>GetSelectedCount() -> size_t</autodoc>
+ <autodoc>GetSelectedCount(self) -> size_t</autodoc>
</method>
- <method name="GetFirstSelected" type="int" overloaded="no">
- <autodoc>GetFirstSelected(unsigned long cookie) -> int</autodoc>
- <paramlist>
- <param name="cookie" type="unsigned long" default=""/>
- </paramlist>
+ <method name="GetFirstSelected" type="PyObject" overloaded="no">
+ <autodoc>GetFirstSelected(self) -> PyObject</autodoc>
</method>
- <method name="GetNextSelected" type="int" overloaded="no">
- <autodoc>GetNextSelected(unsigned long cookie) -> int</autodoc>
+ <method name="GetNextSelected" type="PyObject" overloaded="no">
+ <autodoc>GetNextSelected(self, unsigned long cookie) -> PyObject</autodoc>
<paramlist>
<param name="cookie" type="unsigned long" default=""/>
</paramlist>
</method>
<method name="GetMargins" type="Point" overloaded="no">
- <autodoc>GetMargins() -> Point</autodoc>
+ <autodoc>GetMargins(self) -> Point</autodoc>
</method>
<method name="GetSelectionBackground" type="Colour" overloaded="no">
- <autodoc>GetSelectionBackground() -> Colour</autodoc>
+ <autodoc>GetSelectionBackground(self) -> Colour</autodoc>
</method>
<method name="SetItemCount" type="" overloaded="no">
- <autodoc>SetItemCount(size_t count)</autodoc>
+ <autodoc>SetItemCount(self, size_t count)</autodoc>
<paramlist>
<param name="count" type="size_t" default=""/>
</paramlist>
</method>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear()</autodoc>
+ <autodoc>Clear(self)</autodoc>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(int selection)</autodoc>
+ <autodoc>SetSelection(self, int selection)</autodoc>
<paramlist>
<param name="selection" type="int" default=""/>
</paramlist>
</method>
<method name="Select" type="bool" overloaded="no">
- <autodoc>Select(size_t item, bool select=True) -> bool</autodoc>
+ <autodoc>Select(self, size_t item, bool select=True) -> bool</autodoc>
<paramlist>
<param name="item" type="size_t" default=""/>
<param name="select" type="bool" default="True"/>
</paramlist>
</method>
<method name="SelectRange" type="bool" overloaded="no">
- <autodoc>SelectRange(size_t from, size_t to) -> bool</autodoc>
+ <autodoc>SelectRange(self, size_t from, size_t to) -> bool</autodoc>
<paramlist>
<param name="from" type="size_t" default=""/>
<param name="to" type="size_t" default=""/>
</paramlist>
</method>
<method name="Toggle" type="" overloaded="no">
- <autodoc>Toggle(size_t item)</autodoc>
+ <autodoc>Toggle(self, size_t item)</autodoc>
<paramlist>
<param name="item" type="size_t" default=""/>
</paramlist>
</method>
<method name="SelectAll" type="bool" overloaded="no">
- <autodoc>SelectAll() -> bool</autodoc>
+ <autodoc>SelectAll(self) -> bool</autodoc>
</method>
<method name="DeselectAll" type="bool" overloaded="no">
- <autodoc>DeselectAll() -> bool</autodoc>
+ <autodoc>DeselectAll(self) -> bool</autodoc>
</method>
<method name="SetMargins" type="" overloaded="no">
- <autodoc>SetMargins(Point pt)</autodoc>
+ <autodoc>SetMargins(self, Point pt)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="SetMarginsXY" type="" overloaded="no">
- <autodoc>SetMarginsXY(int x, int y)</autodoc>
+ <autodoc>SetMarginsXY(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="SetSelectionBackground" type="" overloaded="no">
- <autodoc>SetSelectionBackground(Colour col)</autodoc>
+ <autodoc>SetSelectionBackground(self, Colour col)</autodoc>
<paramlist>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
</class>
- <class name="HtmlListBox" oldname="wxPyHtmlListBox" module="windows">
+ <class name="HtmlListBox" oldname="wxPyHtmlListBox" module="_windows">
<baseclass name="VListBox"/>
<constructor name="wxPyHtmlListBox" overloaded="no">
- <autodoc>__init__(Window parent, int id=ID_ANY, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> HtmlListBox</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<autodoc>PreHtmlListBox() -> HtmlListBox</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=ID_ANY, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="RefreshAll" type="" overloaded="no">
- <autodoc>RefreshAll()</autodoc>
+ <autodoc>RefreshAll(self)</autodoc>
</method>
<method name="SetItemCount" type="" overloaded="no">
- <autodoc>SetItemCount(size_t count)</autodoc>
+ <autodoc>SetItemCount(self, size_t count)</autodoc>
<paramlist>
<param name="count" type="size_t" default=""/>
</paramlist>
</method>
+ <method name="GetFileSystem" type="FileSystem" overloaded="no">
+ <autodoc>GetFileSystem(self) -> FileSystem</autodoc>
+ </method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="TaskBarIcon" oldname="wxTaskBarIcon" module="windows">
+ <class name="TaskBarIcon" oldname="wxTaskBarIcon" module="_windows">
<baseclass name="EvtHandler"/>
<constructor name="TaskBarIcon" overloaded="no">
- <autodoc>__init__() -> TaskBarIcon</autodoc>
+ <autodoc>__init__(self) -> TaskBarIcon</autodoc>
</constructor>
<destructor name="~wxTaskBarIcon" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
+ <method name="Destroy" type="" overloaded="no">
+ <autodoc>Destroy(self)</autodoc>
+ <docstring>Deletes the C++ object this Python object is a proxy for.</docstring>
+ </method>
<method name="IsOk" type="bool" overloaded="no">
- <autodoc>IsOk() -> bool</autodoc>
+ <autodoc>IsOk(self) -> bool</autodoc>
</method>
<method name="IsIconInstalled" type="bool" overloaded="no">
- <autodoc>IsIconInstalled() -> bool</autodoc>
+ <autodoc>IsIconInstalled(self) -> bool</autodoc>
</method>
<method name="SetIcon" type="bool" overloaded="no">
- <autodoc>SetIcon(Icon icon, String tooltip=EmptyString) -> bool</autodoc>
+ <autodoc>SetIcon(self, Icon icon, String tooltip=EmptyString) -> bool</autodoc>
<paramlist>
<param name="icon" type="Icon" default=""/>
<param name="tooltip" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="RemoveIcon" type="bool" overloaded="no">
- <autodoc>RemoveIcon() -> bool</autodoc>
+ <autodoc>RemoveIcon(self) -> bool</autodoc>
</method>
<method name="PopupMenu" type="bool" overloaded="no">
- <autodoc>PopupMenu(Menu menu) -> bool</autodoc>
+ <autodoc>PopupMenu(self, Menu menu) -> bool</autodoc>
<paramlist>
<param name="menu" type="Menu" default=""/>
</paramlist>
</method>
</class>
- <class name="TaskBarIconEvent" oldname="wxTaskBarIconEvent" module="windows">
+ <class name="TaskBarIconEvent" oldname="wxTaskBarIconEvent" module="_windows">
<baseclass name="Event"/>
<constructor name="TaskBarIconEvent" overloaded="no">
- <autodoc>__init__(wxEventType evtType, TaskBarIcon tbIcon) -> TaskBarIconEvent</autodoc>
+ <autodoc>__init__(self, wxEventType evtType, TaskBarIcon tbIcon) -> TaskBarIconEvent</autodoc>
<paramlist>
<param name="evtType" type="wxEventType" default=""/>
<param name="tbIcon" type="TaskBarIcon" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ColourData" oldname="wxColourData" module="windows">
- <docstring>This class holds a variety of information related to colour dialogs.</docstring>
+ <class name="ColourData" oldname="wxColourData" module="_windows">
+ <docstring>This class holds a variety of information related to the colour
+chooser dialog, used to transfer settings and results to and from the
+`wx.ColourDialog`.</docstring>
<baseclass name="Object"/>
<constructor name="ColourData" overloaded="no">
- <autodoc>__init__() -> ColourData</autodoc>
+ <autodoc>__init__(self) -> ColourData</autodoc>
<docstring>Constructor, sets default values.</docstring>
</constructor>
<destructor name="~wxColourData" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetChooseFull" type="bool" overloaded="no">
- <autodoc>GetChooseFull() -> bool</autodoc>
- <docstring>Under Windows, determines whether the Windows colour dialog will display
-the full dialog with custom colour selection controls. Has no meaning
-under other platforms. The default value is true.</docstring>
+ <autodoc>GetChooseFull(self) -> bool</autodoc>
+ <docstring>Under Windows, determines whether the Windows colour dialog will
+display the full dialog with custom colour selection controls. Has no
+meaning under other platforms. The default value is true.</docstring>
</method>
<method name="GetColour" type="Colour" overloaded="no">
- <autodoc>GetColour() -> Colour</autodoc>
+ <autodoc>GetColour(self) -> Colour</autodoc>
<docstring>Gets the colour (pre)selected by the dialog.</docstring>
</method>
<method name="GetCustomColour" type="Colour" overloaded="no">
- <autodoc>GetCustomColour(int i) -> Colour</autodoc>
- <docstring>Gets the i'th custom colour associated with the colour dialog. i should
-be an integer between 0 and 15. The default custom colours are all white.</docstring>
+ <autodoc>GetCustomColour(self, int i) -> Colour</autodoc>
+ <docstring>Gets the i'th custom colour associated with the colour dialog. i
+should be an integer between 0 and 15. The default custom colours are
+all invalid colours.</docstring>
<paramlist>
<param name="i" type="int" default=""/>
</paramlist>
</method>
<method name="SetChooseFull" type="" overloaded="no">
- <autodoc>SetChooseFull(int flag)</autodoc>
- <docstring>Under Windows, tells the Windows colour dialog to display the full dialog
-with custom colour selection controls. Under other platforms, has no effect.
-The default value is true.</docstring>
+ <autodoc>SetChooseFull(self, int flag)</autodoc>
+ <docstring>Under Windows, tells the Windows colour dialog to display the full
+dialog with custom colour selection controls. Under other platforms,
+has no effect. The default value is true.</docstring>
<paramlist>
<param name="flag" type="int" default=""/>
</paramlist>
</method>
<method name="SetColour" type="" overloaded="no">
- <autodoc>SetColour(Colour colour)</autodoc>
- <docstring>Sets the default colour for the colour dialog. The default colour is black.</docstring>
+ <autodoc>SetColour(self, Colour colour)</autodoc>
+ <docstring>Sets the default colour for the colour dialog. The default colour is
+black.</docstring>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetCustomColour" type="" overloaded="no">
- <autodoc>SetCustomColour(int i, Colour colour)</autodoc>
- <docstring>Sets the i'th custom colour for the colour dialog. i should be an integer
-between 0 and 15. The default custom colours are all white.</docstring>
+ <autodoc>SetCustomColour(self, int i, Colour colour)</autodoc>
+ <docstring>Sets the i'th custom colour for the colour dialog. i should be an
+integer between 0 and 15. The default custom colours are all invalid colours.</docstring>
<paramlist>
<param name="i" type="int" default=""/>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
</class>
- <class name="ColourDialog" oldname="wxColourDialog" module="windows">
+ <class name="ColourDialog" oldname="wxColourDialog" module="_windows">
<docstring>This class represents the colour chooser dialog.</docstring>
<baseclass name="Dialog"/>
<constructor name="ColourDialog" overloaded="no">
- <autodoc>__init__(Window parent, ColourData data=None) -> ColourDialog</autodoc>
- <docstring>Constructor. Pass a parent window, and optionally a ColourData, which
-will be copied to the colour dialog's internal ColourData instance.</docstring>
+ <autodoc>__init__(self, Window parent, ColourData data=None) -> ColourDialog</autodoc>
+ <docstring>Constructor. Pass a parent window, and optionally a `wx.ColourData`,
+which will be copied to the colour dialog's internal ColourData
+instance.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="data" type="ColourData" default="NULL"/>
</paramlist>
</constructor>
<method name="GetColourData" type="ColourData" overloaded="no">
- <autodoc>GetColourData() -> ColourData</autodoc>
- <docstring>Returns a reference to the ColourData used by the dialog.</docstring>
- </method>
- </class>
- <class name="DirDialog" oldname="wxDirDialog" module="windows">
- <docstring>This class represents the directory chooser dialog.</docstring>
- <refdoc>
- Styles
- wxDD_NEW_DIR_BUTTON Add "Create new directory" button and allow
- directory names to be editable. On Windows the new
- directory button is only available with recent
- versions of the common dialogs.</refdoc>
+ <autodoc>GetColourData(self) -> ColourData</autodoc>
+ <docstring>Returns a reference to the `wx.ColourData` used by the dialog.</docstring>
+ </method>
+ </class>
+ <class name="DirDialog" oldname="wxDirDialog" module="_windows">
+ <docstring>wx.DirDialog allows the user to select a directory by browising the
+file system.</docstring>
<baseclass name="Dialog"/>
<constructor name="DirDialog" overloaded="no">
- <autodoc>__init__(Window parent, String message=DirSelectorPromptStr,
+ <autodoc>__init__(self, Window parent, String message=DirSelectorPromptStr,
String defaultPath=EmptyString, long style=0,
Point pos=DefaultPosition, Size size=DefaultSize,
String name=DirDialogNameStr) -> DirDialog</autodoc>
</paramlist>
</constructor>
<method name="GetPath" type="String" overloaded="no">
- <autodoc>GetPath() -> String</autodoc>
+ <autodoc>GetPath(self) -> String</autodoc>
<docstring>Returns the default or user-selected path.</docstring>
</method>
<method name="GetMessage" type="String" overloaded="no">
- <autodoc>GetMessage() -> String</autodoc>
+ <autodoc>GetMessage(self) -> String</autodoc>
<docstring>Returns the message that will be displayed on the dialog.</docstring>
</method>
<method name="GetStyle" type="long" overloaded="no">
- <autodoc>GetStyle() -> long</autodoc>
+ <autodoc>GetStyle(self) -> long</autodoc>
<docstring>Returns the dialog style.</docstring>
</method>
<method name="SetMessage" type="" overloaded="no">
- <autodoc>SetMessage(String message)</autodoc>
+ <autodoc>SetMessage(self, String message)</autodoc>
<docstring>Sets the message that will be displayed on the dialog.</docstring>
<paramlist>
<param name="message" type="String" default=""/>
</paramlist>
</method>
<method name="SetPath" type="" overloaded="no">
- <autodoc>SetPath(String path)</autodoc>
+ <autodoc>SetPath(self, String path)</autodoc>
<docstring>Sets the default path.</docstring>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="FileDialog" oldname="wxFileDialog" module="windows">
- <docstring>This class represents the file chooser dialog.</docstring>
- <refdoc>
-In Windows, this is the common file selector dialog. In X, this is a file
-selector box with somewhat less functionality. The path and filename are
-distinct elements of a full file pathname. If path is "", the current
-directory will be used. If filename is "", no default filename will be
-supplied. The wildcard determines what files are displayed in the file
-selector, and file extension supplies a type extension for the required
-filename.
-
-Both the X and Windows versions implement a wildcard filter. Typing a filename
-containing wildcards (*, ?) in the filename text item, and clicking on Ok,
-will result in only those files matching the pattern being displayed. The
-wildcard may be a specification for multiple types of file with a description
-for each, such as:
-
- "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
-
- Styles
- wx.OPEN This is an open dialog.
-
- wx.SAVE This is a save dialog.
-
- wx.HIDE_READONLY For open dialog only: hide the checkbox allowing to
- open the file in read-only mode.
-
- wx.OVERWRITE_PROMPT For save dialog only: prompt for a confirmation if a
- file will be overwritten.
-
- wx.MULTIPLE For open dialog only: allows selecting multiple files.
-
- wx.CHANGE_DIR Change the current working directory to the directory
- where the file(s) chosen by the user are.
-</refdoc>
+ <class name="FileDialog" oldname="wxFileDialog" module="_windows">
+ <docstring>wx.FileDialog allows the user to select one or more files from the
+filesystem.</docstring>
<baseclass name="Dialog"/>
<constructor name="FileDialog" overloaded="no">
- <autodoc>__init__(Window parent, String message=FileSelectorPromptStr,
+ <autodoc>__init__(self, Window parent, String message=FileSelectorPromptStr,
String defaultDir=EmptyString, String defaultFile=EmptyString,
String wildcard=FileSelectorDefaultWildcardStr,
long style=0, Point pos=DefaultPosition) -> FileDialog</autodoc>
</paramlist>
</constructor>
<method name="SetMessage" type="" overloaded="no">
- <autodoc>SetMessage(String message)</autodoc>
+ <autodoc>SetMessage(self, String message)</autodoc>
<docstring>Sets the message that will be displayed on the dialog.</docstring>
<paramlist>
<param name="message" type="String" default=""/>
</paramlist>
</method>
<method name="SetPath" type="" overloaded="no">
- <autodoc>SetPath(String path)</autodoc>
- <docstring>Sets the path (the combined directory and filename that will
-be returned when the dialog is dismissed).</docstring>
+ <autodoc>SetPath(self, String path)</autodoc>
+ <docstring>Sets the path (the combined directory and filename that will be
+returned when the dialog is dismissed).</docstring>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="SetDirectory" type="" overloaded="no">
- <autodoc>SetDirectory(String dir)</autodoc>
+ <autodoc>SetDirectory(self, String dir)</autodoc>
<docstring>Sets the default directory.</docstring>
<paramlist>
<param name="dir" type="String" default=""/>
</paramlist>
</method>
<method name="SetFilename" type="" overloaded="no">
- <autodoc>SetFilename(String name)</autodoc>
+ <autodoc>SetFilename(self, String name)</autodoc>
<docstring>Sets the default filename.</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="SetWildcard" type="" overloaded="no">
- <autodoc>SetWildcard(String wildCard)</autodoc>
- <docstring>Sets the wildcard, which can contain multiple file types, for example:
- "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"</docstring>
+ <autodoc>SetWildcard(self, String wildCard)</autodoc>
+ <docstring>Sets the wildcard, which can contain multiple file types, for
+example::
+
+ "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
+</docstring>
<paramlist>
<param name="wildCard" type="String" default=""/>
</paramlist>
</method>
<method name="SetStyle" type="" overloaded="no">
- <autodoc>SetStyle(long style)</autodoc>
+ <autodoc>SetStyle(self, long style)</autodoc>
<docstring>Sets the dialog style.</docstring>
<paramlist>
<param name="style" type="long" default=""/>
</paramlist>
</method>
<method name="SetFilterIndex" type="" overloaded="no">
- <autodoc>SetFilterIndex(int filterIndex)</autodoc>
+ <autodoc>SetFilterIndex(self, int filterIndex)</autodoc>
<docstring>Sets the default filter index, starting from zero.</docstring>
<paramlist>
<param name="filterIndex" type="int" default=""/>
</paramlist>
</method>
<method name="GetMessage" type="String" overloaded="no">
- <autodoc>GetMessage() -> String</autodoc>
+ <autodoc>GetMessage(self) -> String</autodoc>
<docstring>Returns the message that will be displayed on the dialog.</docstring>
</method>
<method name="GetPath" type="String" overloaded="no">
- <autodoc>GetPath() -> String</autodoc>
+ <autodoc>GetPath(self) -> String</autodoc>
<docstring>Returns the full path (directory and filename) of the selected file.</docstring>
</method>
<method name="GetDirectory" type="String" overloaded="no">
- <autodoc>GetDirectory() -> String</autodoc>
+ <autodoc>GetDirectory(self) -> String</autodoc>
<docstring>Returns the default directory.</docstring>
</method>
<method name="GetFilename" type="String" overloaded="no">
- <autodoc>GetFilename() -> String</autodoc>
+ <autodoc>GetFilename(self) -> String</autodoc>
<docstring>Returns the default filename.</docstring>
</method>
<method name="GetWildcard" type="String" overloaded="no">
- <autodoc>GetWildcard() -> String</autodoc>
+ <autodoc>GetWildcard(self) -> String</autodoc>
<docstring>Returns the file dialog wildcard.</docstring>
</method>
<method name="GetStyle" type="long" overloaded="no">
- <autodoc>GetStyle() -> long</autodoc>
+ <autodoc>GetStyle(self) -> long</autodoc>
<docstring>Returns the dialog style.</docstring>
</method>
<method name="GetFilterIndex" type="int" overloaded="no">
- <autodoc>GetFilterIndex() -> int</autodoc>
+ <autodoc>GetFilterIndex(self) -> int</autodoc>
<docstring>Returns the index into the list of filters supplied, optionally, in
the wildcard parameter. Before the dialog is shown, this is the index
-which will be used when the dialog is first displayed. After the dialog
-is shown, this is the index selected by the user.</docstring>
+which will be used when the dialog is first displayed. After the
+dialog is shown, this is the index selected by the user.</docstring>
</method>
<method name="GetFilenames" type="PyObject" overloaded="no">
- <autodoc>GetFilenames() -> PyObject</autodoc>
- <docstring>Returns a list of filenames chosen in the dialog. This function should
-only be used with the dialogs which have wx.MULTIPLE style, use
+ <autodoc>GetFilenames(self) -> PyObject</autodoc>
+ <docstring>Returns a list of filenames chosen in the dialog. This function
+should only be used with the dialogs which have wx.MULTIPLE style, use
GetFilename for the others.</docstring>
</method>
<method name="GetPaths" type="PyObject" overloaded="no">
- <autodoc>GetPaths() -> PyObject</autodoc>
+ <autodoc>GetPaths(self) -> PyObject</autodoc>
<docstring>Fills the array paths with the full paths of the files chosen. This
-function should only be used with the dialogs which have wx.MULTIPLE style,
-use GetPath for the others.</docstring>
+function should only be used with the dialogs which have wx.MULTIPLE
+style, use GetPath for the others.</docstring>
</method>
</class>
- <class name="MultiChoiceDialog" oldname="wxMultiChoiceDialog" module="windows">
+ <class name="MultiChoiceDialog" oldname="wxMultiChoiceDialog" module="_windows">
<docstring>A simple dialog with a multi selection listbox.</docstring>
<baseclass name="Dialog"/>
<constructor name="MultiChoiceDialog" overloaded="no">
<param name="message" type="String" default=""/>
<param name="caption" type="String" default=""/>
<param name="choices" type="int" default="0"/>
- <param name="choices_array" type="String" default=""/>
+ <param name="choices_array" type="String" default="NULL"/>
<param name="style" type="long" default="wxCHOICEDLG_STYLE"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
</paramlist>
</constructor>
<method name="SetSelections" type="" overloaded="no">
<autodoc>SetSelections(List selections)</autodoc>
- <docstring>Specify the items in the list that shoudl be selected, using a list of integers.</docstring>
<paramlist>
<param name="selections" type="wxArrayInt" default=""/>
</paramlist>
<docstring>Returns a list of integers representing the items that are selected.</docstring>
</method>
</class>
- <class name="SingleChoiceDialog" oldname="wxSingleChoiceDialog" module="windows">
+ <class name="SingleChoiceDialog" oldname="wxSingleChoiceDialog" module="_windows">
<docstring>A simple dialog with a single selection listbox.</docstring>
<baseclass name="Dialog"/>
<constructor name="SingleChoiceDialog" overloaded="no">
</paramlist>
</constructor>
<method name="GetSelection" type="int" overloaded="no">
- <autodoc>GetSelection() -> int</autodoc>
+ <autodoc>GetSelection(self) -> int</autodoc>
<docstring>Get the index of teh currently selected item.</docstring>
</method>
<method name="GetStringSelection" type="String" overloaded="no">
- <autodoc>GetStringSelection() -> String</autodoc>
+ <autodoc>GetStringSelection(self) -> String</autodoc>
<docstring>Returns the string value of the currently selected item</docstring>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(int sel)</autodoc>
+ <autodoc>SetSelection(self, int sel)</autodoc>
<docstring>Set the current selected item to sel</docstring>
<paramlist>
<param name="sel" type="int" default=""/>
</paramlist>
</method>
</class>
- <class name="TextEntryDialog" oldname="wxTextEntryDialog" module="windows">
+ <class name="TextEntryDialog" oldname="wxTextEntryDialog" module="_windows">
<docstring>A dialog with text control, [ok] and [cancel] buttons</docstring>
<baseclass name="Dialog"/>
<constructor name="TextEntryDialog" overloaded="no">
- <autodoc>__init__(Window parent, String message, String caption=GetTextFromUserPromptStr,
+ <autodoc>__init__(self, Window parent, String message, String caption=GetTextFromUserPromptStr,
String defaultValue=EmptyString,
long style=wxOK|wxCANCEL|wxCENTRE, Point pos=DefaultPosition) -> TextEntryDialog</autodoc>
<docstring>Constructor. Use ShowModal method to show the dialog.</docstring>
</paramlist>
</constructor>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
<docstring>Returns the text that the user has entered if the user has pressed OK,
or the original value if the user has pressed Cancel.</docstring>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(String value)</autodoc>
+ <autodoc>SetValue(self, String value)</autodoc>
<docstring>Sets the default text value.</docstring>
<paramlist>
<param name="value" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="FontData" oldname="wxFontData" module="windows">
- <docstring>This class holds a variety of information related to font dialogs.</docstring>
+ <class name="FontData" oldname="wxFontData" module="_windows">
+ <docstring>This class holds a variety of information related to font dialogs and
+is used to transfer settings to and results from a `wx.FontDialog`.</docstring>
<baseclass name="Object"/>
<constructor name="FontData" overloaded="no">
- <autodoc>__init__() -> FontData</autodoc>
- <docstring>This class holds a variety of information related to font dialogs.</docstring>
+ <autodoc>__init__(self) -> FontData</autodoc>
+ <docstring>This class holds a variety of information related to font dialogs and
+is used to transfer settings to and results from a `wx.FontDialog`.</docstring>
</constructor>
<destructor name="~wxFontData" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="EnableEffects" type="" overloaded="no">
- <autodoc>EnableEffects(bool enable)</autodoc>
- <docstring>Enables or disables 'effects' under MS Windows only. This refers
-to the controls for manipulating colour, strikeout and underline
+ <autodoc>EnableEffects(self, bool enable)</autodoc>
+ <docstring>Enables or disables 'effects' under MS Windows only. This refers to
+the controls for manipulating colour, strikeout and underline
properties. The default value is true.</docstring>
<paramlist>
<param name="enable" type="bool" default=""/>
</paramlist>
</method>
<method name="GetAllowSymbols" type="bool" overloaded="no">
- <autodoc>GetAllowSymbols() -> bool</autodoc>
- <docstring>Under MS Windows, returns a flag determining whether symbol fonts can be
-selected. Has no effect on other platforms. The default value is true.</docstring>
+ <autodoc>GetAllowSymbols(self) -> bool</autodoc>
+ <docstring>Under MS Windows, returns a flag determining whether symbol fonts can
+be selected. Has no effect on other platforms. The default value is
+true.</docstring>
</method>
<method name="GetColour" type="Colour" overloaded="no">
- <autodoc>GetColour() -> Colour</autodoc>
- <docstring>Gets the colour associated with the font dialog. The default value is black.</docstring>
+ <autodoc>GetColour(self) -> Colour</autodoc>
+ <docstring>Gets the colour associated with the font dialog. The default value is
+black.</docstring>
</method>
<method name="GetChosenFont" type="Font" overloaded="no">
- <autodoc>GetChosenFont() -> Font</autodoc>
+ <autodoc>GetChosenFont(self) -> Font</autodoc>
<docstring>Gets the font chosen by the user.</docstring>
</method>
<method name="GetEnableEffects" type="bool" overloaded="no">
- <autodoc>GetEnableEffects() -> bool</autodoc>
+ <autodoc>GetEnableEffects(self) -> bool</autodoc>
<docstring>Determines whether 'effects' are enabled under Windows.</docstring>
</method>
<method name="GetInitialFont" type="Font" overloaded="no">
- <autodoc>GetInitialFont() -> Font</autodoc>
- <docstring>Gets the font that will be initially used by the font dialog. This should have
-previously been set by the application.</docstring>
+ <autodoc>GetInitialFont(self) -> Font</autodoc>
+ <docstring>Gets the font that will be initially used by the font dialog. This
+should have previously been set by the application.</docstring>
</method>
<method name="GetShowHelp" type="bool" overloaded="no">
- <autodoc>GetShowHelp() -> bool</autodoc>
- <docstring>Returns true if the Help button will be shown (Windows only). The default
-value is false.</docstring>
+ <autodoc>GetShowHelp(self) -> bool</autodoc>
+ <docstring>Returns true if the Help button will be shown (Windows only). The
+default value is false.</docstring>
</method>
<method name="SetAllowSymbols" type="" overloaded="no">
- <autodoc>SetAllowSymbols(bool allowSymbols)</autodoc>
- <docstring>Under MS Windows, determines whether symbol fonts can be selected. Has no
-effect on other platforms. The default value is true.</docstring>
+ <autodoc>SetAllowSymbols(self, bool allowSymbols)</autodoc>
+ <docstring>Under MS Windows, determines whether symbol fonts can be selected. Has
+no effect on other platforms. The default value is true.</docstring>
<paramlist>
<param name="allowSymbols" type="bool" default=""/>
</paramlist>
</method>
<method name="SetChosenFont" type="" overloaded="no">
- <autodoc>SetChosenFont(Font font)</autodoc>
- <docstring>Sets the font that will be returned to the user (for internal use only).</docstring>
+ <autodoc>SetChosenFont(self, Font font)</autodoc>
+ <docstring>Sets the font that will be returned to the user (normally for internal
+use only).</docstring>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="SetColour" type="" overloaded="no">
- <autodoc>SetColour(Colour colour)</autodoc>
- <docstring>Sets the colour that will be used for the font foreground colour. The default
-colour is black.</docstring>
+ <autodoc>SetColour(self, Colour colour)</autodoc>
+ <docstring>Sets the colour that will be used for the font foreground colour. The
+default colour is black.</docstring>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetInitialFont" type="" overloaded="no">
- <autodoc>SetInitialFont(Font font)</autodoc>
+ <autodoc>SetInitialFont(self, Font font)</autodoc>
<docstring>Sets the font that will be initially used by the font dialog.</docstring>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="SetRange" type="" overloaded="no">
- <autodoc>SetRange(int min, int max)</autodoc>
- <docstring>Sets the valid range for the font point size (Windows only). The default is
-0, 0 (unrestricted range).</docstring>
+ <autodoc>SetRange(self, int min, int max)</autodoc>
+ <docstring>Sets the valid range for the font point size (Windows only). The
+default is 0, 0 (unrestricted range).</docstring>
<paramlist>
<param name="min" type="int" default=""/>
<param name="max" type="int" default=""/>
</paramlist>
</method>
<method name="SetShowHelp" type="" overloaded="no">
- <autodoc>SetShowHelp(bool showHelp)</autodoc>
- <docstring>Determines whether the Help button will be displayed in the font dialog
-(Windows only). The default value is false.</docstring>
+ <autodoc>SetShowHelp(self, bool showHelp)</autodoc>
+ <docstring>Determines whether the Help button will be displayed in the font
+dialog (Windows only). The default value is false.</docstring>
<paramlist>
<param name="showHelp" type="bool" default=""/>
</paramlist>
</method>
</class>
- <class name="FontDialog" oldname="wxFontDialog" module="windows">
- <docstring>This class represents the font chooser dialog.</docstring>
+ <class name="FontDialog" oldname="wxFontDialog" module="_windows">
+ <docstring>wx.FontDialog allows the user to select a system font and its attributes.
+
+:see: `wx.FontData`
+</docstring>
<baseclass name="Dialog"/>
<constructor name="FontDialog" overloaded="no">
- <autodoc>__init__(Window parent, FontData data) -> FontDialog</autodoc>
- <docstring>Constructor. Pass a parent window and the FontData object to be
-used to initialize the dialog controls.</docstring>
+ <autodoc>__init__(self, Window parent, FontData data) -> FontDialog</autodoc>
+ <docstring>Constructor. Pass a parent window and the `wx.FontData` object to be
+used to initialize the dialog controls. Call `ShowModal` to display
+the dialog. If ShowModal returns ``wx.ID_OK`` then you can fetch the
+results with via the `wx.FontData` returned by `GetFontData`.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="data" type="FontData" default=""/>
</paramlist>
</constructor>
<method name="GetFontData" type="FontData" overloaded="no">
- <autodoc>GetFontData() -> FontData</autodoc>
- <docstring>Returns a reference to the internal FontData used by the FontDialog.</docstring>
+ <autodoc>GetFontData(self) -> FontData</autodoc>
+ <docstring>Returns a reference to the internal `wx.FontData` used by the
+wx.FontDialog.</docstring>
</method>
</class>
- <class name="MessageDialog" oldname="wxMessageDialog" module="windows">
- <docstring>This class provides a dialog that shows a single or multi-line message, with
-a choice of OK, Yes, No and Cancel buttons.</docstring>
- <refdoc>
- Styles
- wx.OK: Show an OK button.
-
- wx.CANCEL: Show a Cancel button.
-
- wx.YES_NO: Show Yes and No buttons.
-
- wx.YES_DEFAULT: Used with wxYES_NO, makes Yes button the default - which is the default behaviour.
-
- wx.NO_DEFAULT: Used with wxYES_NO, makes No button the default.
-
- wx.ICON_EXCLAMATION: Shows an exclamation mark icon.
-
- wx.ICON_HAND: Shows an error icon.
-
- wx.ICON_ERROR: Shows an error icon - the same as wxICON_HAND.
-
- wx.ICON_QUESTION: Shows a question mark icon.
-
- wx.ICON_INFORMATION: Shows an information (i) icon.
-
- wx.STAY_ON_TOP: The message box stays on top of all other window, even those of the other applications (Windows only).
-</refdoc>
+ <class name="MessageDialog" oldname="wxMessageDialog" module="_windows">
+ <docstring>This class provides a simple dialog that shows a single or multi-line
+message, with a choice of OK, Yes, No and/or Cancel buttons.</docstring>
<baseclass name="Dialog"/>
<constructor name="MessageDialog" overloaded="no">
- <autodoc>__init__(Window parent, String message, String caption=MessageBoxCaptionStr,
+ <autodoc>__init__(self, Window parent, String message, String caption=MessageBoxCaptionStr,
long style=wxOK|wxCANCEL|wxCENTRE,
Point pos=DefaultPosition) -> MessageDialog</autodoc>
- <docstring>This class provides a dialog that shows a single or multi-line message, with
-a choice of OK, Yes, No and Cancel buttons.</docstring>
+ <docstring>Constructor, use `ShowModal` to display the dialog.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="message" type="String" default=""/>
</paramlist>
</constructor>
</class>
- <class name="ProgressDialog" oldname="wxProgressDialog" module="windows">
- <docstring>A dialog that shows a short message and a progress bar. Optionally, it can
-display an ABORT button.</docstring>
- <refdoc>
- Styles
-
- wx.PD_APP_MODAL: Make the progress dialog modal. If this flag is
- not given, it is only "locally" modal - that is
- the input to the parent window is disabled,
- but not to the other ones.
-
- wx.PD_AUTO_HIDE: Causes the progress dialog to disappear from screen
- as soon as the maximum value of the progress
- meter has been reached.
-
- wx.PD_CAN_ABORT: This flag tells the dialog that it should have
- a "Cancel" button which the user may press. If
- this happens, the next call to Update() will
- return false.
-
- wx.PD_ELAPSED_TIME: This flag tells the dialog that it should show
- elapsed time (since creating the dialog).
-
- wx.PD_ESTIMATED_TIME: This flag tells the dialog that it should show
- estimated time.
-
- wx.PD_REMAINING_TIME: This flag tells the dialog that it should show
- remaining time.
-</refdoc>
+ <class name="ProgressDialog" oldname="wxProgressDialog" module="_windows">
+ <docstring>A dialog that shows a short message and a progress bar. Optionally, it
+can display an ABORT button.</docstring>
<baseclass name="Frame"/>
<constructor name="ProgressDialog" overloaded="no">
- <autodoc>__init__(String title, String message, int maximum=100, Window parent=None,
+ <autodoc>__init__(self, String title, String message, int maximum=100, Window parent=None,
int style=wxPD_AUTO_HIDE|wxPD_APP_MODAL) -> ProgressDialog</autodoc>
- <docstring>Constructor. Creates the dialog, displays it and disables user input for other
-windows, or, if wxPD_APP_MODAL flag is not given, for its parent window only.</docstring>
+ <docstring>Constructor. Creates the dialog, displays it and disables user input
+for other windows, or, if wx.PD_APP_MODAL flag is not given, for its
+parent window only.</docstring>
<paramlist>
<param name="title" type="String" default=""/>
<param name="message" type="String" default=""/>
</paramlist>
</constructor>
<method name="Update" type="bool" overloaded="no">
- <autodoc>Update(int value, String newmsg=EmptyString) -> bool</autodoc>
- <docstring>Updates the dialog, setting the progress bar to the new value and, if given
-changes the message above it. Returns true unless the Cancel button has been
-pressed.
+ <autodoc>Update(self, int value, String newmsg=EmptyString) -> bool</autodoc>
+ <docstring>Updates the dialog, setting the progress bar to the new value and, if
+given changes the message above it. Returns true unless the Cancel
+button has been pressed.
-If false is returned, the application can either immediately destroy the
-dialog or ask the user for the confirmation and if the abort is not confirmed
-the dialog may be resumed with Resume function.</docstring>
+If false is returned, the application can either immediately destroy
+the dialog or ask the user for the confirmation and if the abort is
+not confirmed the dialog may be resumed with Resume function.</docstring>
<paramlist>
<param name="value" type="int" default=""/>
<param name="newmsg" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="Resume" type="" overloaded="no">
- <autodoc>Resume()</autodoc>
- <docstring>Can be used to continue with the dialog, after the user had chosen to abort.</docstring>
+ <autodoc>Resume(self)</autodoc>
+ <docstring>Can be used to continue with the dialog, after the user had chosen to
+abort.</docstring>
</method>
</class>
<pythoncode>
EVT_COMMAND_FIND_REPLACE_ALL = EVT_FIND_REPLACE_ALL
EVT_COMMAND_FIND_CLOSE = EVT_FIND_CLOSE
</pythoncode>
- <class name="FindDialogEvent" oldname="wxFindDialogEvent" module="windows">
+ <class name="FindDialogEvent" oldname="wxFindDialogEvent" module="_windows">
<docstring>Events for the FindReplaceDialog</docstring>
<baseclass name="CommandEvent"/>
<constructor name="FindDialogEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int id=0) -> FindDialogEvent</autodoc>
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> FindDialogEvent</autodoc>
<docstring>Events for the FindReplaceDialog</docstring>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
</paramlist>
</constructor>
<method name="GetFlags" type="int" overloaded="no">
- <autodoc>GetFlags() -> int</autodoc>
+ <autodoc>GetFlags(self) -> int</autodoc>
<docstring>Get the currently selected flags: this is the combination of
wx.FR_DOWN, wx.FR_WHOLEWORD and wx.FR_MATCHCASE flags.</docstring>
</method>
<method name="GetFindString" type="String" overloaded="no">
- <autodoc>GetFindString() -> String</autodoc>
+ <autodoc>GetFindString(self) -> String</autodoc>
<docstring>Return the string to find (never empty).</docstring>
</method>
<method name="GetReplaceString" type="String" overloaded="no">
- <autodoc>GetReplaceString() -> String</autodoc>
- <docstring>Return the string to replace the search string with (only
-for replace and replace all events).</docstring>
+ <autodoc>GetReplaceString(self) -> String</autodoc>
+ <docstring>Return the string to replace the search string with (only for replace
+and replace all events).</docstring>
</method>
<method name="GetDialog" type="wxFindReplaceDialog" overloaded="no">
- <autodoc>GetDialog() -> FindReplaceDialog</autodoc>
+ <autodoc>GetDialog(self) -> FindReplaceDialog</autodoc>
<docstring>Return the pointer to the dialog which generated this event.</docstring>
</method>
<method name="SetFlags" type="" overloaded="no">
- <autodoc>SetFlags(int flags)</autodoc>
+ <autodoc>SetFlags(self, int flags)</autodoc>
<paramlist>
<param name="flags" type="int" default=""/>
</paramlist>
</method>
<method name="SetFindString" type="" overloaded="no">
- <autodoc>SetFindString(String str)</autodoc>
+ <autodoc>SetFindString(self, String str)</autodoc>
<paramlist>
<param name="str" type="String" default=""/>
</paramlist>
</method>
<method name="SetReplaceString" type="" overloaded="no">
- <autodoc>SetReplaceString(String str)</autodoc>
+ <autodoc>SetReplaceString(self, String str)</autodoc>
<paramlist>
<param name="str" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="FindReplaceData" oldname="wxFindReplaceData" module="windows">
- <docstring>FindReplaceData holds the data for FindReplaceDialog. It is used to initialize
-the dialog with the default values and will keep the last values from the
-dialog when it is closed. It is also updated each time a wxFindDialogEvent is
-generated so instead of using the wxFindDialogEvent methods you can also
-directly query this object.
-
-Note that all SetXXX() methods may only be called before showing the dialog
-and calling them has no effect later.
+ <class name="FindReplaceData" oldname="wxFindReplaceData" module="_windows">
+ <docstring>wx.FindReplaceData holds the data for wx.FindReplaceDialog. It is used
+to initialize the dialog with the default values and will keep the
+last values from the dialog when it is closed. It is also updated each
+time a `wx.FindDialogEvent` is generated so instead of using the
+`wx.FindDialogEvent` methods you can also directly query this object.
- Flags
- wxFR_DOWN: downward search/replace selected (otherwise, upwards)
-
- wxFR_WHOLEWORD: whole word search/replace selected
-
- wxFR_MATCHCASE: case sensitive search/replace selected (otherwise,
- case insensitive)
-</docstring>
+Note that all SetXXX() methods may only be called before showing the
+dialog and calling them has no effect later.</docstring>
<baseclass name="Object"/>
<constructor name="FindReplaceData" overloaded="no">
- <autodoc>__init__(int flags=0) -> FindReplaceData</autodoc>
+ <autodoc>__init__(self, int flags=0) -> FindReplaceData</autodoc>
<docstring>Constuctor initializes the flags to default value (0).</docstring>
<paramlist>
<param name="flags" type="int" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxFindReplaceData" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetFindString" type="String" overloaded="no">
- <autodoc>GetFindString() -> String</autodoc>
+ <autodoc>GetFindString(self) -> String</autodoc>
<docstring>Get the string to find.</docstring>
</method>
<method name="GetReplaceString" type="String" overloaded="no">
- <autodoc>GetReplaceString() -> String</autodoc>
+ <autodoc>GetReplaceString(self) -> String</autodoc>
<docstring>Get the replacement string.</docstring>
</method>
<method name="GetFlags" type="int" overloaded="no">
- <autodoc>GetFlags() -> int</autodoc>
+ <autodoc>GetFlags(self) -> int</autodoc>
<docstring>Get the combination of flag values.</docstring>
</method>
<method name="SetFlags" type="" overloaded="no">
- <autodoc>SetFlags(int flags)</autodoc>
+ <autodoc>SetFlags(self, int flags)</autodoc>
<docstring>Set the flags to use to initialize the controls of the dialog.</docstring>
<paramlist>
<param name="flags" type="int" default=""/>
</paramlist>
</method>
<method name="SetFindString" type="" overloaded="no">
- <autodoc>SetFindString(String str)</autodoc>
+ <autodoc>SetFindString(self, String str)</autodoc>
<docstring>Set the string to find (used as initial value by the dialog).</docstring>
<paramlist>
<param name="str" type="String" default=""/>
</paramlist>
</method>
<method name="SetReplaceString" type="" overloaded="no">
- <autodoc>SetReplaceString(String str)</autodoc>
+ <autodoc>SetReplaceString(self, String str)</autodoc>
<docstring>Set the replacement string (used as initial value by the dialog).</docstring>
<paramlist>
<param name="str" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="FindReplaceDialog" oldname="wxFindReplaceDialog" module="windows">
- <docstring>FindReplaceDialog is a standard modeless dialog which is used to allow the
-user to search for some text (and possibly replace it with something
-else). The actual searching is supposed to be done in the owner window which
-is the parent of this dialog. Note that it means that unlike for the other
-standard dialogs this one must have a parent window. Also note that there is
-no way to use this dialog in a modal way; it is always, by design and
-implementation, modeless.</docstring>
- <refdoc>
- Styles
- wx.FR_REPLACEDIALOG: replace dialog (otherwise find dialog)
-
- wx.FR_NOUPDOWN: don't allow changing the search direction
-
- wx.FR_NOMATCHCASE: don't allow case sensitive searching
-
- wx.FR_NOWHOLEWORD: don't allow whole word searching
-</refdoc>
+ <class name="FindReplaceDialog" oldname="wxFindReplaceDialog" module="_windows">
+ <docstring>wx.FindReplaceDialog is a standard modeless dialog which is used to
+allow the user to search for some text (and possibly replace it with
+something else). The actual searching is supposed to be done in the
+owner window which is the parent of this dialog. Note that it means
+that unlike for the other standard dialogs this one must have a parent
+window. Also note that there is no way to use this dialog in a modal
+way; it is always, by design and implementation, modeless.</docstring>
<baseclass name="Dialog"/>
<constructor name="FindReplaceDialog" overloaded="no">
- <autodoc>__init__(Window parent, FindReplaceData data, String title,
+ <autodoc>__init__(self, Window parent, FindReplaceData data, String title,
int style=0) -> FindReplaceDialog</autodoc>
<docstring>Create a FindReplaceDialog. The parent and data parameters must be
non-None. Use Show to display the dialog.</docstring>
<docstring>Precreate a FindReplaceDialog for 2-phase creation</docstring>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, FindReplaceData data, String title,
+ <autodoc>Create(self, Window parent, FindReplaceData data, String title,
int style=0) -> bool</autodoc>
<docstring>Create the dialog, for 2-phase create.</docstring>
<paramlist>
</paramlist>
</method>
<method name="GetData" type="FindReplaceData" overloaded="no">
- <autodoc>GetData() -> FindReplaceData</autodoc>
+ <autodoc>GetData(self) -> FindReplaceData</autodoc>
<docstring>Get the FindReplaceData object used by this dialog.</docstring>
</method>
<method name="SetData" type="" overloaded="no">
- <autodoc>SetData(FindReplaceData data)</autodoc>
+ <autodoc>SetData(self, FindReplaceData data)</autodoc>
<docstring>Set the FindReplaceData object used by this dialog.</docstring>
<paramlist>
<param name="data" type="FindReplaceData" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="MDIParentFrame" oldname="wxMDIParentFrame" module="windows">
+ <class name="MDIParentFrame" oldname="wxMDIParentFrame" module="_windows">
<baseclass name="Frame"/>
<constructor name="MDIParentFrame" overloaded="no">
- <autodoc>__init__(Window parent, int id, String title, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL,
+ <autodoc>__init__(self, Window parent, int id=-1, String title=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL,
String name=FrameNameStr) -> MDIParentFrame</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="title" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="title" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL"/>
<autodoc>PreMDIParentFrame() -> MDIParentFrame</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String title, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL,
+ <autodoc>Create(self, Window parent, int id=-1, String title=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL,
String name=FrameNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="title" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="title" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL"/>
</paramlist>
</method>
<method name="ActivateNext" type="" overloaded="no">
- <autodoc>ActivateNext()</autodoc>
+ <autodoc>ActivateNext(self)</autodoc>
</method>
<method name="ActivatePrevious" type="" overloaded="no">
- <autodoc>ActivatePrevious()</autodoc>
+ <autodoc>ActivatePrevious(self)</autodoc>
</method>
<method name="ArrangeIcons" type="" overloaded="no">
- <autodoc>ArrangeIcons()</autodoc>
+ <autodoc>ArrangeIcons(self)</autodoc>
</method>
<method name="Cascade" type="" overloaded="no">
- <autodoc>Cascade()</autodoc>
+ <autodoc>Cascade(self)</autodoc>
</method>
<method name="GetActiveChild" type="wxMDIChildFrame" overloaded="no">
- <autodoc>GetActiveChild() -> MDIChildFrame</autodoc>
+ <autodoc>GetActiveChild(self) -> MDIChildFrame</autodoc>
</method>
<method name="GetClientWindow" type="wxMDIClientWindow" overloaded="no">
- <autodoc>GetClientWindow() -> MDIClientWindow</autodoc>
+ <autodoc>GetClientWindow(self) -> MDIClientWindow</autodoc>
</method>
<method name="GetToolBar" type="Window" overloaded="no">
- <autodoc>GetToolBar() -> Window</autodoc>
+ <autodoc>GetToolBar(self) -> Window</autodoc>
</method>
<method name="Tile" type="" overloaded="no">
- <autodoc>Tile()</autodoc>
+ <autodoc>Tile(self)</autodoc>
</method>
</class>
- <class name="MDIChildFrame" oldname="wxMDIChildFrame" module="windows">
+ <class name="MDIChildFrame" oldname="wxMDIChildFrame" module="_windows">
<baseclass name="Frame"/>
<constructor name="MDIChildFrame" overloaded="no">
- <autodoc>__init__(MDIParentFrame parent, int id, String title, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
+ <autodoc>__init__(self, MDIParentFrame parent, int id=-1, String title=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=DEFAULT_FRAME_STYLE,
String name=FrameNameStr) -> MDIChildFrame</autodoc>
<paramlist>
<param name="parent" type="MDIParentFrame" default=""/>
- <param name="id" type="int" default=""/>
- <param name="title" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="title" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxDEFAULT_FRAME_STYLE"/>
<autodoc>PreMDIChildFrame() -> MDIChildFrame</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(MDIParentFrame parent, int id, String title, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE,
+ <autodoc>Create(self, MDIParentFrame parent, int id=-1, String title=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=DEFAULT_FRAME_STYLE,
String name=FrameNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="MDIParentFrame" default=""/>
- <param name="id" type="int" default=""/>
- <param name="title" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="title" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxDEFAULT_FRAME_STYLE"/>
</paramlist>
</method>
<method name="Activate" type="" overloaded="no">
- <autodoc>Activate()</autodoc>
+ <autodoc>Activate(self)</autodoc>
</method>
<method name="Maximize" type="" overloaded="no">
- <autodoc>Maximize(bool maximize)</autodoc>
+ <autodoc>Maximize(self, bool maximize)</autodoc>
<paramlist>
<param name="maximize" type="bool" default=""/>
</paramlist>
</method>
<method name="Restore" type="" overloaded="no">
- <autodoc>Restore()</autodoc>
+ <autodoc>Restore(self)</autodoc>
</method>
</class>
- <class name="MDIClientWindow" oldname="wxMDIClientWindow" module="windows">
+ <class name="MDIClientWindow" oldname="wxMDIClientWindow" module="_windows">
<baseclass name="Window"/>
<constructor name="MDIClientWindow" overloaded="no">
- <autodoc>__init__(MDIParentFrame parent, long style=0) -> MDIClientWindow</autodoc>
+ <autodoc>__init__(self, MDIParentFrame parent, long style=0) -> MDIClientWindow</autodoc>
<paramlist>
<param name="parent" type="MDIParentFrame" default=""/>
<param name="style" type="long" default="0"/>
<autodoc>PreMDIClientWindow() -> MDIClientWindow</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(MDIParentFrame parent, long style=0) -> bool</autodoc>
+ <autodoc>Create(self, MDIParentFrame parent, long style=0) -> bool</autodoc>
<paramlist>
<param name="parent" type="MDIParentFrame" default=""/>
<param name="style" type="long" default="0"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PyWindow" oldname="wxPyWindow" module="windows">
+ <class name="PyWindow" oldname="wxPyWindow" module="_windows">
<baseclass name="Window"/>
<constructor name="PyWindow" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, String name=PanelNameStr) -> PyWindow</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, String name=PanelNameStr) -> PyWindow</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<param name="name" type="String" default="wxPyPanelNameStr"/>
</paramlist>
</constructor>
+ <constructor name="PrePyWindow" overloaded="no">
+ <autodoc>PrePyWindow() -> PyWindow</autodoc>
+ </constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
+ <method name="SetBestSize" type="" overloaded="no">
+ <autodoc>SetBestSize(self, Size size)</autodoc>
+ <paramlist>
+ <param name="size" type="Size" default=""/>
+ </paramlist>
+ </method>
<method name="base_DoMoveWindow" type="" overloaded="no">
- <autodoc>base_DoMoveWindow(int x, int y, int width, int height)</autodoc>
+ <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetSize" type="" overloaded="no">
- <autodoc>base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
+ <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetClientSize" type="" overloaded="no">
- <autodoc>base_DoSetClientSize(int width, int height)</autodoc>
+ <autodoc>base_DoSetClientSize(self, int width, int height)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetVirtualSize" type="" overloaded="no">
- <autodoc>base_DoSetVirtualSize(int x, int y)</autodoc>
+ <autodoc>base_DoSetVirtualSize(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoGetVirtualSize" type="Size" overloaded="no">
- <autodoc>base_DoGetVirtualSize() -> Size</autodoc>
+ <autodoc>base_DoGetVirtualSize(self) -> Size</autodoc>
</method>
<method name="base_DoGetBestSize" type="Size" overloaded="no">
- <autodoc>base_DoGetBestSize() -> Size</autodoc>
+ <autodoc>base_DoGetBestSize(self) -> Size</autodoc>
</method>
<method name="base_InitDialog" type="" overloaded="no">
- <autodoc>base_InitDialog()</autodoc>
+ <autodoc>base_InitDialog(self)</autodoc>
</method>
<method name="base_TransferDataToWindow" type="bool" overloaded="no">
- <autodoc>base_TransferDataToWindow() -> bool</autodoc>
+ <autodoc>base_TransferDataToWindow(self) -> bool</autodoc>
</method>
<method name="base_TransferDataFromWindow" type="bool" overloaded="no">
- <autodoc>base_TransferDataFromWindow() -> bool</autodoc>
+ <autodoc>base_TransferDataFromWindow(self) -> bool</autodoc>
</method>
<method name="base_Validate" type="bool" overloaded="no">
- <autodoc>base_Validate() -> bool</autodoc>
+ <autodoc>base_Validate(self) -> bool</autodoc>
</method>
<method name="base_AcceptsFocus" type="bool" overloaded="no">
- <autodoc>base_AcceptsFocus() -> bool</autodoc>
+ <autodoc>base_AcceptsFocus(self) -> bool</autodoc>
</method>
<method name="base_AcceptsFocusFromKeyboard" type="bool" overloaded="no">
- <autodoc>base_AcceptsFocusFromKeyboard() -> bool</autodoc>
+ <autodoc>base_AcceptsFocusFromKeyboard(self) -> bool</autodoc>
</method>
<method name="base_GetMaxSize" type="Size" overloaded="no">
- <autodoc>base_GetMaxSize() -> Size</autodoc>
+ <autodoc>base_GetMaxSize(self) -> Size</autodoc>
</method>
<method name="base_AddChild" type="" overloaded="no">
- <autodoc>base_AddChild(Window child)</autodoc>
+ <autodoc>base_AddChild(self, Window child)</autodoc>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
<method name="base_RemoveChild" type="" overloaded="no">
- <autodoc>base_RemoveChild(Window child)</autodoc>
+ <autodoc>base_RemoveChild(self, Window child)</autodoc>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
+ <method name="base_ShouldInheritColours" type="bool" overloaded="no">
+ <autodoc>base_ShouldInheritColours(self) -> bool</autodoc>
+ </method>
+ <method name="base_ApplyParentThemeBackground" type="" overloaded="no">
+ <autodoc>base_ApplyParentThemeBackground(self, Colour c)</autodoc>
+ <paramlist>
+ <param name="c" type="Colour" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_GetDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>base_GetDefaultAttributes(self) -> VisualAttributes</autodoc>
+ </method>
</class>
- <class name="PyPanel" oldname="wxPyPanel" module="windows">
+ <class name="PyPanel" oldname="wxPyPanel" module="_windows">
<baseclass name="Panel"/>
<constructor name="PyPanel" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, String name=PanelNameStr) -> PyPanel</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, String name=PanelNameStr) -> PyPanel</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<param name="name" type="String" default="wxPyPanelNameStr"/>
</paramlist>
</constructor>
+ <constructor name="PrePyPanel" overloaded="no">
+ <autodoc>PrePyPanel() -> PyPanel</autodoc>
+ </constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
+ <method name="SetBestSize" type="" overloaded="no">
+ <autodoc>SetBestSize(self, Size size)</autodoc>
+ <paramlist>
+ <param name="size" type="Size" default=""/>
+ </paramlist>
+ </method>
<method name="base_DoMoveWindow" type="" overloaded="no">
- <autodoc>base_DoMoveWindow(int x, int y, int width, int height)</autodoc>
+ <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetSize" type="" overloaded="no">
- <autodoc>base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
+ <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetClientSize" type="" overloaded="no">
- <autodoc>base_DoSetClientSize(int width, int height)</autodoc>
+ <autodoc>base_DoSetClientSize(self, int width, int height)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetVirtualSize" type="" overloaded="no">
- <autodoc>base_DoSetVirtualSize(int x, int y)</autodoc>
+ <autodoc>base_DoSetVirtualSize(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoGetVirtualSize" type="Size" overloaded="no">
- <autodoc>base_DoGetVirtualSize() -> Size</autodoc>
+ <autodoc>base_DoGetVirtualSize(self) -> Size</autodoc>
</method>
<method name="base_DoGetBestSize" type="Size" overloaded="no">
- <autodoc>base_DoGetBestSize() -> Size</autodoc>
+ <autodoc>base_DoGetBestSize(self) -> Size</autodoc>
</method>
<method name="base_InitDialog" type="" overloaded="no">
- <autodoc>base_InitDialog()</autodoc>
+ <autodoc>base_InitDialog(self)</autodoc>
</method>
<method name="base_TransferDataToWindow" type="bool" overloaded="no">
- <autodoc>base_TransferDataToWindow() -> bool</autodoc>
+ <autodoc>base_TransferDataToWindow(self) -> bool</autodoc>
</method>
<method name="base_TransferDataFromWindow" type="bool" overloaded="no">
- <autodoc>base_TransferDataFromWindow() -> bool</autodoc>
+ <autodoc>base_TransferDataFromWindow(self) -> bool</autodoc>
</method>
<method name="base_Validate" type="bool" overloaded="no">
- <autodoc>base_Validate() -> bool</autodoc>
+ <autodoc>base_Validate(self) -> bool</autodoc>
</method>
<method name="base_AcceptsFocus" type="bool" overloaded="no">
- <autodoc>base_AcceptsFocus() -> bool</autodoc>
+ <autodoc>base_AcceptsFocus(self) -> bool</autodoc>
</method>
<method name="base_AcceptsFocusFromKeyboard" type="bool" overloaded="no">
- <autodoc>base_AcceptsFocusFromKeyboard() -> bool</autodoc>
+ <autodoc>base_AcceptsFocusFromKeyboard(self) -> bool</autodoc>
</method>
<method name="base_GetMaxSize" type="Size" overloaded="no">
- <autodoc>base_GetMaxSize() -> Size</autodoc>
+ <autodoc>base_GetMaxSize(self) -> Size</autodoc>
</method>
<method name="base_AddChild" type="" overloaded="no">
- <autodoc>base_AddChild(Window child)</autodoc>
+ <autodoc>base_AddChild(self, Window child)</autodoc>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
<method name="base_RemoveChild" type="" overloaded="no">
- <autodoc>base_RemoveChild(Window child)</autodoc>
+ <autodoc>base_RemoveChild(self, Window child)</autodoc>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
+ <method name="base_ShouldInheritColours" type="bool" overloaded="no">
+ <autodoc>base_ShouldInheritColours(self) -> bool</autodoc>
+ </method>
+ <method name="base_ApplyParentThemeBackground" type="" overloaded="no">
+ <autodoc>base_ApplyParentThemeBackground(self, Colour c)</autodoc>
+ <paramlist>
+ <param name="c" type="Colour" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_GetDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>base_GetDefaultAttributes(self) -> VisualAttributes</autodoc>
+ </method>
+ </class>
+ <class name="PyScrolledWindow" oldname="wxPyScrolledWindow" module="_windows">
+ <baseclass name="ScrolledWindow"/>
+ <constructor name="PyScrolledWindow" overloaded="no">
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, String name=PanelNameStr) -> PyScrolledWindow</autodoc>
+ <paramlist>
+ <param name="parent" type="Window" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="pos" type="Point" default="wxDefaultPosition"/>
+ <param name="size" type="Size" default="wxDefaultSize"/>
+ <param name="style" type="long" default="0"/>
+ <param name="name" type="String" default="wxPyPanelNameStr"/>
+ </paramlist>
+ </constructor>
+ <constructor name="PrePyScrolledWindow" overloaded="no">
+ <autodoc>PrePyScrolledWindow() -> PyScrolledWindow</autodoc>
+ </constructor>
+ <method name="_setCallbackInfo" type="" overloaded="no">
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
+ <paramlist>
+ <param name="self" type="PyObject" default=""/>
+ <param name="_class" type="PyObject" default=""/>
+ </paramlist>
+ </method>
+ <method name="SetBestSize" type="" overloaded="no">
+ <autodoc>SetBestSize(self, Size size)</autodoc>
+ <paramlist>
+ <param name="size" type="Size" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_DoMoveWindow" type="" overloaded="no">
+ <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)</autodoc>
+ <paramlist>
+ <param name="x" type="int" default=""/>
+ <param name="y" type="int" default=""/>
+ <param name="width" type="int" default=""/>
+ <param name="height" type="int" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_DoSetSize" type="" overloaded="no">
+ <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
+ <paramlist>
+ <param name="x" type="int" default=""/>
+ <param name="y" type="int" default=""/>
+ <param name="width" type="int" default=""/>
+ <param name="height" type="int" default=""/>
+ <param name="sizeFlags" type="int" default="wxSIZE_AUTO"/>
+ </paramlist>
+ </method>
+ <method name="base_DoSetClientSize" type="" overloaded="no">
+ <autodoc>base_DoSetClientSize(self, int width, int height)</autodoc>
+ <paramlist>
+ <param name="width" type="int" default=""/>
+ <param name="height" type="int" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_DoSetVirtualSize" type="" overloaded="no">
+ <autodoc>base_DoSetVirtualSize(self, int x, int y)</autodoc>
+ <paramlist>
+ <param name="x" type="int" default=""/>
+ <param name="y" type="int" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_DoGetSize" type="" overloaded="no">
+ <autodoc>base_DoGetSize() -> (width, height)</autodoc>
+ <paramlist>
+ <param name="OUTPUT" type="int" default=""/>
+ <param name="OUTPUT" type="int" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_DoGetClientSize" type="" overloaded="no">
+ <autodoc>base_DoGetClientSize() -> (width, height)</autodoc>
+ <paramlist>
+ <param name="OUTPUT" type="int" default=""/>
+ <param name="OUTPUT" type="int" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_DoGetPosition" type="" overloaded="no">
+ <autodoc>base_DoGetPosition() -> (x,y)</autodoc>
+ <paramlist>
+ <param name="OUTPUT" type="int" default=""/>
+ <param name="OUTPUT" type="int" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_DoGetVirtualSize" type="Size" overloaded="no">
+ <autodoc>base_DoGetVirtualSize(self) -> Size</autodoc>
+ </method>
+ <method name="base_DoGetBestSize" type="Size" overloaded="no">
+ <autodoc>base_DoGetBestSize(self) -> Size</autodoc>
+ </method>
+ <method name="base_InitDialog" type="" overloaded="no">
+ <autodoc>base_InitDialog(self)</autodoc>
+ </method>
+ <method name="base_TransferDataToWindow" type="bool" overloaded="no">
+ <autodoc>base_TransferDataToWindow(self) -> bool</autodoc>
+ </method>
+ <method name="base_TransferDataFromWindow" type="bool" overloaded="no">
+ <autodoc>base_TransferDataFromWindow(self) -> bool</autodoc>
+ </method>
+ <method name="base_Validate" type="bool" overloaded="no">
+ <autodoc>base_Validate(self) -> bool</autodoc>
+ </method>
+ <method name="base_AcceptsFocus" type="bool" overloaded="no">
+ <autodoc>base_AcceptsFocus(self) -> bool</autodoc>
+ </method>
+ <method name="base_AcceptsFocusFromKeyboard" type="bool" overloaded="no">
+ <autodoc>base_AcceptsFocusFromKeyboard(self) -> bool</autodoc>
+ </method>
+ <method name="base_GetMaxSize" type="Size" overloaded="no">
+ <autodoc>base_GetMaxSize(self) -> Size</autodoc>
+ </method>
+ <method name="base_AddChild" type="" overloaded="no">
+ <autodoc>base_AddChild(self, Window child)</autodoc>
+ <paramlist>
+ <param name="child" type="Window" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_RemoveChild" type="" overloaded="no">
+ <autodoc>base_RemoveChild(self, Window child)</autodoc>
+ <paramlist>
+ <param name="child" type="Window" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_ShouldInheritColours" type="bool" overloaded="no">
+ <autodoc>base_ShouldInheritColours(self) -> bool</autodoc>
+ </method>
+ <method name="base_ApplyParentThemeBackground" type="" overloaded="no">
+ <autodoc>base_ApplyParentThemeBackground(self, Colour c)</autodoc>
+ <paramlist>
+ <param name="c" type="Colour" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_GetDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>base_GetDefaultAttributes(self) -> VisualAttributes</autodoc>
+ </method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PrintData" oldname="wxPrintData" module="windows">
+ <class name="PrintData" oldname="wxPrintData" module="_windows">
<baseclass name="Object"/>
- <constructor name="PrintData" overloaded="no">
- <autodoc>__init__() -> PrintData</autodoc>
+ <constructor name="PrintData" overloaded="yes"/>
+ <constructor name="PrintData" overloaded="yes">
+ <autodoc>__init__(self) -> PrintData
+__init__(self, PrintData data) -> PrintData</autodoc>
+ <paramlist>
+ <param name="data" type="PrintData" default=""/>
+ </paramlist>
</constructor>
<destructor name="~wxPrintData" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetNoCopies" type="int" overloaded="no">
- <autodoc>GetNoCopies() -> int</autodoc>
+ <autodoc>GetNoCopies(self) -> int</autodoc>
</method>
<method name="GetCollate" type="bool" overloaded="no">
- <autodoc>GetCollate() -> bool</autodoc>
+ <autodoc>GetCollate(self) -> bool</autodoc>
</method>
<method name="GetOrientation" type="int" overloaded="no">
- <autodoc>GetOrientation() -> int</autodoc>
+ <autodoc>GetOrientation(self) -> int</autodoc>
</method>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
<method name="GetPrinterName" type="String" overloaded="no">
- <autodoc>GetPrinterName() -> String</autodoc>
+ <autodoc>GetPrinterName(self) -> String</autodoc>
</method>
<method name="GetColour" type="bool" overloaded="no">
- <autodoc>GetColour() -> bool</autodoc>
+ <autodoc>GetColour(self) -> bool</autodoc>
</method>
<method name="GetDuplex" type="wxDuplexMode" overloaded="no">
- <autodoc>GetDuplex() -> int</autodoc>
+ <autodoc>GetDuplex(self) -> int</autodoc>
</method>
<method name="GetPaperId" type="wxPaperSize" overloaded="no">
- <autodoc>GetPaperId() -> int</autodoc>
+ <autodoc>GetPaperId(self) -> int</autodoc>
</method>
<method name="GetPaperSize" type="Size" overloaded="no">
- <autodoc>GetPaperSize() -> Size</autodoc>
+ <autodoc>GetPaperSize(self) -> Size</autodoc>
</method>
<method name="GetQuality" type="int" overloaded="no">
- <autodoc>GetQuality() -> int</autodoc>
+ <autodoc>GetQuality(self) -> int</autodoc>
</method>
<method name="SetNoCopies" type="" overloaded="no">
- <autodoc>SetNoCopies(int v)</autodoc>
+ <autodoc>SetNoCopies(self, int v)</autodoc>
<paramlist>
<param name="v" type="int" default=""/>
</paramlist>
</method>
<method name="SetCollate" type="" overloaded="no">
- <autodoc>SetCollate(bool flag)</autodoc>
+ <autodoc>SetCollate(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="SetOrientation" type="" overloaded="no">
- <autodoc>SetOrientation(int orient)</autodoc>
+ <autodoc>SetOrientation(self, int orient)</autodoc>
<paramlist>
<param name="orient" type="int" default=""/>
</paramlist>
</method>
<method name="SetPrinterName" type="" overloaded="no">
- <autodoc>SetPrinterName(String name)</autodoc>
+ <autodoc>SetPrinterName(self, String name)</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="SetColour" type="" overloaded="no">
- <autodoc>SetColour(bool colour)</autodoc>
+ <autodoc>SetColour(self, bool colour)</autodoc>
<paramlist>
<param name="colour" type="bool" default=""/>
</paramlist>
</method>
<method name="SetDuplex" type="" overloaded="no">
- <autodoc>SetDuplex(int duplex)</autodoc>
+ <autodoc>SetDuplex(self, int duplex)</autodoc>
<paramlist>
<param name="duplex" type="wxDuplexMode" default=""/>
</paramlist>
</method>
<method name="SetPaperId" type="" overloaded="no">
- <autodoc>SetPaperId(int sizeId)</autodoc>
+ <autodoc>SetPaperId(self, int sizeId)</autodoc>
<paramlist>
<param name="sizeId" type="wxPaperSize" default=""/>
</paramlist>
</method>
<method name="SetPaperSize" type="" overloaded="no">
- <autodoc>SetPaperSize(Size sz)</autodoc>
+ <autodoc>SetPaperSize(self, Size sz)</autodoc>
<paramlist>
<param name="sz" type="Size" default=""/>
</paramlist>
</method>
<method name="SetQuality" type="" overloaded="no">
- <autodoc>SetQuality(int quality)</autodoc>
+ <autodoc>SetQuality(self, int quality)</autodoc>
<paramlist>
<param name="quality" type="int" default=""/>
</paramlist>
</method>
<method name="GetPrinterCommand" type="String" overloaded="no">
- <autodoc>GetPrinterCommand() -> String</autodoc>
+ <autodoc>GetPrinterCommand(self) -> String</autodoc>
</method>
<method name="GetPrinterOptions" type="String" overloaded="no">
- <autodoc>GetPrinterOptions() -> String</autodoc>
+ <autodoc>GetPrinterOptions(self) -> String</autodoc>
</method>
<method name="GetPreviewCommand" type="String" overloaded="no">
- <autodoc>GetPreviewCommand() -> String</autodoc>
+ <autodoc>GetPreviewCommand(self) -> String</autodoc>
</method>
<method name="GetFilename" type="String" overloaded="no">
- <autodoc>GetFilename() -> String</autodoc>
+ <autodoc>GetFilename(self) -> String</autodoc>
</method>
<method name="GetFontMetricPath" type="String" overloaded="no">
- <autodoc>GetFontMetricPath() -> String</autodoc>
+ <autodoc>GetFontMetricPath(self) -> String</autodoc>
</method>
<method name="GetPrinterScaleX" type="double" overloaded="no">
- <autodoc>GetPrinterScaleX() -> double</autodoc>
+ <autodoc>GetPrinterScaleX(self) -> double</autodoc>
</method>
<method name="GetPrinterScaleY" type="double" overloaded="no">
- <autodoc>GetPrinterScaleY() -> double</autodoc>
+ <autodoc>GetPrinterScaleY(self) -> double</autodoc>
</method>
<method name="GetPrinterTranslateX" type="long" overloaded="no">
- <autodoc>GetPrinterTranslateX() -> long</autodoc>
+ <autodoc>GetPrinterTranslateX(self) -> long</autodoc>
</method>
<method name="GetPrinterTranslateY" type="long" overloaded="no">
- <autodoc>GetPrinterTranslateY() -> long</autodoc>
+ <autodoc>GetPrinterTranslateY(self) -> long</autodoc>
</method>
<method name="GetPrintMode" type="wxPrintMode" overloaded="no">
- <autodoc>GetPrintMode() -> int</autodoc>
+ <autodoc>GetPrintMode(self) -> int</autodoc>
</method>
<method name="SetPrinterCommand" type="" overloaded="no">
- <autodoc>SetPrinterCommand(String command)</autodoc>
+ <autodoc>SetPrinterCommand(self, String command)</autodoc>
<paramlist>
<param name="command" type="String" default=""/>
</paramlist>
</method>
<method name="SetPrinterOptions" type="" overloaded="no">
- <autodoc>SetPrinterOptions(String options)</autodoc>
+ <autodoc>SetPrinterOptions(self, String options)</autodoc>
<paramlist>
<param name="options" type="String" default=""/>
</paramlist>
</method>
<method name="SetPreviewCommand" type="" overloaded="no">
- <autodoc>SetPreviewCommand(String command)</autodoc>
+ <autodoc>SetPreviewCommand(self, String command)</autodoc>
<paramlist>
<param name="command" type="String" default=""/>
</paramlist>
</method>
<method name="SetFilename" type="" overloaded="no">
- <autodoc>SetFilename(String filename)</autodoc>
+ <autodoc>SetFilename(self, String filename)</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
</paramlist>
</method>
<method name="SetFontMetricPath" type="" overloaded="no">
- <autodoc>SetFontMetricPath(String path)</autodoc>
+ <autodoc>SetFontMetricPath(self, String path)</autodoc>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="SetPrinterScaleX" type="" overloaded="no">
- <autodoc>SetPrinterScaleX(double x)</autodoc>
+ <autodoc>SetPrinterScaleX(self, double x)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="SetPrinterScaleY" type="" overloaded="no">
- <autodoc>SetPrinterScaleY(double y)</autodoc>
+ <autodoc>SetPrinterScaleY(self, double y)</autodoc>
<paramlist>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="SetPrinterScaling" type="" overloaded="no">
- <autodoc>SetPrinterScaling(double x, double y)</autodoc>
+ <autodoc>SetPrinterScaling(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="SetPrinterTranslateX" type="" overloaded="no">
- <autodoc>SetPrinterTranslateX(long x)</autodoc>
+ <autodoc>SetPrinterTranslateX(self, long x)</autodoc>
<paramlist>
<param name="x" type="long" default=""/>
</paramlist>
</method>
<method name="SetPrinterTranslateY" type="" overloaded="no">
- <autodoc>SetPrinterTranslateY(long y)</autodoc>
+ <autodoc>SetPrinterTranslateY(self, long y)</autodoc>
<paramlist>
<param name="y" type="long" default=""/>
</paramlist>
</method>
<method name="SetPrinterTranslation" type="" overloaded="no">
- <autodoc>SetPrinterTranslation(long x, long y)</autodoc>
+ <autodoc>SetPrinterTranslation(self, long x, long y)</autodoc>
<paramlist>
<param name="x" type="long" default=""/>
<param name="y" type="long" default=""/>
</paramlist>
</method>
<method name="SetPrintMode" type="" overloaded="no">
- <autodoc>SetPrintMode(int printMode)</autodoc>
+ <autodoc>SetPrintMode(self, int printMode)</autodoc>
<paramlist>
<param name="printMode" type="wxPrintMode" default=""/>
</paramlist>
</method>
<method name="GetOutputStream" type="OutputStream" overloaded="no">
- <autodoc>GetOutputStream() -> OutputStream</autodoc>
+ <autodoc>GetOutputStream(self) -> OutputStream</autodoc>
</method>
<method name="SetOutputStream" type="" overloaded="no">
- <autodoc>SetOutputStream(OutputStream outputstream)</autodoc>
+ <autodoc>SetOutputStream(self, OutputStream outputstream)</autodoc>
<paramlist>
<param name="outputstream" type="OutputStream" default=""/>
</paramlist>
</method>
</class>
- <class name="PageSetupDialogData" oldname="wxPageSetupDialogData" module="windows">
+ <class name="PageSetupDialogData" oldname="wxPageSetupDialogData" module="_windows">
<baseclass name="Object"/>
- <constructor name="PageSetupDialogData" overloaded="no">
- <autodoc>__init__() -> PageSetupDialogData</autodoc>
+ <constructor name="PageSetupDialogData" overloaded="yes"/>
+ <constructor name="PageSetupDialogData" overloaded="yes">
+ <autodoc>__init__(self) -> PageSetupDialogData
+__init__(self, PageSetupDialogData data) -> PageSetupDialogData</autodoc>
+ <paramlist>
+ <param name="data" type="PageSetupDialogData" default=""/>
+ </paramlist>
</constructor>
<destructor name="~wxPageSetupDialogData" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="EnableHelp" type="" overloaded="no">
- <autodoc>EnableHelp(bool flag)</autodoc>
+ <autodoc>EnableHelp(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="EnableMargins" type="" overloaded="no">
- <autodoc>EnableMargins(bool flag)</autodoc>
+ <autodoc>EnableMargins(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="EnableOrientation" type="" overloaded="no">
- <autodoc>EnableOrientation(bool flag)</autodoc>
+ <autodoc>EnableOrientation(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="EnablePaper" type="" overloaded="no">
- <autodoc>EnablePaper(bool flag)</autodoc>
+ <autodoc>EnablePaper(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="EnablePrinter" type="" overloaded="no">
- <autodoc>EnablePrinter(bool flag)</autodoc>
+ <autodoc>EnablePrinter(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="GetDefaultMinMargins" type="bool" overloaded="no">
- <autodoc>GetDefaultMinMargins() -> bool</autodoc>
+ <autodoc>GetDefaultMinMargins(self) -> bool</autodoc>
</method>
<method name="GetEnableMargins" type="bool" overloaded="no">
- <autodoc>GetEnableMargins() -> bool</autodoc>
+ <autodoc>GetEnableMargins(self) -> bool</autodoc>
</method>
<method name="GetEnableOrientation" type="bool" overloaded="no">
- <autodoc>GetEnableOrientation() -> bool</autodoc>
+ <autodoc>GetEnableOrientation(self) -> bool</autodoc>
</method>
<method name="GetEnablePaper" type="bool" overloaded="no">
- <autodoc>GetEnablePaper() -> bool</autodoc>
+ <autodoc>GetEnablePaper(self) -> bool</autodoc>
</method>
<method name="GetEnablePrinter" type="bool" overloaded="no">
- <autodoc>GetEnablePrinter() -> bool</autodoc>
+ <autodoc>GetEnablePrinter(self) -> bool</autodoc>
</method>
<method name="GetEnableHelp" type="bool" overloaded="no">
- <autodoc>GetEnableHelp() -> bool</autodoc>
+ <autodoc>GetEnableHelp(self) -> bool</autodoc>
</method>
<method name="GetDefaultInfo" type="bool" overloaded="no">
- <autodoc>GetDefaultInfo() -> bool</autodoc>
+ <autodoc>GetDefaultInfo(self) -> bool</autodoc>
</method>
<method name="GetMarginTopLeft" type="Point" overloaded="no">
- <autodoc>GetMarginTopLeft() -> Point</autodoc>
+ <autodoc>GetMarginTopLeft(self) -> Point</autodoc>
</method>
<method name="GetMarginBottomRight" type="Point" overloaded="no">
- <autodoc>GetMarginBottomRight() -> Point</autodoc>
+ <autodoc>GetMarginBottomRight(self) -> Point</autodoc>
</method>
<method name="GetMinMarginTopLeft" type="Point" overloaded="no">
- <autodoc>GetMinMarginTopLeft() -> Point</autodoc>
+ <autodoc>GetMinMarginTopLeft(self) -> Point</autodoc>
</method>
<method name="GetMinMarginBottomRight" type="Point" overloaded="no">
- <autodoc>GetMinMarginBottomRight() -> Point</autodoc>
+ <autodoc>GetMinMarginBottomRight(self) -> Point</autodoc>
</method>
<method name="GetPaperId" type="wxPaperSize" overloaded="no">
- <autodoc>GetPaperId() -> int</autodoc>
+ <autodoc>GetPaperId(self) -> int</autodoc>
</method>
<method name="GetPaperSize" type="Size" overloaded="no">
- <autodoc>GetPaperSize() -> Size</autodoc>
+ <autodoc>GetPaperSize(self) -> Size</autodoc>
</method>
<method name="GetPrintData" type="PrintData" overloaded="no">
- <autodoc>GetPrintData() -> PrintData</autodoc>
+ <autodoc>GetPrintData(self) -> PrintData</autodoc>
</method>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
<method name="SetDefaultInfo" type="" overloaded="no">
- <autodoc>SetDefaultInfo(bool flag)</autodoc>
+ <autodoc>SetDefaultInfo(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="SetDefaultMinMargins" type="" overloaded="no">
- <autodoc>SetDefaultMinMargins(bool flag)</autodoc>
+ <autodoc>SetDefaultMinMargins(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="SetMarginTopLeft" type="" overloaded="no">
- <autodoc>SetMarginTopLeft(Point pt)</autodoc>
+ <autodoc>SetMarginTopLeft(self, Point pt)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="SetMarginBottomRight" type="" overloaded="no">
- <autodoc>SetMarginBottomRight(Point pt)</autodoc>
+ <autodoc>SetMarginBottomRight(self, Point pt)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="SetMinMarginTopLeft" type="" overloaded="no">
- <autodoc>SetMinMarginTopLeft(Point pt)</autodoc>
+ <autodoc>SetMinMarginTopLeft(self, Point pt)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="SetMinMarginBottomRight" type="" overloaded="no">
- <autodoc>SetMinMarginBottomRight(Point pt)</autodoc>
+ <autodoc>SetMinMarginBottomRight(self, Point pt)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="SetPaperId" type="" overloaded="no">
- <autodoc>SetPaperId(int id)</autodoc>
+ <autodoc>SetPaperId(self, int id)</autodoc>
<paramlist>
<param name="id" type="wxPaperSize" default=""/>
</paramlist>
</method>
<method name="SetPaperSize" type="" overloaded="no">
- <autodoc>SetPaperSize(Size size)</autodoc>
+ <autodoc>SetPaperSize(self, Size size)</autodoc>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="SetPrintData" type="" overloaded="no">
- <autodoc>SetPrintData(PrintData printData)</autodoc>
+ <autodoc>SetPrintData(self, PrintData printData)</autodoc>
<paramlist>
<param name="printData" type="PrintData" default=""/>
</paramlist>
</method>
</class>
- <class name="PageSetupDialog" oldname="wxPageSetupDialog" module="windows">
+ <class name="PageSetupDialog" oldname="wxPageSetupDialog" module="_windows">
<baseclass name="Dialog"/>
<constructor name="PageSetupDialog" overloaded="no">
- <autodoc>__init__(Window parent, PageSetupDialogData data=None) -> PageSetupDialog</autodoc>
+ <autodoc>__init__(self, Window parent, PageSetupDialogData data=None) -> PageSetupDialog</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="data" type="PageSetupDialogData" default="NULL"/>
</paramlist>
</constructor>
<method name="GetPageSetupData" type="PageSetupDialogData" overloaded="no">
- <autodoc>GetPageSetupData() -> PageSetupDialogData</autodoc>
+ <autodoc>GetPageSetupData(self) -> PageSetupDialogData</autodoc>
</method>
<method name="ShowModal" type="int" overloaded="no">
- <autodoc>ShowModal() -> int</autodoc>
+ <autodoc>ShowModal(self) -> int</autodoc>
</method>
</class>
- <class name="PrintDialogData" oldname="wxPrintDialogData" module="windows">
+ <class name="PrintDialogData" oldname="wxPrintDialogData" module="_windows">
<baseclass name="Object"/>
<constructor name="PrintDialogData" overloaded="yes"/>
<constructor name="PrintDialogData" overloaded="yes">
- <autodoc>__init__() -> PrintDialogData
-__init__(PrintData printData) -> PrintDialogData</autodoc>
+ <autodoc>__init__(self) -> PrintDialogData
+__init__(self, PrintData printData) -> PrintDialogData</autodoc>
<paramlist>
<param name="printData" type="PrintData" default=""/>
</paramlist>
</constructor>
<destructor name="~wxPrintDialogData" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetFromPage" type="int" overloaded="no">
- <autodoc>GetFromPage() -> int</autodoc>
+ <autodoc>GetFromPage(self) -> int</autodoc>
</method>
<method name="GetToPage" type="int" overloaded="no">
- <autodoc>GetToPage() -> int</autodoc>
+ <autodoc>GetToPage(self) -> int</autodoc>
</method>
<method name="GetMinPage" type="int" overloaded="no">
- <autodoc>GetMinPage() -> int</autodoc>
+ <autodoc>GetMinPage(self) -> int</autodoc>
</method>
<method name="GetMaxPage" type="int" overloaded="no">
- <autodoc>GetMaxPage() -> int</autodoc>
+ <autodoc>GetMaxPage(self) -> int</autodoc>
</method>
<method name="GetNoCopies" type="int" overloaded="no">
- <autodoc>GetNoCopies() -> int</autodoc>
+ <autodoc>GetNoCopies(self) -> int</autodoc>
</method>
<method name="GetAllPages" type="bool" overloaded="no">
- <autodoc>GetAllPages() -> bool</autodoc>
+ <autodoc>GetAllPages(self) -> bool</autodoc>
</method>
<method name="GetSelection" type="bool" overloaded="no">
- <autodoc>GetSelection() -> bool</autodoc>
+ <autodoc>GetSelection(self) -> bool</autodoc>
</method>
<method name="GetCollate" type="bool" overloaded="no">
- <autodoc>GetCollate() -> bool</autodoc>
+ <autodoc>GetCollate(self) -> bool</autodoc>
</method>
<method name="GetPrintToFile" type="bool" overloaded="no">
- <autodoc>GetPrintToFile() -> bool</autodoc>
+ <autodoc>GetPrintToFile(self) -> bool</autodoc>
</method>
<method name="GetSetupDialog" type="bool" overloaded="no">
- <autodoc>GetSetupDialog() -> bool</autodoc>
+ <autodoc>GetSetupDialog(self) -> bool</autodoc>
</method>
<method name="SetFromPage" type="" overloaded="no">
- <autodoc>SetFromPage(int v)</autodoc>
+ <autodoc>SetFromPage(self, int v)</autodoc>
<paramlist>
<param name="v" type="int" default=""/>
</paramlist>
</method>
<method name="SetToPage" type="" overloaded="no">
- <autodoc>SetToPage(int v)</autodoc>
+ <autodoc>SetToPage(self, int v)</autodoc>
<paramlist>
<param name="v" type="int" default=""/>
</paramlist>
</method>
<method name="SetMinPage" type="" overloaded="no">
- <autodoc>SetMinPage(int v)</autodoc>
+ <autodoc>SetMinPage(self, int v)</autodoc>
<paramlist>
<param name="v" type="int" default=""/>
</paramlist>
</method>
<method name="SetMaxPage" type="" overloaded="no">
- <autodoc>SetMaxPage(int v)</autodoc>
+ <autodoc>SetMaxPage(self, int v)</autodoc>
<paramlist>
<param name="v" type="int" default=""/>
</paramlist>
</method>
<method name="SetNoCopies" type="" overloaded="no">
- <autodoc>SetNoCopies(int v)</autodoc>
+ <autodoc>SetNoCopies(self, int v)</autodoc>
<paramlist>
<param name="v" type="int" default=""/>
</paramlist>
</method>
<method name="SetAllPages" type="" overloaded="no">
- <autodoc>SetAllPages(bool flag)</autodoc>
+ <autodoc>SetAllPages(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(bool flag)</autodoc>
+ <autodoc>SetSelection(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="SetCollate" type="" overloaded="no">
- <autodoc>SetCollate(bool flag)</autodoc>
+ <autodoc>SetCollate(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="SetPrintToFile" type="" overloaded="no">
- <autodoc>SetPrintToFile(bool flag)</autodoc>
+ <autodoc>SetPrintToFile(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="SetSetupDialog" type="" overloaded="no">
- <autodoc>SetSetupDialog(bool flag)</autodoc>
+ <autodoc>SetSetupDialog(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="EnablePrintToFile" type="" overloaded="no">
- <autodoc>EnablePrintToFile(bool flag)</autodoc>
+ <autodoc>EnablePrintToFile(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="EnableSelection" type="" overloaded="no">
- <autodoc>EnableSelection(bool flag)</autodoc>
+ <autodoc>EnableSelection(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="EnablePageNumbers" type="" overloaded="no">
- <autodoc>EnablePageNumbers(bool flag)</autodoc>
+ <autodoc>EnablePageNumbers(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="EnableHelp" type="" overloaded="no">
- <autodoc>EnableHelp(bool flag)</autodoc>
+ <autodoc>EnableHelp(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="GetEnablePrintToFile" type="bool" overloaded="no">
- <autodoc>GetEnablePrintToFile() -> bool</autodoc>
+ <autodoc>GetEnablePrintToFile(self) -> bool</autodoc>
</method>
<method name="GetEnableSelection" type="bool" overloaded="no">
- <autodoc>GetEnableSelection() -> bool</autodoc>
+ <autodoc>GetEnableSelection(self) -> bool</autodoc>
</method>
<method name="GetEnablePageNumbers" type="bool" overloaded="no">
- <autodoc>GetEnablePageNumbers() -> bool</autodoc>
+ <autodoc>GetEnablePageNumbers(self) -> bool</autodoc>
</method>
<method name="GetEnableHelp" type="bool" overloaded="no">
- <autodoc>GetEnableHelp() -> bool</autodoc>
+ <autodoc>GetEnableHelp(self) -> bool</autodoc>
</method>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
<method name="GetPrintData" type="PrintData" overloaded="no">
- <autodoc>GetPrintData() -> PrintData</autodoc>
+ <autodoc>GetPrintData(self) -> PrintData</autodoc>
</method>
<method name="SetPrintData" type="" overloaded="no">
- <autodoc>SetPrintData(PrintData printData)</autodoc>
+ <autodoc>SetPrintData(self, PrintData printData)</autodoc>
<paramlist>
<param name="printData" type="PrintData" default=""/>
</paramlist>
</method>
</class>
- <class name="PrintDialog" oldname="wxPrintDialog" module="windows">
+ <class name="PrintDialog" oldname="wxPrintDialog" module="_windows">
<baseclass name="Dialog"/>
<constructor name="PrintDialog" overloaded="no">
- <autodoc>__init__(Window parent, PrintDialogData data=None) -> PrintDialog</autodoc>
+ <autodoc>__init__(self, Window parent, PrintDialogData data=None) -> PrintDialog</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="data" type="PrintDialogData" default="NULL"/>
</paramlist>
</constructor>
<method name="GetPrintDialogData" type="PrintDialogData" overloaded="no">
- <autodoc>GetPrintDialogData() -> PrintDialogData</autodoc>
+ <autodoc>GetPrintDialogData(self) -> PrintDialogData</autodoc>
</method>
<method name="GetPrintDC" type="DC" overloaded="no">
- <autodoc>GetPrintDC() -> DC</autodoc>
+ <autodoc>GetPrintDC(self) -> DC</autodoc>
</method>
<method name="ShowModal" type="int" overloaded="no">
- <autodoc>ShowModal() -> int</autodoc>
+ <autodoc>ShowModal(self) -> int</autodoc>
</method>
</class>
- <class name="Printer" oldname="wxPrinter" module="windows">
+ <class name="Printer" oldname="wxPrinter" module="_windows">
<baseclass name="Object"/>
<constructor name="Printer" overloaded="no">
- <autodoc>__init__(PrintDialogData data=None) -> Printer</autodoc>
+ <autodoc>__init__(self, PrintDialogData data=None) -> Printer</autodoc>
<paramlist>
<param name="data" type="PrintDialogData" default="NULL"/>
</paramlist>
</constructor>
<destructor name="~wxPrinter" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="CreateAbortWindow" type="" overloaded="no">
- <autodoc>CreateAbortWindow(Window parent, Printout printout)</autodoc>
+ <autodoc>CreateAbortWindow(self, Window parent, Printout printout)</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="printout" type="wxPyPrintout" default=""/>
</paramlist>
</method>
<method name="GetPrintDialogData" type="PrintDialogData" overloaded="no">
- <autodoc>GetPrintDialogData() -> PrintDialogData</autodoc>
+ <autodoc>GetPrintDialogData(self) -> PrintDialogData</autodoc>
</method>
<method name="Print" type="bool" overloaded="no">
- <autodoc>Print(Window parent, Printout printout, int prompt=True) -> bool</autodoc>
+ <autodoc>Print(self, Window parent, Printout printout, int prompt=True) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="printout" type="wxPyPrintout" default=""/>
</paramlist>
</method>
<method name="PrintDialog" type="DC" overloaded="no">
- <autodoc>PrintDialog(Window parent) -> DC</autodoc>
+ <autodoc>PrintDialog(self, Window parent) -> DC</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="ReportError" type="" overloaded="no">
- <autodoc>ReportError(Window parent, Printout printout, String message)</autodoc>
+ <autodoc>ReportError(self, Window parent, Printout printout, String message)</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="printout" type="wxPyPrintout" default=""/>
</paramlist>
</method>
<method name="Setup" type="bool" overloaded="no">
- <autodoc>Setup(Window parent) -> bool</autodoc>
+ <autodoc>Setup(self, Window parent) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="GetAbort" type="bool" overloaded="no">
- <autodoc>GetAbort() -> bool</autodoc>
+ <autodoc>GetAbort(self) -> bool</autodoc>
</method>
<staticmethod name="GetLastError" type="wxPrinterError" overloaded="no">
<autodoc>GetLastError() -> int</autodoc>
</staticmethod>
</class>
- <class name="Printout" oldname="wxPyPrintout" module="windows">
+ <class name="Printout" oldname="wxPyPrintout" module="_windows">
<baseclass name="Object"/>
<constructor name="wxPyPrintout" overloaded="no">
- <autodoc>__init__(String title=PrintoutTitleStr) -> Printout</autodoc>
+ <autodoc>__init__(self, String title=PrintoutTitleStr) -> Printout</autodoc>
<paramlist>
<param name="title" type="String" default="wxPyPrintoutTitleStr"/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetTitle" type="String" overloaded="no">
- <autodoc>GetTitle() -> String</autodoc>
+ <autodoc>GetTitle(self) -> String</autodoc>
</method>
<method name="GetDC" type="DC" overloaded="no">
- <autodoc>GetDC() -> DC</autodoc>
+ <autodoc>GetDC(self) -> DC</autodoc>
</method>
<method name="SetDC" type="" overloaded="no">
- <autodoc>SetDC(DC dc)</autodoc>
+ <autodoc>SetDC(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="SetPageSizePixels" type="" overloaded="no">
- <autodoc>SetPageSizePixels(int w, int h)</autodoc>
+ <autodoc>SetPageSizePixels(self, int w, int h)</autodoc>
<paramlist>
<param name="w" type="int" default=""/>
<param name="h" type="int" default=""/>
</paramlist>
</method>
<method name="SetPageSizeMM" type="" overloaded="no">
- <autodoc>SetPageSizeMM(int w, int h)</autodoc>
+ <autodoc>SetPageSizeMM(self, int w, int h)</autodoc>
<paramlist>
<param name="w" type="int" default=""/>
<param name="h" type="int" default=""/>
</paramlist>
</method>
<method name="SetPPIScreen" type="" overloaded="no">
- <autodoc>SetPPIScreen(int x, int y)</autodoc>
+ <autodoc>SetPPIScreen(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="SetPPIPrinter" type="" overloaded="no">
- <autodoc>SetPPIPrinter(int x, int y)</autodoc>
+ <autodoc>SetPPIPrinter(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="IsPreview" type="bool" overloaded="no">
- <autodoc>IsPreview() -> bool</autodoc>
+ <autodoc>IsPreview(self) -> bool</autodoc>
</method>
<method name="SetIsPreview" type="" overloaded="no">
- <autodoc>SetIsPreview(bool p)</autodoc>
+ <autodoc>SetIsPreview(self, bool p)</autodoc>
<paramlist>
<param name="p" type="bool" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDocument" type="bool" overloaded="no">
- <autodoc>base_OnBeginDocument(int startPage, int endPage) -> bool</autodoc>
+ <autodoc>base_OnBeginDocument(self, int startPage, int endPage) -> bool</autodoc>
<paramlist>
<param name="startPage" type="int" default=""/>
<param name="endPage" type="int" default=""/>
</paramlist>
</method>
<method name="base_OnEndDocument" type="" overloaded="no">
- <autodoc>base_OnEndDocument()</autodoc>
+ <autodoc>base_OnEndDocument(self)</autodoc>
</method>
<method name="base_OnBeginPrinting" type="" overloaded="no">
- <autodoc>base_OnBeginPrinting()</autodoc>
+ <autodoc>base_OnBeginPrinting(self)</autodoc>
</method>
<method name="base_OnEndPrinting" type="" overloaded="no">
- <autodoc>base_OnEndPrinting()</autodoc>
+ <autodoc>base_OnEndPrinting(self)</autodoc>
</method>
<method name="base_OnPreparePrinting" type="" overloaded="no">
- <autodoc>base_OnPreparePrinting()</autodoc>
+ <autodoc>base_OnPreparePrinting(self)</autodoc>
</method>
<method name="base_HasPage" type="bool" overloaded="no">
- <autodoc>base_HasPage(int page) -> bool</autodoc>
+ <autodoc>base_HasPage(self, int page) -> bool</autodoc>
<paramlist>
<param name="page" type="int" default=""/>
</paramlist>
</paramlist>
</method>
</class>
- <class name="PreviewCanvas" oldname="wxPreviewCanvas" module="windows">
+ <class name="PreviewCanvas" oldname="wxPreviewCanvas" module="_windows">
<baseclass name="ScrolledWindow"/>
<constructor name="PreviewCanvas" overloaded="no">
- <autodoc>__init__(PrintPreview preview, Window parent, Point pos=DefaultPosition,
+ <autodoc>__init__(self, PrintPreview preview, Window parent, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0,
String name=PreviewCanvasNameStr) -> PreviewCanvas</autodoc>
<paramlist>
</paramlist>
</constructor>
</class>
- <class name="PreviewFrame" oldname="wxPreviewFrame" module="windows">
+ <class name="PreviewFrame" oldname="wxPreviewFrame" module="_windows">
<baseclass name="Frame"/>
<constructor name="PreviewFrame" overloaded="no">
- <autodoc>__init__(PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition,
+ <autodoc>__init__(self, PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition,
Size size=DefaultSize,
long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PreviewFrame</autodoc>
<paramlist>
</paramlist>
</constructor>
<method name="Initialize" type="" overloaded="no">
- <autodoc>Initialize()</autodoc>
+ <autodoc>Initialize(self)</autodoc>
</method>
<method name="CreateControlBar" type="" overloaded="no">
- <autodoc>CreateControlBar()</autodoc>
+ <autodoc>CreateControlBar(self)</autodoc>
</method>
<method name="CreateCanvas" type="" overloaded="no">
- <autodoc>CreateCanvas()</autodoc>
+ <autodoc>CreateCanvas(self)</autodoc>
</method>
<method name="GetControlBar" type="wxPreviewControlBar" overloaded="no">
- <autodoc>GetControlBar() -> PreviewControlBar</autodoc>
+ <autodoc>GetControlBar(self) -> PreviewControlBar</autodoc>
</method>
</class>
- <class name="PreviewControlBar" oldname="wxPreviewControlBar" module="windows">
+ <class name="PreviewControlBar" oldname="wxPreviewControlBar" module="_windows">
<baseclass name="Panel"/>
<constructor name="PreviewControlBar" overloaded="no">
- <autodoc>__init__(PrintPreview preview, long buttons, Window parent,
+ <autodoc>__init__(self, PrintPreview preview, long buttons, Window parent,
Point pos=DefaultPosition, Size size=DefaultSize,
long style=TAB_TRAVERSAL, String name=PanelNameStr) -> PreviewControlBar</autodoc>
<paramlist>
</paramlist>
</constructor>
<method name="GetZoomControl" type="int" overloaded="no">
- <autodoc>GetZoomControl() -> int</autodoc>
+ <autodoc>GetZoomControl(self) -> int</autodoc>
</method>
<method name="SetZoomControl" type="" overloaded="no">
- <autodoc>SetZoomControl(int zoom)</autodoc>
+ <autodoc>SetZoomControl(self, int zoom)</autodoc>
<paramlist>
<param name="zoom" type="int" default=""/>
</paramlist>
</method>
<method name="GetPrintPreview" type="wxPrintPreview" overloaded="no">
- <autodoc>GetPrintPreview() -> PrintPreview</autodoc>
+ <autodoc>GetPrintPreview(self) -> PrintPreview</autodoc>
</method>
<method name="OnNext" type="" overloaded="no">
- <autodoc>OnNext()</autodoc>
+ <autodoc>OnNext(self)</autodoc>
</method>
<method name="OnPrevious" type="" overloaded="no">
- <autodoc>OnPrevious()</autodoc>
+ <autodoc>OnPrevious(self)</autodoc>
</method>
<method name="OnFirst" type="" overloaded="no">
- <autodoc>OnFirst()</autodoc>
+ <autodoc>OnFirst(self)</autodoc>
</method>
<method name="OnLast" type="" overloaded="no">
- <autodoc>OnLast()</autodoc>
+ <autodoc>OnLast(self)</autodoc>
</method>
<method name="OnGoto" type="" overloaded="no">
- <autodoc>OnGoto()</autodoc>
+ <autodoc>OnGoto(self)</autodoc>
</method>
</class>
- <class name="PrintPreview" oldname="wxPrintPreview" module="windows">
+ <class name="PrintPreview" oldname="wxPrintPreview" module="_windows">
<baseclass name="Object"/>
<constructor name="PrintPreview" overloaded="yes">
<paramlist>
</paramlist>
</constructor>
<constructor name="PrintPreview" overloaded="yes">
- <autodoc>__init__(Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PrintPreview
-__init__(Printout printout, Printout printoutForPrinting, PrintData data) -> PrintPreview</autodoc>
+ <autodoc>__init__(self, Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PrintPreview
+__init__(self, Printout printout, Printout printoutForPrinting, PrintData data) -> PrintPreview</autodoc>
<paramlist>
<param name="printout" type="Printout" default=""/>
<param name="printoutForPrinting" type="Printout" default=""/>
</paramlist>
</constructor>
<method name="SetCurrentPage" type="bool" overloaded="no">
- <autodoc>SetCurrentPage(int pageNum) -> bool</autodoc>
+ <autodoc>SetCurrentPage(self, int pageNum) -> bool</autodoc>
<paramlist>
<param name="pageNum" type="int" default=""/>
</paramlist>
</method>
<method name="GetCurrentPage" type="int" overloaded="no">
- <autodoc>GetCurrentPage() -> int</autodoc>
+ <autodoc>GetCurrentPage(self) -> int</autodoc>
</method>
<method name="SetPrintout" type="" overloaded="no">
- <autodoc>SetPrintout(Printout printout)</autodoc>
+ <autodoc>SetPrintout(self, Printout printout)</autodoc>
<paramlist>
<param name="printout" type="Printout" default=""/>
</paramlist>
</method>
<method name="GetPrintout" type="Printout" overloaded="no">
- <autodoc>GetPrintout() -> Printout</autodoc>
+ <autodoc>GetPrintout(self) -> Printout</autodoc>
</method>
<method name="GetPrintoutForPrinting" type="Printout" overloaded="no">
- <autodoc>GetPrintoutForPrinting() -> Printout</autodoc>
+ <autodoc>GetPrintoutForPrinting(self) -> Printout</autodoc>
</method>
<method name="SetFrame" type="" overloaded="no">
- <autodoc>SetFrame(Frame frame)</autodoc>
+ <autodoc>SetFrame(self, Frame frame)</autodoc>
<paramlist>
<param name="frame" type="Frame" default=""/>
</paramlist>
</method>
<method name="SetCanvas" type="" overloaded="no">
- <autodoc>SetCanvas(PreviewCanvas canvas)</autodoc>
+ <autodoc>SetCanvas(self, PreviewCanvas canvas)</autodoc>
<paramlist>
<param name="canvas" type="PreviewCanvas" default=""/>
</paramlist>
</method>
<method name="GetFrame" type="Frame" overloaded="no">
- <autodoc>GetFrame() -> Frame</autodoc>
+ <autodoc>GetFrame(self) -> Frame</autodoc>
</method>
<method name="GetCanvas" type="PreviewCanvas" overloaded="no">
- <autodoc>GetCanvas() -> PreviewCanvas</autodoc>
+ <autodoc>GetCanvas(self) -> PreviewCanvas</autodoc>
</method>
<method name="PaintPage" type="bool" overloaded="no">
- <autodoc>PaintPage(PreviewCanvas canvas, DC dc) -> bool</autodoc>
+ <autodoc>PaintPage(self, PreviewCanvas canvas, DC dc) -> bool</autodoc>
<paramlist>
<param name="canvas" type="PreviewCanvas" default=""/>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="DrawBlankPage" type="bool" overloaded="no">
- <autodoc>DrawBlankPage(PreviewCanvas canvas, DC dc) -> bool</autodoc>
+ <autodoc>DrawBlankPage(self, PreviewCanvas canvas, DC dc) -> bool</autodoc>
<paramlist>
<param name="canvas" type="PreviewCanvas" default=""/>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="RenderPage" type="bool" overloaded="no">
- <autodoc>RenderPage(int pageNum) -> bool</autodoc>
+ <autodoc>RenderPage(self, int pageNum) -> bool</autodoc>
<paramlist>
<param name="pageNum" type="int" default=""/>
</paramlist>
</method>
<method name="AdjustScrollbars" type="" overloaded="no">
- <autodoc>AdjustScrollbars(PreviewCanvas canvas)</autodoc>
+ <autodoc>AdjustScrollbars(self, PreviewCanvas canvas)</autodoc>
<paramlist>
<param name="canvas" type="PreviewCanvas" default=""/>
</paramlist>
</method>
<method name="GetPrintDialogData" type="PrintDialogData" overloaded="no">
- <autodoc>GetPrintDialogData() -> PrintDialogData</autodoc>
+ <autodoc>GetPrintDialogData(self) -> PrintDialogData</autodoc>
</method>
<method name="SetZoom" type="" overloaded="no">
- <autodoc>SetZoom(int percent)</autodoc>
+ <autodoc>SetZoom(self, int percent)</autodoc>
<paramlist>
<param name="percent" type="int" default=""/>
</paramlist>
</method>
<method name="GetZoom" type="int" overloaded="no">
- <autodoc>GetZoom() -> int</autodoc>
+ <autodoc>GetZoom(self) -> int</autodoc>
</method>
<method name="GetMaxPage" type="int" overloaded="no">
- <autodoc>GetMaxPage() -> int</autodoc>
+ <autodoc>GetMaxPage(self) -> int</autodoc>
</method>
<method name="GetMinPage" type="int" overloaded="no">
- <autodoc>GetMinPage() -> int</autodoc>
+ <autodoc>GetMinPage(self) -> int</autodoc>
</method>
<method name="Ok" type="bool" overloaded="no">
- <autodoc>Ok() -> bool</autodoc>
+ <autodoc>Ok(self) -> bool</autodoc>
</method>
<method name="SetOk" type="" overloaded="no">
- <autodoc>SetOk(bool ok)</autodoc>
+ <autodoc>SetOk(self, bool ok)</autodoc>
<paramlist>
<param name="ok" type="bool" default=""/>
</paramlist>
</method>
<method name="Print" type="bool" overloaded="no">
- <autodoc>Print(bool interactive) -> bool</autodoc>
+ <autodoc>Print(self, bool interactive) -> bool</autodoc>
<paramlist>
<param name="interactive" type="bool" default=""/>
</paramlist>
</method>
<method name="DetermineScaling" type="" overloaded="no">
- <autodoc>DetermineScaling()</autodoc>
+ <autodoc>DetermineScaling(self)</autodoc>
</method>
</class>
- <class name="PyPrintPreview" oldname="wxPyPrintPreview" module="windows">
+ <class name="PyPrintPreview" oldname="wxPyPrintPreview" module="_windows">
<baseclass name="PrintPreview"/>
<constructor name="PyPrintPreview" overloaded="yes">
<paramlist>
</paramlist>
</constructor>
<constructor name="PyPrintPreview" overloaded="yes">
- <autodoc>__init__(Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PyPrintPreview
-__init__(Printout printout, Printout printoutForPrinting, PrintData data) -> PyPrintPreview</autodoc>
+ <autodoc>__init__(self, Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PyPrintPreview
+__init__(self, Printout printout, Printout printoutForPrinting, PrintData data) -> PyPrintPreview</autodoc>
<paramlist>
<param name="printout" type="Printout" default=""/>
<param name="printoutForPrinting" type="Printout" default=""/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="base_SetCurrentPage" type="bool" overloaded="no">
- <autodoc>base_SetCurrentPage(int pageNum) -> bool</autodoc>
+ <autodoc>base_SetCurrentPage(self, int pageNum) -> bool</autodoc>
<paramlist>
<param name="pageNum" type="int" default=""/>
</paramlist>
</method>
<method name="base_PaintPage" type="bool" overloaded="no">
- <autodoc>base_PaintPage(PreviewCanvas canvas, DC dc) -> bool</autodoc>
+ <autodoc>base_PaintPage(self, PreviewCanvas canvas, DC dc) -> bool</autodoc>
<paramlist>
<param name="canvas" type="PreviewCanvas" default=""/>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_DrawBlankPage" type="bool" overloaded="no">
- <autodoc>base_DrawBlankPage(PreviewCanvas canvas, DC dc) -> bool</autodoc>
+ <autodoc>base_DrawBlankPage(self, PreviewCanvas canvas, DC dc) -> bool</autodoc>
<paramlist>
<param name="canvas" type="PreviewCanvas" default=""/>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_RenderPage" type="bool" overloaded="no">
- <autodoc>base_RenderPage(int pageNum) -> bool</autodoc>
+ <autodoc>base_RenderPage(self, int pageNum) -> bool</autodoc>
<paramlist>
<param name="pageNum" type="int" default=""/>
</paramlist>
</method>
<method name="base_SetZoom" type="" overloaded="no">
- <autodoc>base_SetZoom(int percent)</autodoc>
+ <autodoc>base_SetZoom(self, int percent)</autodoc>
<paramlist>
<param name="percent" type="int" default=""/>
</paramlist>
</method>
<method name="base_Print" type="bool" overloaded="no">
- <autodoc>base_Print(bool interactive) -> bool</autodoc>
+ <autodoc>base_Print(self, bool interactive) -> bool</autodoc>
<paramlist>
<param name="interactive" type="bool" default=""/>
</paramlist>
</method>
<method name="base_DetermineScaling" type="" overloaded="no">
- <autodoc>base_DetermineScaling()</autodoc>
+ <autodoc>base_DetermineScaling(self)</autodoc>
</method>
</class>
- <class name="PyPreviewFrame" oldname="wxPyPreviewFrame" module="windows">
+ <class name="PyPreviewFrame" oldname="wxPyPreviewFrame" module="_windows">
<baseclass name="PreviewFrame"/>
<constructor name="PyPreviewFrame" overloaded="no">
- <autodoc>__init__(PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition,
+ <autodoc>__init__(self, PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition,
Size size=DefaultSize,
long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PyPreviewFrame</autodoc>
<paramlist>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetPreviewCanvas" type="" overloaded="no">
- <autodoc>SetPreviewCanvas(PreviewCanvas canvas)</autodoc>
+ <autodoc>SetPreviewCanvas(self, PreviewCanvas canvas)</autodoc>
<paramlist>
<param name="canvas" type="PreviewCanvas" default=""/>
</paramlist>
</method>
<method name="SetControlBar" type="" overloaded="no">
- <autodoc>SetControlBar(PreviewControlBar bar)</autodoc>
+ <autodoc>SetControlBar(self, PreviewControlBar bar)</autodoc>
<paramlist>
<param name="bar" type="PreviewControlBar" default=""/>
</paramlist>
</method>
<method name="base_Initialize" type="" overloaded="no">
- <autodoc>base_Initialize()</autodoc>
+ <autodoc>base_Initialize(self)</autodoc>
</method>
<method name="base_CreateCanvas" type="" overloaded="no">
- <autodoc>base_CreateCanvas()</autodoc>
+ <autodoc>base_CreateCanvas(self)</autodoc>
</method>
<method name="base_CreateControlBar" type="" overloaded="no">
- <autodoc>base_CreateControlBar()</autodoc>
+ <autodoc>base_CreateControlBar(self)</autodoc>
</method>
</class>
- <class name="PyPreviewControlBar" oldname="wxPyPreviewControlBar" module="windows">
+ <class name="PyPreviewControlBar" oldname="wxPyPreviewControlBar" module="_windows">
<baseclass name="PreviewControlBar"/>
<constructor name="PyPreviewControlBar" overloaded="no">
- <autodoc>__init__(PrintPreview preview, long buttons, Window parent,
+ <autodoc>__init__(self, PrintPreview preview, long buttons, Window parent,
Point pos=DefaultPosition, Size size=DefaultSize,
long style=0, String name=PanelNameStr) -> PyPreviewControlBar</autodoc>
<paramlist>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetPrintPreview" type="" overloaded="no">
- <autodoc>SetPrintPreview(PrintPreview preview)</autodoc>
+ <autodoc>SetPrintPreview(self, PrintPreview preview)</autodoc>
<paramlist>
<param name="preview" type="PrintPreview" default=""/>
</paramlist>
</method>
<method name="base_CreateButtons" type="" overloaded="no">
- <autodoc>base_CreateButtons()</autodoc>
+ <autodoc>base_CreateButtons(self)</autodoc>
</method>
<method name="base_SetZoomControl" type="" overloaded="no">
- <autodoc>base_SetZoomControl(int zoom)</autodoc>
+ <autodoc>base_SetZoomControl(self, int zoom)</autodoc>
<paramlist>
<param name="zoom" type="int" default=""/>
</paramlist>
</method>
</class>
</module>
- <module name="controls">
- <import name="core"/>
- <pythoncode> wx = core </pythoncode>
+ <module name="_controls">
+ <import name="_core"/>
+ <pythoncode> wx = _core </pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Button" oldname="wxButton" module="controls">
+ <class name="Button" oldname="wxButton" module="_controls">
<docstring>A button is a control that contains a text string, and is one of the most
common elements of a GUI. It may be placed on a dialog box or panel, or
indeed almost any other window.</docstring>
- <refdoc>
- Styles
- wx.BU_LEFT: Left-justifies the label. WIN32 only.
- wx.BU_TOP: Aligns the label to the top of the button. WIN32 only.
- wx.BU_RIGHT: Right-justifies the bitmap label. WIN32 only.
- wx.BU_BOTTOM: Aligns the label to the bottom of the button. WIN32 only.
- wx.BU_EXACTFIT: Creates the button as small as possible instead of making
- it of the standard size (which is the default behaviour.)
-
- Events
- EVT_BUTTON: Sent when the button is clicked.
-</refdoc>
<baseclass name="Control"/>
<constructor name="Button" overloaded="no">
- <autodoc>__init__(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- Validator validator=DefaultValidator, String name=ButtonNameStr) -> Button</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, Validator validator=DefaultValidator,
+ String name=ButtonNameStr) -> Button</autodoc>
<docstring>Create and show a button.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<docstring>Precreate a Button for 2-phase creation.</docstring>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- Validator validator=DefaultValidator, String name=ButtonNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, Validator validator=DefaultValidator,
+ String name=ButtonNameStr) -> bool</autodoc>
<docstring>Acutally create the GUI Button for 2-phase creation.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
</paramlist>
</method>
<method name="SetDefault" type="" overloaded="no">
- <autodoc>SetDefault()</autodoc>
+ <autodoc>SetDefault(self)</autodoc>
<docstring>This sets the button to be the default item for the panel or dialog box.</docstring>
</method>
<staticmethod name="GetDefaultSize" type="Size" overloaded="no">
<autodoc>GetDefaultSize() -> Size</autodoc>
+ <docstring>Returns the default button size for this platform.</docstring>
+ </staticmethod>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
</staticmethod>
</class>
- <class name="BitmapButton" oldname="wxBitmapButton" module="controls">
+ <class name="BitmapButton" oldname="wxBitmapButton" module="_controls">
<docstring>A Button that contains a bitmap. A bitmap button can be supplied with a
-single bitmap, and wxWindows will draw all button states using this bitmap. If
+single bitmap, and wxWidgets will draw all button states using this bitmap. If
the application needs more control, additional bitmaps for the selected state,
-unpressed focused state, and greyed-out state may be supplied.
-</docstring>
- <refdoc>
- Styles
- wx.BU_AUTODRAW: If this is specified, the button will be drawn
- automatically using the label bitmap only, providing a
- 3D-look border. If this style is not specified, the button
- will be drawn without borders and using all provided
- bitmaps. WIN32 only.
- wx.BU_LEFT: Left-justifies the label. WIN32 only.
- wx.BU_TOP: Aligns the label to the top of the button. WIN32 only.
- wx.BU_RIGHT: Right-justifies the bitmap label. WIN32 only.
- wx.BU_BOTTOM: Aligns the label to the bottom of the button. WIN32 only.
- wx.BU_EXACTFIT: Creates the button as small as possible instead of making
- it of the standard size (which is the default behaviour.)
-
- Events
- EVT_BUTTON: Sent when the button is clicked.
-</refdoc>
+unpressed focused state, and greyed-out state may be supplied.</docstring>
<baseclass name="Button"/>
<constructor name="BitmapButton" overloaded="no">
- <autodoc>__init__(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=BU_AUTODRAW,
- Validator validator=DefaultValidator,
+ <autodoc>__init__(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=BU_AUTODRAW, Validator validator=DefaultValidator,
String name=ButtonNameStr) -> BitmapButton</autodoc>
<docstring>Create and show a button with a bitmap for the label.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="bitmap" type="Bitmap" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="bitmap" type="Bitmap" default="wxNullBitmap"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxBU_AUTODRAW"/>
<docstring>Precreate a BitmapButton for 2-phase creation.</docstring>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=BU_AUTODRAW,
- Validator validator=DefaultValidator,
+ <autodoc>Create(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=BU_AUTODRAW, Validator validator=DefaultValidator,
String name=ButtonNameStr) -> bool</autodoc>
<docstring>Acutally create the GUI BitmapButton for 2-phase creation.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="bitmap" type="Bitmap" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="bitmap" type="Bitmap" default="wxNullBitmap"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxBU_AUTODRAW"/>
</paramlist>
</method>
<method name="GetBitmapLabel" type="Bitmap" overloaded="no">
- <autodoc>GetBitmapLabel() -> Bitmap</autodoc>
+ <autodoc>GetBitmapLabel(self) -> Bitmap</autodoc>
<docstring>Returns the label bitmap (the one passed to the constructor).</docstring>
</method>
<method name="GetBitmapDisabled" type="Bitmap" overloaded="no">
- <autodoc>GetBitmapDisabled() -> Bitmap</autodoc>
+ <autodoc>GetBitmapDisabled(self) -> Bitmap</autodoc>
<docstring>Returns the bitmap for the disabled state.</docstring>
</method>
<method name="GetBitmapFocus" type="Bitmap" overloaded="no">
- <autodoc>GetBitmapFocus() -> Bitmap</autodoc>
+ <autodoc>GetBitmapFocus(self) -> Bitmap</autodoc>
<docstring>Returns the bitmap for the focused state.</docstring>
</method>
<method name="GetBitmapSelected" type="Bitmap" overloaded="no">
- <autodoc>GetBitmapSelected() -> Bitmap</autodoc>
+ <autodoc>GetBitmapSelected(self) -> Bitmap</autodoc>
<docstring>Returns the bitmap for the selected state.</docstring>
</method>
<method name="SetBitmapDisabled" type="" overloaded="no">
- <autodoc>SetBitmapDisabled(Bitmap bitmap)</autodoc>
+ <autodoc>SetBitmapDisabled(self, Bitmap bitmap)</autodoc>
<docstring>Sets the bitmap for the disabled button appearance.</docstring>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="SetBitmapFocus" type="" overloaded="no">
- <autodoc>SetBitmapFocus(Bitmap bitmap)</autodoc>
+ <autodoc>SetBitmapFocus(self, Bitmap bitmap)</autodoc>
<docstring>Sets the bitmap for the button appearance when it has the keyboard focus.</docstring>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="SetBitmapSelected" type="" overloaded="no">
- <autodoc>SetBitmapSelected(Bitmap bitmap)</autodoc>
+ <autodoc>SetBitmapSelected(self, Bitmap bitmap)</autodoc>
<docstring>Sets the bitmap for the selected (depressed) button appearance.</docstring>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="SetBitmapLabel" type="" overloaded="no">
- <autodoc>SetBitmapLabel(Bitmap bitmap)</autodoc>
+ <autodoc>SetBitmapLabel(self, Bitmap bitmap)</autodoc>
<docstring>Sets the bitmap label for the button. This is the bitmap used for the
unselected state, and for all other states if no other bitmaps are provided.</docstring>
<paramlist>
</paramlist>
</method>
<method name="SetMargins" type="" overloaded="no">
- <autodoc>SetMargins(int x, int y)</autodoc>
+ <autodoc>SetMargins(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="GetMarginX" type="int" overloaded="no">
- <autodoc>GetMarginX() -> int</autodoc>
+ <autodoc>GetMarginX(self) -> int</autodoc>
</method>
<method name="GetMarginY" type="int" overloaded="no">
- <autodoc>GetMarginY() -> int</autodoc>
+ <autodoc>GetMarginY(self) -> int</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="CheckBox" oldname="wxCheckBox" module="controls">
- <docstring>A checkbox is a labelled box which by default is either on (checkmark is
-visible) or off (no checkmark). Optionally (When the wxCHK_3STATE style flag
-is set) it can have a third state, called the mixed or undetermined
-state. Often this is used as a "Does Not Apply" state.</docstring>
- <refdoc>
- Styles
- wx.CHK_2STATE: Create a 2-state checkbox. This is the default.
- wx.CHK_3STATE: Create a 3-state checkbox.
- wx.CHK_ALLOW_3RD_STATE_FOR_USER: By default a user can't set a 3-state
- checkbox to the third state. It can only
- be done from code. Using this flags
- allows the user to set the checkbox to
- the third state by clicking.
- wx.ALIGN_RIGHT: Makes the text appear on the left of the checkbox.
-
- Events
- EVT_CHECKBOX: Sent when checkbox is clicked.
-</refdoc>
+ <class name="CheckBox" oldname="wxCheckBox" module="_controls">
+ <docstring>A checkbox is a labelled box which by default is either on (the
+checkmark is visible) or off (no checkmark). Optionally (When the
+wx.CHK_3STATE style flag is set) it can have a third state, called the
+mixed or undetermined state. Often this is used as a "Does Not
+Apply" state.</docstring>
<baseclass name="Control"/>
<constructor name="CheckBox" overloaded="no">
- <autodoc>__init__(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> CheckBox</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, Validator validator=DefaultValidator,
+ String name=CheckBoxNameStr) -> CheckBox</autodoc>
<docstring>Creates and shows a CheckBox control</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<docstring>Precreate a CheckBox for 2-phase creation.</docstring>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, Validator validator=DefaultValidator,
+ String name=CheckBoxNameStr) -> bool</autodoc>
<docstring>Actually create the GUI CheckBox for 2-phase creation.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
</paramlist>
</method>
<method name="GetValue" type="bool" overloaded="no">
- <autodoc>GetValue() -> bool</autodoc>
+ <autodoc>GetValue(self) -> bool</autodoc>
<docstring>Gets the state of a 2-state CheckBox. Returns True if it is checked,
False otherwise.</docstring>
</method>
<method name="IsChecked" type="bool" overloaded="no">
- <autodoc>IsChecked() -> bool</autodoc>
- <docstring>Similar to GetValue, but raises an exception if it is not a 2-state CheckBox.</docstring>
+ <autodoc>IsChecked(self) -> bool</autodoc>
+ <docstring>Similar to GetValue, but raises an exception if it is not a 2-state
+CheckBox.</docstring>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(bool state)</autodoc>
- <docstring>Set the state of a 2-state CheckBox. Pass True for checked,
-False for unchecked.</docstring>
+ <autodoc>SetValue(self, bool state)</autodoc>
+ <docstring>Set the state of a 2-state CheckBox. Pass True for checked, False for
+unchecked.</docstring>
<paramlist>
<param name="state" type="bool" default=""/>
</paramlist>
</method>
<method name="Get3StateValue" type="wxCheckBoxState" overloaded="no">
- <autodoc>Get3StateValue() -> int</autodoc>
- <docstring>Returns wx.CHK_UNCHECKED when the CheckBox is unchecked, wx.CHK_CHECKED when
-it is checked and wx.CHK_UNDETERMINED when it's in the undetermined state.
-Raises an exceptiion when the function is used with a 2-state CheckBox.</docstring>
+ <autodoc>Get3StateValue(self) -> int</autodoc>
+ <docstring>Returns wx.CHK_UNCHECKED when the CheckBox is unchecked,
+wx.CHK_CHECKED when it is checked and wx.CHK_UNDETERMINED when it's in
+the undetermined state. Raises an exceptiion when the function is
+used with a 2-state CheckBox.</docstring>
</method>
<method name="Set3StateValue" type="" overloaded="no">
- <autodoc>Set3StateValue(int state)</autodoc>
- <docstring>Sets the CheckBox to the given state. The state parameter can be
-one of the following: wx.CHK_UNCHECKED (Check is off), wx.CHK_CHECKED
-(Check is on) or wx.CHK_UNDETERMINED (Check is mixed). Raises an
-exception when the CheckBox is a 2-state checkbox and setting the state
-to wx.CHK_UNDETERMINED.</docstring>
+ <autodoc>Set3StateValue(self, int state)</autodoc>
+ <docstring>Sets the CheckBox to the given state. The state parameter can be one
+of the following: wx.CHK_UNCHECKED (Check is off), wx.CHK_CHECKED (the
+Check is on) or wx.CHK_UNDETERMINED (Check is mixed). Raises an
+exception when the CheckBox is a 2-state checkbox and setting the
+state to wx.CHK_UNDETERMINED.</docstring>
<paramlist>
<param name="state" type="wxCheckBoxState" default=""/>
</paramlist>
</method>
<method name="Is3State" type="bool" overloaded="no">
- <autodoc>Is3State() -> bool</autodoc>
+ <autodoc>Is3State(self) -> bool</autodoc>
<docstring>Returns whether or not the CheckBox is a 3-state CheckBox.</docstring>
</method>
<method name="Is3rdStateAllowedForUser" type="bool" overloaded="no">
- <autodoc>Is3rdStateAllowedForUser() -> bool</autodoc>
- <docstring>Returns whether or not the user can set the CheckBox to the third state.</docstring>
+ <autodoc>Is3rdStateAllowedForUser(self) -> bool</autodoc>
+ <docstring>Returns whether or not the user can set the CheckBox to the third
+state.</docstring>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Choice" oldname="wxChoice" module="controls">
- <docstring>A Choice control is used to select one of a list of strings. Unlike a ListBox,
-only the selection is visible until the user pulls down the menu of choices.</docstring>
- <refdoc>
- Events
- EVT_CHOICE: Sent when an item in the list is selected.
-</refdoc>
+ <class name="Choice" oldname="wxChoice" module="_controls">
+ <docstring>A Choice control is used to select one of a list of strings.
+Unlike a `wx.ListBox`, only the selection is visible until the
+user pulls down the menu of choices.</docstring>
<baseclass name="ControlWithItems"/>
<constructor name="Choice" overloaded="no">
<autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
<docstring>Create and show a Choice control</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="choices" type="wxArrayString" default="wxPyEmptyStringArray"/>
<autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
List choices=[], long style=0, Validator validator=DefaultValidator,
String name=ChoiceNameStr) -> bool</autodoc>
- <docstring>Actually create the GUI Choice control for 2-phase creation</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="choices" type="wxArrayString" default="wxPyEmptyStringArray"/>
</paramlist>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(int n)</autodoc>
+ <autodoc>SetSelection(self, int n)</autodoc>
<docstring>Select the n'th item (zero based) in the list.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
- <method name="SetStringSelection" type="" overloaded="no">
- <autodoc>SetStringSelection(String string)</autodoc>
+ <method name="SetStringSelection" type="bool" overloaded="no">
+ <autodoc>SetStringSelection(self, String string) -> bool</autodoc>
<docstring>Select the item with the specifed string</docstring>
<paramlist>
<param name="string" type="String" default=""/>
</paramlist>
</method>
<method name="SetString" type="" overloaded="no">
- <autodoc>SetString(int n, String string)</autodoc>
+ <autodoc>SetString(self, int n, String string)</autodoc>
<docstring>Set the label for the n'th item (zero based) in the list.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
<param name="string" type="String" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ComboBox" oldname="wxComboBox" module="controls">
- <docstring>A combobox is like a combination of an edit control and a listbox. It can be
-displayed as static list with editable or read-only text field; or a drop-down
-list with text field.</docstring>
- <refdoc>
- Styles
- wx.CB_SIMPLE: Creates a combobox with a permanently displayed list.
- Windows only.
-
- wx.CB_DROPDOWN: Creates a combobox with a drop-down list.
-
- wx.CB_READONLY: Same as wxCB_DROPDOWN but only the strings specified as
- the combobox choices can be selected, it is impossible
- to select (even from a program) a string which is not in
- the choices list.
-
- wx.CB_SORT: Sorts the entries in the list alphabetically.
-
- Events
+ <class name="ComboBox" oldname="wxComboBox" module="_controls">
+ <docstring>A combobox is like a combination of an edit control and a
+listbox. It can be displayed as static list with editable or
+read-only text field; or a drop-down list with text field.
- EVT_COMBOBOX: Sent when an item on the list is selected.
- EVT_TEXT: Sent when the combobox text changes.
-</refdoc>
+A combobox permits a single selection only. Combobox items are
+numbered from zero.</docstring>
<baseclass name="Control"/>
<baseclass name="ItemContainer"/>
<constructor name="ComboBox" overloaded="no">
<autodoc>__init__(Window parent, int id, String value=EmptyString,
Point pos=DefaultPosition, Size size=DefaultSize,
- List choices=[], long style=0, Validator validator=DefaultValidator,
- String name=ComboBoxNameStr) -> ComboBox</autodoc>
+ List choices=[], long style=0, Validator validator=DefaultValidator,
+ String name=ComboBoxNameStr) -> ComboBox</autodoc>
<docstring>Constructor, creates and shows a ComboBox control.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="value" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
Point pos=DefaultPosition, Size size=DefaultSize,
List choices=[], long style=0, Validator validator=DefaultValidator,
String name=ChoiceNameStr) -> bool</autodoc>
- <docstring>Actually create the GUI wxComboBox control for 2-phase creation</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="value" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
</paramlist>
</method>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
<docstring>Returns the current value in the combobox text field.</docstring>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(String value)</autodoc>
+ <autodoc>SetValue(self, String value)</autodoc>
<paramlist>
<param name="value" type="String" default=""/>
</paramlist>
</method>
<method name="Copy" type="" overloaded="no">
- <autodoc>Copy()</autodoc>
+ <autodoc>Copy(self)</autodoc>
<docstring>Copies the selected text to the clipboard.</docstring>
</method>
<method name="Cut" type="" overloaded="no">
- <autodoc>Cut()</autodoc>
+ <autodoc>Cut(self)</autodoc>
<docstring>Copies the selected text to the clipboard and removes the selection.</docstring>
</method>
<method name="Paste" type="" overloaded="no">
- <autodoc>Paste()</autodoc>
+ <autodoc>Paste(self)</autodoc>
<docstring>Pastes text from the clipboard to the text field.</docstring>
</method>
<method name="SetInsertionPoint" type="" overloaded="no">
- <autodoc>SetInsertionPoint(long pos)</autodoc>
+ <autodoc>SetInsertionPoint(self, long pos)</autodoc>
<docstring>Sets the insertion point in the combobox text field.</docstring>
<paramlist>
<param name="pos" type="long" default=""/>
</paramlist>
</method>
<method name="GetInsertionPoint" type="long" overloaded="no">
- <autodoc>GetInsertionPoint() -> long</autodoc>
+ <autodoc>GetInsertionPoint(self) -> long</autodoc>
<docstring>Returns the insertion point for the combobox's text field.</docstring>
</method>
<method name="GetLastPosition" type="long" overloaded="no">
- <autodoc>GetLastPosition() -> long</autodoc>
+ <autodoc>GetLastPosition(self) -> long</autodoc>
<docstring>Returns the last position in the combobox text field.</docstring>
</method>
<method name="Replace" type="" overloaded="no">
- <autodoc>Replace(long from, long to, String value)</autodoc>
+ <autodoc>Replace(self, long from, long to, String value)</autodoc>
<docstring>Replaces the text between two positions with the given text, in the
combobox text field.</docstring>
<paramlist>
</paramlist>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(int n)</autodoc>
- <docstring>Selects the text between the two positions, in the combobox text field.</docstring>
+ <autodoc>SetSelection(self, int n)</autodoc>
+ <docstring>Sets the item at index 'n' to be the selected item.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetMark" type="" overloaded="no">
- <autodoc>SetMark(long from, long to)</autodoc>
+ <autodoc>SetMark(self, long from, long to)</autodoc>
+ <docstring>Selects the text between the two positions in the combobox text field.</docstring>
<paramlist>
<param name="from" type="long" default=""/>
<param name="to" type="long" default=""/>
</paramlist>
</method>
+ <method name="SetStringSelection" type="bool" overloaded="no">
+ <autodoc>SetStringSelection(self, String string) -> bool</autodoc>
+ <docstring>Select the item with the specifed string</docstring>
+ <paramlist>
+ <param name="string" type="String" default=""/>
+ </paramlist>
+ </method>
+ <method name="SetString" type="" overloaded="no">
+ <autodoc>SetString(self, int n, String string)</autodoc>
+ <docstring>Set the label for the n'th item (zero based) in the list.</docstring>
+ <paramlist>
+ <param name="n" type="int" default=""/>
+ <param name="string" type="String" default=""/>
+ </paramlist>
+ </method>
<method name="SetEditable" type="" overloaded="no">
- <autodoc>SetEditable(bool editable)</autodoc>
+ <autodoc>SetEditable(self, bool editable)</autodoc>
<paramlist>
<param name="editable" type="bool" default=""/>
</paramlist>
</method>
<method name="SetInsertionPointEnd" type="" overloaded="no">
- <autodoc>SetInsertionPointEnd()</autodoc>
+ <autodoc>SetInsertionPointEnd(self)</autodoc>
<docstring>Sets the insertion point at the end of the combobox text field.</docstring>
</method>
<method name="Remove" type="" overloaded="no">
- <autodoc>Remove(long from, long to)</autodoc>
+ <autodoc>Remove(self, long from, long to)</autodoc>
<docstring>Removes the text between the two positions in the combobox text field.</docstring>
<paramlist>
<param name="from" type="long" default=""/>
<param name="to" type="long" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Gauge" oldname="wxGauge" module="controls">
+ <class name="Gauge" oldname="wxGauge" module="_controls">
<baseclass name="Control"/>
<constructor name="Gauge" overloaded="no">
- <autodoc>__init__(Window parent, int id, int range, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, int range=100, Point pos=DefaultPosition,
Size size=DefaultSize, long style=GA_HORIZONTAL,
Validator validator=DefaultValidator,
String name=GaugeNameStr) -> Gauge</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="range" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="range" type="int" default="100"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxGA_HORIZONTAL"/>
<autodoc>PreGauge() -> Gauge</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, int range, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=-1, int range=100, Point pos=DefaultPosition,
Size size=DefaultSize, long style=GA_HORIZONTAL,
Validator validator=DefaultValidator,
String name=GaugeNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="range" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="range" type="int" default="100"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxGA_HORIZONTAL"/>
</paramlist>
</method>
<method name="SetRange" type="" overloaded="no">
- <autodoc>SetRange(int range)</autodoc>
+ <autodoc>SetRange(self, int range)</autodoc>
<paramlist>
<param name="range" type="int" default=""/>
</paramlist>
</method>
<method name="GetRange" type="int" overloaded="no">
- <autodoc>GetRange() -> int</autodoc>
+ <autodoc>GetRange(self) -> int</autodoc>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(int pos)</autodoc>
+ <autodoc>SetValue(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="GetValue" type="int" overloaded="no">
- <autodoc>GetValue() -> int</autodoc>
+ <autodoc>GetValue(self) -> int</autodoc>
</method>
<method name="IsVertical" type="bool" overloaded="no">
- <autodoc>IsVertical() -> bool</autodoc>
+ <autodoc>IsVertical(self) -> bool</autodoc>
</method>
<method name="SetShadowWidth" type="" overloaded="no">
- <autodoc>SetShadowWidth(int w)</autodoc>
+ <autodoc>SetShadowWidth(self, int w)</autodoc>
<paramlist>
<param name="w" type="int" default=""/>
</paramlist>
</method>
<method name="GetShadowWidth" type="int" overloaded="no">
- <autodoc>GetShadowWidth() -> int</autodoc>
+ <autodoc>GetShadowWidth(self) -> int</autodoc>
</method>
<method name="SetBezelFace" type="" overloaded="no">
- <autodoc>SetBezelFace(int w)</autodoc>
+ <autodoc>SetBezelFace(self, int w)</autodoc>
<paramlist>
<param name="w" type="int" default=""/>
</paramlist>
</method>
<method name="GetBezelFace" type="int" overloaded="no">
- <autodoc>GetBezelFace() -> int</autodoc>
+ <autodoc>GetBezelFace(self) -> int</autodoc>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="StaticBox" oldname="wxStaticBox" module="controls">
+ <class name="StaticBox" oldname="wxStaticBox" module="_controls">
<baseclass name="Control"/>
<constructor name="StaticBox" overloaded="no">
- <autodoc>__init__(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- String name=StaticBoxNameStr) -> StaticBox</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, String name=StaticBoxNameStr) -> StaticBox</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<autodoc>PreStaticBox() -> StaticBox</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- String name=StaticBoxNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, String name=StaticBoxNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<param name="name" type="String" default="wxPyStaticBoxNameStr"/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="StaticLine" oldname="wxStaticLine" module="controls">
+ <class name="StaticLine" oldname="wxStaticLine" module="_controls">
<baseclass name="Control"/>
<constructor name="StaticLine" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=LI_HORIZONTAL,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=LI_HORIZONTAL,
String name=StaticTextNameStr) -> StaticLine</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxLI_HORIZONTAL"/>
<autodoc>PreStaticLine() -> StaticLine</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=LI_HORIZONTAL,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=LI_HORIZONTAL,
String name=StaticTextNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxLI_HORIZONTAL"/>
</paramlist>
</method>
<method name="IsVertical" type="bool" overloaded="no">
- <autodoc>IsVertical() -> bool</autodoc>
+ <autodoc>IsVertical(self) -> bool</autodoc>
</method>
<staticmethod name="GetDefaultSize" type="int" overloaded="no">
<autodoc>GetDefaultSize() -> int</autodoc>
</staticmethod>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="StaticText" oldname="wxStaticText" module="controls">
+ <class name="StaticText" oldname="wxStaticText" module="_controls">
<baseclass name="Control"/>
<constructor name="StaticText" overloaded="no">
- <autodoc>__init__(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- String name=StaticTextNameStr) -> StaticText</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, String name=StaticTextNameStr) -> StaticText</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<autodoc>PreStaticText() -> StaticText</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- String name=StaticTextNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, String name=StaticTextNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<param name="name" type="String" default="wxPyStaticTextNameStr"/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="StaticBitmap" oldname="wxStaticBitmap" module="controls">
+ <class name="StaticBitmap" oldname="wxStaticBitmap" module="_controls">
<baseclass name="Control"/>
<constructor name="StaticBitmap" overloaded="no">
- <autodoc>__init__(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- String name=StaticBitmapNameStr) -> StaticBitmap</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, String name=StaticBitmapNameStr) -> StaticBitmap</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="bitmap" type="Bitmap" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="bitmap" type="Bitmap" default="wxNullBitmap"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<autodoc>PreStaticBitmap() -> StaticBitmap</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- String name=StaticBitmapNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, String name=StaticBitmapNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="bitmap" type="Bitmap" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="bitmap" type="Bitmap" default="wxNullBitmap"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
</paramlist>
</method>
<method name="GetBitmap" type="Bitmap" overloaded="no">
- <autodoc>GetBitmap() -> Bitmap</autodoc>
+ <autodoc>GetBitmap(self) -> Bitmap</autodoc>
</method>
<method name="SetBitmap" type="" overloaded="no">
- <autodoc>SetBitmap(Bitmap bitmap)</autodoc>
+ <autodoc>SetBitmap(self, Bitmap bitmap)</autodoc>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="SetIcon" type="" overloaded="no">
- <autodoc>SetIcon(Icon icon)</autodoc>
+ <autodoc>SetIcon(self, Icon icon)</autodoc>
<paramlist>
<param name="icon" type="Icon" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ListBox" oldname="wxListBox" module="controls">
+ <class name="ListBox" oldname="wxListBox" module="_controls">
<baseclass name="ControlWithItems"/>
<constructor name="ListBox" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
long style=0, Validator validator=DefaultValidator,
String name=ListBoxNameStr) -> ListBox</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="choices" type="wxArrayString" default="wxPyEmptyStringArray"/>
<autodoc>PreListBox() -> ListBox</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
long style=0, Validator validator=DefaultValidator,
String name=ListBoxNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="choices" type="wxArrayString" default="wxPyEmptyStringArray"/>
</paramlist>
</method>
<method name="Insert" type="" overloaded="no">
- <autodoc>Insert(String item, int pos, PyObject clientData=None)</autodoc>
- <docstring>Insert an item into the control before the item at the pos index,
+ <autodoc>Insert(self, String item, int pos, PyObject clientData=None)</autodoc>
+ <docstring>Insert an item into the control before the item at the ``pos`` index,
optionally associating some data object with the item.</docstring>
<paramlist>
<param name="item" type="String" default=""/>
</paramlist>
</method>
<method name="InsertItems" type="" overloaded="no">
- <autodoc>InsertItems(wxArrayString items, int pos)</autodoc>
+ <autodoc>InsertItems(self, wxArrayString items, int pos)</autodoc>
<paramlist>
<param name="items" type="wxArrayString" default=""/>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(wxArrayString items)</autodoc>
+ <autodoc>Set(self, wxArrayString items)</autodoc>
<paramlist>
<param name="items" type="wxArrayString" default=""/>
</paramlist>
</method>
<method name="IsSelected" type="bool" overloaded="no">
- <autodoc>IsSelected(int n) -> bool</autodoc>
+ <autodoc>IsSelected(self, int n) -> bool</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(int n, bool select=True)</autodoc>
+ <autodoc>SetSelection(self, int n, bool select=True)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
<param name="select" type="bool" default="True"/>
</paramlist>
</method>
<method name="Select" type="" overloaded="no">
- <autodoc>Select(int n)</autodoc>
+ <autodoc>Select(self, int n)</autodoc>
<docstring>Sets the item at index 'n' to be the selected item.</docstring>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="Deselect" type="" overloaded="no">
- <autodoc>Deselect(int n)</autodoc>
+ <autodoc>Deselect(self, int n)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="DeselectAll" type="" overloaded="no">
- <autodoc>DeselectAll(int itemToLeaveSelected=-1)</autodoc>
+ <autodoc>DeselectAll(self, int itemToLeaveSelected=-1)</autodoc>
<paramlist>
<param name="itemToLeaveSelected" type="int" default="-1"/>
</paramlist>
</method>
<method name="SetStringSelection" type="bool" overloaded="no">
- <autodoc>SetStringSelection(String s, bool select=True) -> bool</autodoc>
+ <autodoc>SetStringSelection(self, String s, bool select=True) -> bool</autodoc>
<paramlist>
<param name="s" type="String" default=""/>
<param name="select" type="bool" default="True"/>
</paramlist>
</method>
<method name="GetSelections" type="PyObject" overloaded="no">
- <autodoc>GetSelections() -> PyObject</autodoc>
+ <autodoc>GetSelections(self) -> PyObject</autodoc>
</method>
<method name="SetFirstItem" type="" overloaded="no">
- <autodoc>SetFirstItem(int n)</autodoc>
+ <autodoc>SetFirstItem(self, int n)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetFirstItemStr" type="" overloaded="no">
- <autodoc>SetFirstItemStr(String s)</autodoc>
+ <autodoc>SetFirstItemStr(self, String s)</autodoc>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="EnsureVisible" type="" overloaded="no">
- <autodoc>EnsureVisible(int n)</autodoc>
+ <autodoc>EnsureVisible(self, int n)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="AppendAndEnsureVisible" type="" overloaded="no">
- <autodoc>AppendAndEnsureVisible(String s)</autodoc>
+ <autodoc>AppendAndEnsureVisible(self, String s)</autodoc>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="IsSorted" type="bool" overloaded="no">
- <autodoc>IsSorted() -> bool</autodoc>
+ <autodoc>IsSorted(self) -> bool</autodoc>
</method>
<method name="SetItemForegroundColour" type="" overloaded="no">
- <autodoc>SetItemForegroundColour(int item, Colour c)</autodoc>
+ <autodoc>SetItemForegroundColour(self, int item, Colour c)</autodoc>
<paramlist>
<param name="item" type="int" default=""/>
<param name="c" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetItemBackgroundColour" type="" overloaded="no">
- <autodoc>SetItemBackgroundColour(int item, Colour c)</autodoc>
+ <autodoc>SetItemBackgroundColour(self, int item, Colour c)</autodoc>
<paramlist>
<param name="item" type="int" default=""/>
<param name="c" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetItemFont" type="" overloaded="no">
- <autodoc>SetItemFont(int item, Font f)</autodoc>
+ <autodoc>SetItemFont(self, int item, Font f)</autodoc>
<paramlist>
<param name="item" type="int" default=""/>
<param name="f" type="Font" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="CheckListBox" oldname="wxCheckListBox" module="controls">
+ <class name="CheckListBox" oldname="wxCheckListBox" module="_controls">
<baseclass name="ListBox"/>
<constructor name="CheckListBox" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
long style=0, Validator validator=DefaultValidator,
String name=ListBoxNameStr) -> CheckListBox</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="choices" type="wxArrayString" default="wxPyEmptyStringArray"/>
<autodoc>PreCheckListBox() -> CheckListBox</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- wxArrayString choices=wxPyEmptyStringArray,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
long style=0, Validator validator=DefaultValidator,
String name=ListBoxNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="choices" type="wxArrayString" default="wxPyEmptyStringArray"/>
</paramlist>
</method>
<method name="IsChecked" type="bool" overloaded="no">
- <autodoc>IsChecked(int index) -> bool</autodoc>
+ <autodoc>IsChecked(self, int index) -> bool</autodoc>
<paramlist>
<param name="index" type="int" default=""/>
</paramlist>
</method>
<method name="Check" type="" overloaded="no">
- <autodoc>Check(int index, int check=True)</autodoc>
+ <autodoc>Check(self, int index, int check=True)</autodoc>
<paramlist>
<param name="index" type="int" default=""/>
<param name="check" type="int" default="True"/>
</paramlist>
</method>
<method name="GetItemHeight" type="int" overloaded="no">
- <autodoc>GetItemHeight() -> int</autodoc>
+ <autodoc>GetItemHeight(self) -> int</autodoc>
</method>
<method name="HitTest" type="int" overloaded="no">
- <autodoc>HitTest(Point pt) -> int</autodoc>
+ <autodoc>HitTest(self, Point pt) -> int</autodoc>
<docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="HitTestXY" type="int" overloaded="no">
- <autodoc>HitTestXY(int x, int y) -> int</autodoc>
+ <autodoc>HitTestXY(self, int x, int y) -> int</autodoc>
<docstring>Test where the given (in client coords) point lies</docstring>
<paramlist>
<param name="x" type="int" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="TextAttr" oldname="wxTextAttr" module="controls">
+ <class name="TextAttr" oldname="wxTextAttr" module="_controls">
<constructor name="TextAttr" overloaded="yes"/>
<constructor name="TextAttr" overloaded="yes">
- <autodoc>__init__() -> TextAttr
-__init__(Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont,
+ <autodoc>__init__(self) -> TextAttr
+__init__(self, Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont,
int alignment=TEXT_ALIGNMENT_DEFAULT) -> TextAttr</autodoc>
<paramlist>
<param name="colText" type="Colour" default=""/>
</paramlist>
</constructor>
<destructor name="~wxTextAttr" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Init" type="" overloaded="no">
- <autodoc>Init()</autodoc>
+ <autodoc>Init(self)</autodoc>
</method>
<method name="SetTextColour" type="" overloaded="no">
- <autodoc>SetTextColour(Colour colText)</autodoc>
+ <autodoc>SetTextColour(self, Colour colText)</autodoc>
<paramlist>
<param name="colText" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetBackgroundColour" type="" overloaded="no">
- <autodoc>SetBackgroundColour(Colour colBack)</autodoc>
+ <autodoc>SetBackgroundColour(self, Colour colBack)</autodoc>
<paramlist>
<param name="colBack" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetFont" type="" overloaded="no">
- <autodoc>SetFont(Font font, long flags=TEXT_ATTR_FONT)</autodoc>
+ <autodoc>SetFont(self, Font font, long flags=TEXT_ATTR_FONT)</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
<param name="flags" type="long" default="wxTEXT_ATTR_FONT"/>
</paramlist>
</method>
<method name="SetAlignment" type="" overloaded="no">
- <autodoc>SetAlignment(int alignment)</autodoc>
+ <autodoc>SetAlignment(self, int alignment)</autodoc>
<paramlist>
<param name="alignment" type="wxTextAttrAlignment" default=""/>
</paramlist>
</method>
<method name="SetTabs" type="" overloaded="no">
- <autodoc>SetTabs(wxArrayInt tabs)</autodoc>
+ <autodoc>SetTabs(self, wxArrayInt tabs)</autodoc>
<paramlist>
<param name="tabs" type="wxArrayInt" default=""/>
</paramlist>
</method>
<method name="SetLeftIndent" type="" overloaded="no">
- <autodoc>SetLeftIndent(int indent)</autodoc>
+ <autodoc>SetLeftIndent(self, int indent, int subIndent=0)</autodoc>
<paramlist>
<param name="indent" type="int" default=""/>
+ <param name="subIndent" type="int" default="0"/>
</paramlist>
</method>
<method name="SetRightIndent" type="" overloaded="no">
- <autodoc>SetRightIndent(int indent)</autodoc>
+ <autodoc>SetRightIndent(self, int indent)</autodoc>
<paramlist>
<param name="indent" type="int" default=""/>
</paramlist>
</method>
<method name="SetFlags" type="" overloaded="no">
- <autodoc>SetFlags(long flags)</autodoc>
+ <autodoc>SetFlags(self, long flags)</autodoc>
<paramlist>
<param name="flags" type="long" default=""/>
</paramlist>
</method>
<method name="HasTextColour" type="bool" overloaded="no">
- <autodoc>HasTextColour() -> bool</autodoc>
+ <autodoc>HasTextColour(self) -> bool</autodoc>
</method>
<method name="HasBackgroundColour" type="bool" overloaded="no">
- <autodoc>HasBackgroundColour() -> bool</autodoc>
+ <autodoc>HasBackgroundColour(self) -> bool</autodoc>
</method>
<method name="HasFont" type="bool" overloaded="no">
- <autodoc>HasFont() -> bool</autodoc>
+ <autodoc>HasFont(self) -> bool</autodoc>
</method>
<method name="HasAlignment" type="bool" overloaded="no">
- <autodoc>HasAlignment() -> bool</autodoc>
+ <autodoc>HasAlignment(self) -> bool</autodoc>
</method>
<method name="HasTabs" type="bool" overloaded="no">
- <autodoc>HasTabs() -> bool</autodoc>
+ <autodoc>HasTabs(self) -> bool</autodoc>
</method>
<method name="HasLeftIndent" type="bool" overloaded="no">
- <autodoc>HasLeftIndent() -> bool</autodoc>
+ <autodoc>HasLeftIndent(self) -> bool</autodoc>
</method>
<method name="HasRightIndent" type="bool" overloaded="no">
- <autodoc>HasRightIndent() -> bool</autodoc>
+ <autodoc>HasRightIndent(self) -> bool</autodoc>
</method>
<method name="HasFlag" type="bool" overloaded="no">
- <autodoc>HasFlag(long flag) -> bool</autodoc>
+ <autodoc>HasFlag(self, long flag) -> bool</autodoc>
<paramlist>
<param name="flag" type="long" default=""/>
</paramlist>
</method>
<method name="GetTextColour" type="Colour" overloaded="no">
- <autodoc>GetTextColour() -> Colour</autodoc>
+ <autodoc>GetTextColour(self) -> Colour</autodoc>
</method>
<method name="GetBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetBackgroundColour() -> Colour</autodoc>
+ <autodoc>GetBackgroundColour(self) -> Colour</autodoc>
</method>
<method name="GetFont" type="Font" overloaded="no">
- <autodoc>GetFont() -> Font</autodoc>
+ <autodoc>GetFont(self) -> Font</autodoc>
</method>
<method name="GetAlignment" type="wxTextAttrAlignment" overloaded="no">
- <autodoc>GetAlignment() -> int</autodoc>
+ <autodoc>GetAlignment(self) -> int</autodoc>
</method>
<method name="GetTabs" type="wxArrayInt" overloaded="no">
- <autodoc>GetTabs() -> wxArrayInt</autodoc>
+ <autodoc>GetTabs(self) -> wxArrayInt</autodoc>
</method>
<method name="GetLeftIndent" type="long" overloaded="no">
- <autodoc>GetLeftIndent() -> long</autodoc>
+ <autodoc>GetLeftIndent(self) -> long</autodoc>
+ </method>
+ <method name="GetLeftSubIndent" type="long" overloaded="no">
+ <autodoc>GetLeftSubIndent(self) -> long</autodoc>
</method>
<method name="GetRightIndent" type="long" overloaded="no">
- <autodoc>GetRightIndent() -> long</autodoc>
+ <autodoc>GetRightIndent(self) -> long</autodoc>
</method>
<method name="GetFlags" type="long" overloaded="no">
- <autodoc>GetFlags() -> long</autodoc>
+ <autodoc>GetFlags(self) -> long</autodoc>
</method>
<method name="IsDefault" type="bool" overloaded="no">
- <autodoc>IsDefault() -> bool</autodoc>
+ <autodoc>IsDefault(self) -> bool</autodoc>
</method>
<staticmethod name="Combine" type="TextAttr" overloaded="no">
<autodoc>Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr</autodoc>
</paramlist>
</staticmethod>
</class>
- <class name="TextCtrl" oldname="wxTextCtrl" module="controls">
+ <class name="TextCtrl" oldname="wxTextCtrl" module="_controls">
<baseclass name="Control"/>
<constructor name="TextCtrl" overloaded="no">
- <autodoc>__init__(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition,
- Size size=DefaultSize,
+ <autodoc>__init__(self, Window parent, int id=-1, String value=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
long style=0, Validator validator=DefaultValidator,
String name=TextCtrlNameStr) -> TextCtrl</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="value" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<autodoc>PreTextCtrl() -> TextCtrl</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition,
- Size size=DefaultSize,
+ <autodoc>Create(self, Window parent, int id=-1, String value=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
long style=0, Validator validator=DefaultValidator,
String name=TextCtrlNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="value" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
</paramlist>
</method>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(String value)</autodoc>
+ <autodoc>SetValue(self, String value)</autodoc>
<paramlist>
<param name="value" type="String" default=""/>
</paramlist>
</method>
<method name="GetRange" type="String" overloaded="no">
- <autodoc>GetRange(long from, long to) -> String</autodoc>
+ <autodoc>GetRange(self, long from, long to) -> String</autodoc>
<paramlist>
<param name="from" type="long" default=""/>
<param name="to" type="long" default=""/>
</paramlist>
</method>
<method name="GetLineLength" type="int" overloaded="no">
- <autodoc>GetLineLength(long lineNo) -> int</autodoc>
+ <autodoc>GetLineLength(self, long lineNo) -> int</autodoc>
<paramlist>
<param name="lineNo" type="long" default=""/>
</paramlist>
</method>
<method name="GetLineText" type="String" overloaded="no">
- <autodoc>GetLineText(long lineNo) -> String</autodoc>
+ <autodoc>GetLineText(self, long lineNo) -> String</autodoc>
<paramlist>
<param name="lineNo" type="long" default=""/>
</paramlist>
</method>
<method name="GetNumberOfLines" type="int" overloaded="no">
- <autodoc>GetNumberOfLines() -> int</autodoc>
+ <autodoc>GetNumberOfLines(self) -> int</autodoc>
</method>
<method name="IsModified" type="bool" overloaded="no">
- <autodoc>IsModified() -> bool</autodoc>
+ <autodoc>IsModified(self) -> bool</autodoc>
</method>
<method name="IsEditable" type="bool" overloaded="no">
- <autodoc>IsEditable() -> bool</autodoc>
+ <autodoc>IsEditable(self) -> bool</autodoc>
</method>
<method name="IsSingleLine" type="bool" overloaded="no">
- <autodoc>IsSingleLine() -> bool</autodoc>
+ <autodoc>IsSingleLine(self) -> bool</autodoc>
</method>
<method name="IsMultiLine" type="bool" overloaded="no">
- <autodoc>IsMultiLine() -> bool</autodoc>
+ <autodoc>IsMultiLine(self) -> bool</autodoc>
</method>
<method name="GetSelection" type="" overloaded="no">
<autodoc>GetSelection() -> (from, to)</autodoc>
- <docstring>If the return values from and to are the same, there is no selection.</docstring>
<paramlist>
<param name="OUTPUT" type="long" default=""/>
<param name="OUTPUT" type="long" default=""/>
</paramlist>
</method>
<method name="GetStringSelection" type="String" overloaded="no">
- <autodoc>GetStringSelection() -> String</autodoc>
+ <autodoc>GetStringSelection(self) -> String</autodoc>
</method>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear()</autodoc>
+ <autodoc>Clear(self)</autodoc>
</method>
<method name="Replace" type="" overloaded="no">
- <autodoc>Replace(long from, long to, String value)</autodoc>
+ <autodoc>Replace(self, long from, long to, String value)</autodoc>
<paramlist>
<param name="from" type="long" default=""/>
<param name="to" type="long" default=""/>
</paramlist>
</method>
<method name="Remove" type="" overloaded="no">
- <autodoc>Remove(long from, long to)</autodoc>
+ <autodoc>Remove(self, long from, long to)</autodoc>
<paramlist>
<param name="from" type="long" default=""/>
<param name="to" type="long" default=""/>
</paramlist>
</method>
<method name="LoadFile" type="bool" overloaded="no">
- <autodoc>LoadFile(String file) -> bool</autodoc>
+ <autodoc>LoadFile(self, String file) -> bool</autodoc>
<paramlist>
<param name="file" type="String" default=""/>
</paramlist>
</method>
<method name="SaveFile" type="bool" overloaded="no">
- <autodoc>SaveFile(String file=EmptyString) -> bool</autodoc>
+ <autodoc>SaveFile(self, String file=EmptyString) -> bool</autodoc>
<paramlist>
<param name="file" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="MarkDirty" type="" overloaded="no">
- <autodoc>MarkDirty()</autodoc>
+ <autodoc>MarkDirty(self)</autodoc>
</method>
<method name="DiscardEdits" type="" overloaded="no">
- <autodoc>DiscardEdits()</autodoc>
+ <autodoc>DiscardEdits(self)</autodoc>
</method>
<method name="SetMaxLength" type="" overloaded="no">
- <autodoc>SetMaxLength(unsigned long len)</autodoc>
+ <autodoc>SetMaxLength(self, unsigned long len)</autodoc>
<paramlist>
<param name="len" type="unsigned long" default=""/>
</paramlist>
</method>
<method name="WriteText" type="" overloaded="no">
- <autodoc>WriteText(String text)</autodoc>
+ <autodoc>WriteText(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="AppendText" type="" overloaded="no">
- <autodoc>AppendText(String text)</autodoc>
+ <autodoc>AppendText(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="EmulateKeyPress" type="bool" overloaded="no">
- <autodoc>EmulateKeyPress(KeyEvent event) -> bool</autodoc>
+ <autodoc>EmulateKeyPress(self, KeyEvent event) -> bool</autodoc>
<paramlist>
<param name="event" type="KeyEvent" default=""/>
</paramlist>
</method>
<method name="SetStyle" type="bool" overloaded="no">
- <autodoc>SetStyle(long start, long end, TextAttr style) -> bool</autodoc>
+ <autodoc>SetStyle(self, long start, long end, TextAttr style) -> bool</autodoc>
<paramlist>
<param name="start" type="long" default=""/>
<param name="end" type="long" default=""/>
</paramlist>
</method>
<method name="GetStyle" type="bool" overloaded="no">
- <autodoc>GetStyle(long position, TextAttr style) -> bool</autodoc>
+ <autodoc>GetStyle(self, long position, TextAttr style) -> bool</autodoc>
<paramlist>
<param name="position" type="long" default=""/>
<param name="style" type="TextAttr" default=""/>
</paramlist>
</method>
<method name="SetDefaultStyle" type="bool" overloaded="no">
- <autodoc>SetDefaultStyle(TextAttr style) -> bool</autodoc>
+ <autodoc>SetDefaultStyle(self, TextAttr style) -> bool</autodoc>
<paramlist>
<param name="style" type="TextAttr" default=""/>
</paramlist>
</method>
<method name="GetDefaultStyle" type="TextAttr" overloaded="no">
- <autodoc>GetDefaultStyle() -> TextAttr</autodoc>
+ <autodoc>GetDefaultStyle(self) -> TextAttr</autodoc>
</method>
<method name="XYToPosition" type="long" overloaded="no">
- <autodoc>XYToPosition(long x, long y) -> long</autodoc>
+ <autodoc>XYToPosition(self, long x, long y) -> long</autodoc>
<paramlist>
<param name="x" type="long" default=""/>
<param name="y" type="long" default=""/>
</paramlist>
</method>
<method name="ShowPosition" type="" overloaded="no">
- <autodoc>ShowPosition(long pos)</autodoc>
+ <autodoc>ShowPosition(self, long pos)</autodoc>
<paramlist>
<param name="pos" type="long" default=""/>
</paramlist>
</method>
<method name="HitTest" type="wxTextCtrlHitTestResult" overloaded="no">
<autodoc>HitTest(Point pt) -> (result, row, col)</autodoc>
- <docstring>Find the character at position given in pixels.
-NB: pt is in device coords (not adjusted for the client area
-origin nor scrolling)</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
<param name="OUTPUT" type="long" default=""/>
</paramlist>
</method>
<method name="Copy" type="" overloaded="no">
- <autodoc>Copy()</autodoc>
+ <autodoc>Copy(self)</autodoc>
</method>
<method name="Cut" type="" overloaded="no">
- <autodoc>Cut()</autodoc>
+ <autodoc>Cut(self)</autodoc>
</method>
<method name="Paste" type="" overloaded="no">
- <autodoc>Paste()</autodoc>
+ <autodoc>Paste(self)</autodoc>
</method>
<method name="CanCopy" type="bool" overloaded="no">
- <autodoc>CanCopy() -> bool</autodoc>
+ <autodoc>CanCopy(self) -> bool</autodoc>
</method>
<method name="CanCut" type="bool" overloaded="no">
- <autodoc>CanCut() -> bool</autodoc>
+ <autodoc>CanCut(self) -> bool</autodoc>
</method>
<method name="CanPaste" type="bool" overloaded="no">
- <autodoc>CanPaste() -> bool</autodoc>
+ <autodoc>CanPaste(self) -> bool</autodoc>
</method>
<method name="Undo" type="" overloaded="no">
- <autodoc>Undo()</autodoc>
+ <autodoc>Undo(self)</autodoc>
</method>
<method name="Redo" type="" overloaded="no">
- <autodoc>Redo()</autodoc>
+ <autodoc>Redo(self)</autodoc>
</method>
<method name="CanUndo" type="bool" overloaded="no">
- <autodoc>CanUndo() -> bool</autodoc>
+ <autodoc>CanUndo(self) -> bool</autodoc>
</method>
<method name="CanRedo" type="bool" overloaded="no">
- <autodoc>CanRedo() -> bool</autodoc>
+ <autodoc>CanRedo(self) -> bool</autodoc>
</method>
<method name="SetInsertionPoint" type="" overloaded="no">
- <autodoc>SetInsertionPoint(long pos)</autodoc>
+ <autodoc>SetInsertionPoint(self, long pos)</autodoc>
<paramlist>
<param name="pos" type="long" default=""/>
</paramlist>
</method>
<method name="SetInsertionPointEnd" type="" overloaded="no">
- <autodoc>SetInsertionPointEnd()</autodoc>
+ <autodoc>SetInsertionPointEnd(self)</autodoc>
</method>
<method name="GetInsertionPoint" type="long" overloaded="no">
- <autodoc>GetInsertionPoint() -> long</autodoc>
+ <autodoc>GetInsertionPoint(self) -> long</autodoc>
</method>
<method name="GetLastPosition" type="long" overloaded="no">
- <autodoc>GetLastPosition() -> long</autodoc>
+ <autodoc>GetLastPosition(self) -> long</autodoc>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(long from, long to)</autodoc>
+ <autodoc>SetSelection(self, long from, long to)</autodoc>
<paramlist>
<param name="from" type="long" default=""/>
<param name="to" type="long" default=""/>
</paramlist>
</method>
<method name="SelectAll" type="" overloaded="no">
- <autodoc>SelectAll()</autodoc>
+ <autodoc>SelectAll(self)</autodoc>
</method>
<method name="SetEditable" type="" overloaded="no">
- <autodoc>SetEditable(bool editable)</autodoc>
+ <autodoc>SetEditable(self, bool editable)</autodoc>
<paramlist>
<param name="editable" type="bool" default=""/>
</paramlist>
</method>
<method name="write" type="" overloaded="no">
- <autodoc>write(String text)</autodoc>
+ <autodoc>write(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="GetString" type="String" overloaded="no">
- <autodoc>GetString(long from, long to) -> String</autodoc>
+ <autodoc>GetString(self, long from, long to) -> String</autodoc>
<paramlist>
<param name="from" type="long" default=""/>
<param name="to" type="long" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
- <class name="TextUrlEvent" oldname="wxTextUrlEvent" module="controls">
+ <class name="TextUrlEvent" oldname="wxTextUrlEvent" module="_controls">
<baseclass name="CommandEvent"/>
<constructor name="TextUrlEvent" overloaded="no">
- <autodoc>__init__(int winid, MouseEvent evtMouse, long start, long end) -> TextUrlEvent</autodoc>
+ <autodoc>__init__(self, int winid, MouseEvent evtMouse, long start, long end) -> TextUrlEvent</autodoc>
<paramlist>
<param name="winid" type="int" default=""/>
<param name="evtMouse" type="MouseEvent" default=""/>
</paramlist>
</constructor>
<method name="GetMouseEvent" type="MouseEvent" overloaded="no">
- <autodoc>GetMouseEvent() -> MouseEvent</autodoc>
+ <autodoc>GetMouseEvent(self) -> MouseEvent</autodoc>
</method>
<method name="GetURLStart" type="long" overloaded="no">
- <autodoc>GetURLStart() -> long</autodoc>
+ <autodoc>GetURLStart(self) -> long</autodoc>
</method>
<method name="GetURLEnd" type="long" overloaded="no">
- <autodoc>GetURLEnd() -> long</autodoc>
+ <autodoc>GetURLEnd(self) -> long</autodoc>
</method>
</class>
<pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ScrollBar" oldname="wxScrollBar" module="controls">
+ <class name="ScrollBar" oldname="wxScrollBar" module="_controls">
<baseclass name="Control"/>
<constructor name="ScrollBar" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=SB_HORIZONTAL,
Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> ScrollBar</autodoc>
<paramlist>
<autodoc>PreScrollBar() -> ScrollBar</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=SB_HORIZONTAL,
Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> bool</autodoc>
<docstring>Do the 2nd phase and create the GUI control.</docstring>
</paramlist>
</method>
<method name="GetThumbPosition" type="int" overloaded="no">
- <autodoc>GetThumbPosition() -> int</autodoc>
+ <autodoc>GetThumbPosition(self) -> int</autodoc>
</method>
<method name="GetThumbSize" type="int" overloaded="no">
- <autodoc>GetThumbSize() -> int</autodoc>
+ <autodoc>GetThumbSize(self) -> int</autodoc>
</method>
<method name="GetPageSize" type="int" overloaded="no">
- <autodoc>GetPageSize() -> int</autodoc>
+ <autodoc>GetPageSize(self) -> int</autodoc>
</method>
<method name="GetRange" type="int" overloaded="no">
- <autodoc>GetRange() -> int</autodoc>
+ <autodoc>GetRange(self) -> int</autodoc>
</method>
<method name="IsVertical" type="bool" overloaded="no">
- <autodoc>IsVertical() -> bool</autodoc>
+ <autodoc>IsVertical(self) -> bool</autodoc>
</method>
<method name="SetThumbPosition" type="" overloaded="no">
- <autodoc>SetThumbPosition(int viewStart)</autodoc>
+ <autodoc>SetThumbPosition(self, int viewStart)</autodoc>
<paramlist>
<param name="viewStart" type="int" default=""/>
</paramlist>
</method>
<method name="SetScrollbar" type="" overloaded="no">
- <autodoc>SetScrollbar(int position, int thumbSize, int range, int pageSize,
+ <autodoc>SetScrollbar(self, int position, int thumbSize, int range, int pageSize,
bool refresh=True)</autodoc>
- <docstring>Sets the scrollbar properties of a built-in scrollbar.
-
- orientation: Determines the scrollbar whose page size is to be
- set. May be wx.HORIZONTAL or wx.VERTICAL.
-
- position: The position of the scrollbar in scroll units.
-
- thumbSize: The size of the thumb, or visible portion of the
- scrollbar, in scroll units.
-
- range: The maximum position of the scrollbar.
-
- refresh: True to redraw the scrollbar, false otherwise.</docstring>
+ <docstring>Sets the scrollbar properties of a built-in scrollbar.</docstring>
<paramlist>
<param name="position" type="int" default=""/>
<param name="thumbSize" type="int" default=""/>
<param name="refresh" type="bool" default="True"/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="SpinButton" oldname="wxSpinButton" module="controls">
+ <class name="SpinButton" oldname="wxSpinButton" module="_controls">
<baseclass name="Control"/>
<constructor name="SpinButton" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=SP_HORIZONTAL,
String name=SPIN_BUTTON_NAME) -> SpinButton</autodoc>
<paramlist>
<autodoc>PreSpinButton() -> SpinButton</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=SP_HORIZONTAL,
String name=SPIN_BUTTON_NAME) -> bool</autodoc>
<paramlist>
</paramlist>
</method>
<method name="GetValue" type="int" overloaded="no">
- <autodoc>GetValue() -> int</autodoc>
+ <autodoc>GetValue(self) -> int</autodoc>
</method>
<method name="GetMin" type="int" overloaded="no">
- <autodoc>GetMin() -> int</autodoc>
+ <autodoc>GetMin(self) -> int</autodoc>
</method>
<method name="GetMax" type="int" overloaded="no">
- <autodoc>GetMax() -> int</autodoc>
+ <autodoc>GetMax(self) -> int</autodoc>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(int val)</autodoc>
+ <autodoc>SetValue(self, int val)</autodoc>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="SetMin" type="" overloaded="no">
- <autodoc>SetMin(int minVal)</autodoc>
+ <autodoc>SetMin(self, int minVal)</autodoc>
<paramlist>
<param name="minVal" type="int" default=""/>
</paramlist>
</method>
<method name="SetMax" type="" overloaded="no">
- <autodoc>SetMax(int maxVal)</autodoc>
+ <autodoc>SetMax(self, int maxVal)</autodoc>
<paramlist>
<param name="maxVal" type="int" default=""/>
</paramlist>
</method>
<method name="SetRange" type="" overloaded="no">
- <autodoc>SetRange(int minVal, int maxVal)</autodoc>
+ <autodoc>SetRange(self, int minVal, int maxVal)</autodoc>
<paramlist>
<param name="minVal" type="int" default=""/>
<param name="maxVal" type="int" default=""/>
</paramlist>
</method>
<method name="IsVertical" type="bool" overloaded="no">
- <autodoc>IsVertical() -> bool</autodoc>
+ <autodoc>IsVertical(self) -> bool</autodoc>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
- <class name="SpinCtrl" oldname="wxSpinCtrl" module="controls">
+ <class name="SpinCtrl" oldname="wxSpinCtrl" module="_controls">
<baseclass name="Control"/>
<constructor name="SpinCtrl" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, String value=EmptyString,
+ <autodoc>__init__(self, Window parent, int id=-1, String value=EmptyString,
Point pos=DefaultPosition, Size size=DefaultSize,
long style=SP_ARROW_KEYS, int min=0, int max=100,
int initial=0, String name=SpinCtrlNameStr) -> SpinCtrl</autodoc>
<autodoc>PreSpinCtrl() -> SpinCtrl</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, String value=EmptyString,
+ <autodoc>Create(self, Window parent, int id=-1, String value=EmptyString,
Point pos=DefaultPosition, Size size=DefaultSize,
long style=SP_ARROW_KEYS, int min=0, int max=100,
int initial=0, String name=SpinCtrlNameStr) -> bool</autodoc>
</paramlist>
</method>
<method name="GetValue" type="int" overloaded="no">
- <autodoc>GetValue() -> int</autodoc>
+ <autodoc>GetValue(self) -> int</autodoc>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(int value)</autodoc>
+ <autodoc>SetValue(self, int value)</autodoc>
<paramlist>
<param name="value" type="int" default=""/>
</paramlist>
</method>
<method name="SetValueString" type="" overloaded="no">
- <autodoc>SetValueString(String text)</autodoc>
+ <autodoc>SetValueString(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SetRange" type="" overloaded="no">
- <autodoc>SetRange(int minVal, int maxVal)</autodoc>
+ <autodoc>SetRange(self, int minVal, int maxVal)</autodoc>
<paramlist>
<param name="minVal" type="int" default=""/>
<param name="maxVal" type="int" default=""/>
</paramlist>
</method>
<method name="GetMin" type="int" overloaded="no">
- <autodoc>GetMin() -> int</autodoc>
+ <autodoc>GetMin(self) -> int</autodoc>
</method>
<method name="GetMax" type="int" overloaded="no">
- <autodoc>GetMax() -> int</autodoc>
+ <autodoc>GetMax(self) -> int</autodoc>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(long from, long to)</autodoc>
+ <autodoc>SetSelection(self, long from, long to)</autodoc>
<paramlist>
<param name="from" type="long" default=""/>
<param name="to" type="long" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
- <class name="SpinEvent" oldname="wxSpinEvent" module="controls">
+ <class name="SpinEvent" oldname="wxSpinEvent" module="_controls">
<baseclass name="NotifyEvent"/>
<constructor name="SpinEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int winid=0) -> SpinEvent</autodoc>
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> SpinEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
<param name="winid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetPosition" type="int" overloaded="no">
- <autodoc>GetPosition() -> int</autodoc>
+ <autodoc>GetPosition(self) -> int</autodoc>
</method>
<method name="SetPosition" type="" overloaded="no">
- <autodoc>SetPosition(int pos)</autodoc>
+ <autodoc>SetPosition(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="RadioBox" oldname="wxRadioBox" module="controls">
+ <class name="RadioBox" oldname="wxRadioBox" module="_controls">
<baseclass name="Control"/>
<constructor name="RadioBox" overloaded="no">
- <autodoc>__init__(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
- int majorDimension=0,
- long style=RA_HORIZONTAL, Validator validator=DefaultValidator,
+ <autodoc>__init__(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ wxArrayString choices=wxPyEmptyStringArray,
+ int majorDimension=0, long style=RA_HORIZONTAL,
+ Validator validator=DefaultValidator,
String name=RadioBoxNameStr) -> RadioBox</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="choices" type="wxArrayString" default="wxPyEmptyStringArray"/>
<autodoc>PreRadioBox() -> RadioBox</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
- int majorDimension=0,
- long style=RA_HORIZONTAL, Validator validator=DefaultValidator,
+ <autodoc>Create(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ wxArrayString choices=wxPyEmptyStringArray,
+ int majorDimension=0, long style=RA_HORIZONTAL,
+ Validator validator=DefaultValidator,
String name=RadioBoxNameStr) -> bool</autodoc>
<paramlist>
- <param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="parent" type="Window" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="choices" type="wxArrayString" default="wxPyEmptyStringArray"/>
</paramlist>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(int n)</autodoc>
+ <autodoc>SetSelection(self, int n)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetSelection" type="int" overloaded="no">
- <autodoc>GetSelection() -> int</autodoc>
+ <autodoc>GetSelection(self) -> int</autodoc>
</method>
<method name="GetStringSelection" type="String" overloaded="no">
- <autodoc>GetStringSelection() -> String</autodoc>
+ <autodoc>GetStringSelection(self) -> String</autodoc>
</method>
<method name="SetStringSelection" type="bool" overloaded="no">
- <autodoc>SetStringSelection(String s) -> bool</autodoc>
+ <autodoc>SetStringSelection(self, String s) -> bool</autodoc>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="GetCount" type="int" overloaded="no">
- <autodoc>GetCount() -> int</autodoc>
+ <autodoc>GetCount(self) -> int</autodoc>
</method>
<method name="FindString" type="int" overloaded="no">
- <autodoc>FindString(String s) -> int</autodoc>
+ <autodoc>FindString(self, String s) -> int</autodoc>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="GetString" type="String" overloaded="no">
- <autodoc>GetString(int n) -> String</autodoc>
+ <autodoc>GetString(self, int n) -> String</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetString" type="" overloaded="no">
- <autodoc>SetString(int n, String label)</autodoc>
+ <autodoc>SetString(self, int n, String label)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
<param name="label" type="String" default=""/>
</paramlist>
</method>
<method name="EnableItem" type="" overloaded="no">
- <autodoc>EnableItem(int n, bool enable=True)</autodoc>
+ <autodoc>EnableItem(self, int n, bool enable=True)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
<param name="enable" type="bool" default="True"/>
</paramlist>
</method>
<method name="ShowItem" type="" overloaded="no">
- <autodoc>ShowItem(int n, bool show=True)</autodoc>
+ <autodoc>ShowItem(self, int n, bool show=True)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
<param name="show" type="bool" default="True"/>
</paramlist>
</method>
<method name="GetColumnCount" type="int" overloaded="no">
- <autodoc>GetColumnCount() -> int</autodoc>
+ <autodoc>GetColumnCount(self) -> int</autodoc>
</method>
<method name="GetRowCount" type="int" overloaded="no">
- <autodoc>GetRowCount() -> int</autodoc>
+ <autodoc>GetRowCount(self) -> int</autodoc>
</method>
<method name="GetNextItem" type="int" overloaded="no">
- <autodoc>GetNextItem(int item, int dir, long style) -> int</autodoc>
+ <autodoc>GetNextItem(self, int item, int dir, long style) -> int</autodoc>
<paramlist>
<param name="item" type="int" default=""/>
<param name="dir" type="wxDirection" default=""/>
<param name="style" type="long" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="RadioButton" oldname="wxRadioButton" module="controls">
+ <class name="RadioButton" oldname="wxRadioButton" module="_controls">
<baseclass name="Control"/>
<constructor name="RadioButton" overloaded="no">
- <autodoc>__init__(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- Validator validator=DefaultValidator, String name=RadioButtonNameStr) -> RadioButton</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, Validator validator=DefaultValidator,
+ String name=RadioButtonNameStr) -> RadioButton</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<autodoc>PreRadioButton() -> RadioButton</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- Validator validator=DefaultValidator, String name=RadioButtonNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, Validator validator=DefaultValidator,
+ String name=RadioButtonNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
</paramlist>
</method>
<method name="GetValue" type="bool" overloaded="no">
- <autodoc>GetValue() -> bool</autodoc>
+ <autodoc>GetValue(self) -> bool</autodoc>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(bool value)</autodoc>
+ <autodoc>SetValue(self, bool value)</autodoc>
<paramlist>
<param name="value" type="bool" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Slider" oldname="wxSlider" module="controls">
+ <class name="Slider" oldname="wxSlider" module="_controls">
<baseclass name="Control"/>
<constructor name="Slider" overloaded="no">
- <autodoc>__init__(Window parent, int id, int value, int minValue, int maxValue,
- Point pos=DefaultPosition, Size size=DefaultSize,
- long style=SL_HORIZONTAL, Validator validator=DefaultValidator,
+ <autodoc>__init__(self, Window parent, int id=-1, int value=0, int minValue=0,
+ int maxValue=100, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=SL_HORIZONTAL,
+ Validator validator=DefaultValidator,
String name=SliderNameStr) -> Slider</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="value" type="int" default=""/>
- <param name="minValue" type="int" default=""/>
- <param name="maxValue" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="value" type="int" default="0"/>
+ <param name="minValue" type="int" default="0"/>
+ <param name="maxValue" type="int" default="100"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxSL_HORIZONTAL"/>
<autodoc>PreSlider() -> Slider</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, int value, int minValue, int maxValue,
- Point pos=DefaultPosition, Size size=DefaultSize,
- long style=SL_HORIZONTAL, Validator validator=DefaultValidator,
+ <autodoc>Create(self, Window parent, int id=-1, int value=0, int minValue=0,
+ int maxValue=100, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=SL_HORIZONTAL,
+ Validator validator=DefaultValidator,
String name=SliderNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="value" type="int" default=""/>
- <param name="minValue" type="int" default=""/>
- <param name="maxValue" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="value" type="int" default="0"/>
+ <param name="minValue" type="int" default="0"/>
+ <param name="maxValue" type="int" default="100"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxSL_HORIZONTAL"/>
</paramlist>
</method>
<method name="GetValue" type="int" overloaded="no">
- <autodoc>GetValue() -> int</autodoc>
+ <autodoc>GetValue(self) -> int</autodoc>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(int value)</autodoc>
+ <autodoc>SetValue(self, int value)</autodoc>
<paramlist>
<param name="value" type="int" default=""/>
</paramlist>
</method>
<method name="SetRange" type="" overloaded="no">
- <autodoc>SetRange(int minValue, int maxValue)</autodoc>
+ <autodoc>SetRange(self, int minValue, int maxValue)</autodoc>
<paramlist>
<param name="minValue" type="int" default=""/>
<param name="maxValue" type="int" default=""/>
</paramlist>
</method>
<method name="GetMin" type="int" overloaded="no">
- <autodoc>GetMin() -> int</autodoc>
+ <autodoc>GetMin(self) -> int</autodoc>
</method>
<method name="GetMax" type="int" overloaded="no">
- <autodoc>GetMax() -> int</autodoc>
+ <autodoc>GetMax(self) -> int</autodoc>
</method>
<method name="SetMin" type="" overloaded="no">
- <autodoc>SetMin(int minValue)</autodoc>
+ <autodoc>SetMin(self, int minValue)</autodoc>
<paramlist>
<param name="minValue" type="int" default=""/>
</paramlist>
</method>
<method name="SetMax" type="" overloaded="no">
- <autodoc>SetMax(int maxValue)</autodoc>
+ <autodoc>SetMax(self, int maxValue)</autodoc>
<paramlist>
<param name="maxValue" type="int" default=""/>
</paramlist>
</method>
<method name="SetLineSize" type="" overloaded="no">
- <autodoc>SetLineSize(int lineSize)</autodoc>
+ <autodoc>SetLineSize(self, int lineSize)</autodoc>
<paramlist>
<param name="lineSize" type="int" default=""/>
</paramlist>
</method>
<method name="SetPageSize" type="" overloaded="no">
- <autodoc>SetPageSize(int pageSize)</autodoc>
+ <autodoc>SetPageSize(self, int pageSize)</autodoc>
<paramlist>
<param name="pageSize" type="int" default=""/>
</paramlist>
</method>
<method name="GetLineSize" type="int" overloaded="no">
- <autodoc>GetLineSize() -> int</autodoc>
+ <autodoc>GetLineSize(self) -> int</autodoc>
</method>
<method name="GetPageSize" type="int" overloaded="no">
- <autodoc>GetPageSize() -> int</autodoc>
+ <autodoc>GetPageSize(self) -> int</autodoc>
</method>
<method name="SetThumbLength" type="" overloaded="no">
- <autodoc>SetThumbLength(int lenPixels)</autodoc>
+ <autodoc>SetThumbLength(self, int lenPixels)</autodoc>
<paramlist>
<param name="lenPixels" type="int" default=""/>
</paramlist>
</method>
<method name="GetThumbLength" type="int" overloaded="no">
- <autodoc>GetThumbLength() -> int</autodoc>
+ <autodoc>GetThumbLength(self) -> int</autodoc>
</method>
<method name="SetTickFreq" type="" overloaded="no">
- <autodoc>SetTickFreq(int n, int pos=1)</autodoc>
+ <autodoc>SetTickFreq(self, int n, int pos=1)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
<param name="pos" type="int" default="1"/>
</paramlist>
</method>
<method name="GetTickFreq" type="int" overloaded="no">
- <autodoc>GetTickFreq() -> int</autodoc>
+ <autodoc>GetTickFreq(self) -> int</autodoc>
</method>
<method name="ClearTicks" type="" overloaded="no">
- <autodoc>ClearTicks()</autodoc>
+ <autodoc>ClearTicks(self)</autodoc>
</method>
<method name="SetTick" type="" overloaded="no">
- <autodoc>SetTick(int tickPos)</autodoc>
+ <autodoc>SetTick(self, int tickPos)</autodoc>
<paramlist>
<param name="tickPos" type="int" default=""/>
</paramlist>
</method>
<method name="ClearSel" type="" overloaded="no">
- <autodoc>ClearSel()</autodoc>
+ <autodoc>ClearSel(self)</autodoc>
</method>
<method name="GetSelEnd" type="int" overloaded="no">
- <autodoc>GetSelEnd() -> int</autodoc>
+ <autodoc>GetSelEnd(self) -> int</autodoc>
</method>
<method name="GetSelStart" type="int" overloaded="no">
- <autodoc>GetSelStart() -> int</autodoc>
+ <autodoc>GetSelStart(self) -> int</autodoc>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(int min, int max)</autodoc>
+ <autodoc>SetSelection(self, int min, int max)</autodoc>
<paramlist>
<param name="min" type="int" default=""/>
<param name="max" type="int" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
<pythoncode>
EVT_TOGGLEBUTTON = wx.PyEventBinder( wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, 1)
</pythoncode>
- <class name="ToggleButton" oldname="wxToggleButton" module="controls">
+ <class name="ToggleButton" oldname="wxToggleButton" module="_controls">
<baseclass name="Control"/>
<constructor name="ToggleButton" overloaded="no">
- <autodoc>__init__(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- Validator validator=DefaultValidator, String name=ToggleButtonNameStr) -> ToggleButton</autodoc>
+ <autodoc>__init__(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, Validator validator=DefaultValidator,
+ String name=ToggleButtonNameStr) -> ToggleButton</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<autodoc>PreToggleButton() -> ToggleButton</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=0,
- Validator validator=DefaultValidator, String name=ToggleButtonNameStr) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=0, Validator validator=DefaultValidator,
+ String name=ToggleButtonNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
</paramlist>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(bool value)</autodoc>
+ <autodoc>SetValue(self, bool value)</autodoc>
<paramlist>
<param name="value" type="bool" default=""/>
</paramlist>
</method>
<method name="GetValue" type="bool" overloaded="no">
- <autodoc>GetValue() -> bool</autodoc>
+ <autodoc>GetValue(self) -> bool</autodoc>
</method>
<method name="SetLabel" type="" overloaded="no">
- <autodoc>SetLabel(String label)</autodoc>
+ <autodoc>SetLabel(self, String label)</autodoc>
<docstring>Sets the item's text.</docstring>
<paramlist>
<param name="label" type="String" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="BookCtrl" oldname="wxBookCtrl" module="controls">
+ <class name="BookCtrl" oldname="wxBookCtrl" module="_controls">
<baseclass name="Control"/>
<method name="GetPageCount" type="size_t" overloaded="no">
- <autodoc>GetPageCount() -> size_t</autodoc>
+ <autodoc>GetPageCount(self) -> size_t</autodoc>
</method>
<method name="GetPage" type="Window" overloaded="no">
- <autodoc>GetPage(size_t n) -> Window</autodoc>
+ <autodoc>GetPage(self, size_t n) -> Window</autodoc>
<paramlist>
<param name="n" type="size_t" default=""/>
</paramlist>
</method>
<method name="GetSelection" type="int" overloaded="no">
- <autodoc>GetSelection() -> int</autodoc>
+ <autodoc>GetSelection(self) -> int</autodoc>
</method>
<method name="SetPageText" type="bool" overloaded="no">
- <autodoc>SetPageText(size_t n, String strText) -> bool</autodoc>
+ <autodoc>SetPageText(self, size_t n, String strText) -> bool</autodoc>
<paramlist>
<param name="n" type="size_t" default=""/>
<param name="strText" type="String" default=""/>
</paramlist>
</method>
<method name="GetPageText" type="String" overloaded="no">
- <autodoc>GetPageText(size_t n) -> String</autodoc>
+ <autodoc>GetPageText(self, size_t n) -> String</autodoc>
<paramlist>
<param name="n" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetImageList" type="" overloaded="no">
- <autodoc>SetImageList(ImageList imageList)</autodoc>
+ <autodoc>SetImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="AssignImageList" type="" overloaded="no">
- <autodoc>AssignImageList(ImageList imageList)</autodoc>
+ <autodoc>AssignImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="GetImageList" type="ImageList" overloaded="no">
- <autodoc>GetImageList() -> ImageList</autodoc>
+ <autodoc>GetImageList(self) -> ImageList</autodoc>
</method>
<method name="GetPageImage" type="int" overloaded="no">
- <autodoc>GetPageImage(size_t n) -> int</autodoc>
+ <autodoc>GetPageImage(self, size_t n) -> int</autodoc>
<paramlist>
<param name="n" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetPageImage" type="bool" overloaded="no">
- <autodoc>SetPageImage(size_t n, int imageId) -> bool</autodoc>
+ <autodoc>SetPageImage(self, size_t n, int imageId) -> bool</autodoc>
<paramlist>
<param name="n" type="size_t" default=""/>
<param name="imageId" type="int" default=""/>
</paramlist>
</method>
<method name="SetPageSize" type="" overloaded="no">
- <autodoc>SetPageSize(Size size)</autodoc>
+ <autodoc>SetPageSize(self, Size size)</autodoc>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="CalcSizeFromPage" type="Size" overloaded="no">
- <autodoc>CalcSizeFromPage(Size sizePage) -> Size</autodoc>
+ <autodoc>CalcSizeFromPage(self, Size sizePage) -> Size</autodoc>
<paramlist>
<param name="sizePage" type="Size" default=""/>
</paramlist>
</method>
<method name="DeletePage" type="bool" overloaded="no">
- <autodoc>DeletePage(size_t n) -> bool</autodoc>
+ <autodoc>DeletePage(self, size_t n) -> bool</autodoc>
<paramlist>
<param name="n" type="size_t" default=""/>
</paramlist>
</method>
<method name="RemovePage" type="bool" overloaded="no">
- <autodoc>RemovePage(size_t n) -> bool</autodoc>
+ <autodoc>RemovePage(self, size_t n) -> bool</autodoc>
<paramlist>
<param name="n" type="size_t" default=""/>
</paramlist>
</method>
<method name="DeleteAllPages" type="bool" overloaded="no">
- <autodoc>DeleteAllPages() -> bool</autodoc>
+ <autodoc>DeleteAllPages(self) -> bool</autodoc>
</method>
<method name="AddPage" type="bool" overloaded="no">
- <autodoc>AddPage(Window page, String text, bool select=False, int imageId=-1) -> bool</autodoc>
+ <autodoc>AddPage(self, Window page, String text, bool select=False, int imageId=-1) -> bool</autodoc>
<paramlist>
<param name="page" type="Window" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="InsertPage" type="bool" overloaded="no">
- <autodoc>InsertPage(size_t n, Window page, String text, bool select=False,
+ <autodoc>InsertPage(self, size_t n, Window page, String text, bool select=False,
int imageId=-1) -> bool</autodoc>
<paramlist>
<param name="n" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetSelection" type="int" overloaded="no">
- <autodoc>SetSelection(size_t n) -> int</autodoc>
+ <autodoc>SetSelection(self, size_t n) -> int</autodoc>
<paramlist>
<param name="n" type="size_t" default=""/>
</paramlist>
</method>
<method name="AdvanceSelection" type="" overloaded="no">
- <autodoc>AdvanceSelection(bool forward=True)</autodoc>
+ <autodoc>AdvanceSelection(self, bool forward=True)</autodoc>
<paramlist>
<param name="forward" type="bool" default="True"/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
- <class name="BookCtrlEvent" oldname="wxBookCtrlEvent" module="controls">
+ <class name="BookCtrlEvent" oldname="wxBookCtrlEvent" module="_controls">
<baseclass name="NotifyEvent"/>
<constructor name="BookCtrlEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1,
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1,
int nOldSel=-1) -> BookCtrlEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
</paramlist>
</constructor>
<method name="GetSelection" type="int" overloaded="no">
- <autodoc>GetSelection() -> int</autodoc>
+ <autodoc>GetSelection(self) -> int</autodoc>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(int nSel)</autodoc>
+ <autodoc>SetSelection(self, int nSel)</autodoc>
<paramlist>
<param name="nSel" type="int" default=""/>
</paramlist>
</method>
<method name="GetOldSelection" type="int" overloaded="no">
- <autodoc>GetOldSelection() -> int</autodoc>
+ <autodoc>GetOldSelection(self) -> int</autodoc>
</method>
<method name="SetOldSelection" type="" overloaded="no">
- <autodoc>SetOldSelection(int nOldSel)</autodoc>
+ <autodoc>SetOldSelection(self, int nOldSel)</autodoc>
<paramlist>
<param name="nOldSel" type="int" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Notebook" oldname="wxNotebook" module="controls">
+ <class name="Notebook" oldname="wxNotebook" module="_controls">
<baseclass name="BookCtrl"/>
<constructor name="Notebook" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=NOTEBOOK_NAME) -> Notebook</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<autodoc>PreNotebook() -> Notebook</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, String name=NOTEBOOK_NAME) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, String name=NOTEBOOK_NAME) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
</paramlist>
</method>
<method name="GetRowCount" type="int" overloaded="no">
- <autodoc>GetRowCount() -> int</autodoc>
+ <autodoc>GetRowCount(self) -> int</autodoc>
</method>
<method name="SetPadding" type="" overloaded="no">
- <autodoc>SetPadding(Size padding)</autodoc>
+ <autodoc>SetPadding(self, Size padding)</autodoc>
<paramlist>
<param name="padding" type="Size" default=""/>
</paramlist>
</method>
<method name="SetTabSize" type="" overloaded="no">
- <autodoc>SetTabSize(Size sz)</autodoc>
+ <autodoc>SetTabSize(self, Size sz)</autodoc>
<paramlist>
<param name="sz" type="Size" default=""/>
</paramlist>
</method>
<method name="HitTest" type="int" overloaded="no">
<autodoc>HitTest(Point pt) -> (tab, where)</autodoc>
- <docstring>Returns the tab which is hit, and flags indicating where using wx.NB_HITTEST_ flags.</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
<param name="OUTPUT" type="long" default=""/>
</paramlist>
</method>
<method name="CalcSizeFromPage" type="Size" overloaded="no">
- <autodoc>CalcSizeFromPage(Size sizePage) -> Size</autodoc>
+ <autodoc>CalcSizeFromPage(self, Size sizePage) -> Size</autodoc>
<paramlist>
<param name="sizePage" type="Size" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
- <class name="NotebookEvent" oldname="wxNotebookEvent" module="controls">
+ <class name="NotebookEvent" oldname="wxNotebookEvent" module="_controls">
<baseclass name="BookCtrlEvent"/>
<constructor name="NotebookEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1,
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1,
int nOldSel=-1) -> NotebookEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Listbook" oldname="wxListbook" module="controls">
+ <class name="Listbook" oldname="wxListbook" module="_controls">
<baseclass name="BookCtrl"/>
<constructor name="Listbook" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=EmptyString) -> Listbook</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<autodoc>PreListbook() -> Listbook</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, String name=EmptyString) -> bool</autodoc>
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, String name=EmptyString) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
</paramlist>
</method>
<method name="IsVertical" type="bool" overloaded="no">
- <autodoc>IsVertical() -> bool</autodoc>
+ <autodoc>IsVertical(self) -> bool</autodoc>
</method>
</class>
- <class name="ListbookEvent" oldname="wxListbookEvent" module="controls">
+ <class name="ListbookEvent" oldname="wxListbookEvent" module="_controls">
<baseclass name="BookCtrlEvent"/>
<constructor name="ListbookEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1,
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1,
int nOldSel=-1) -> ListbookEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="BookCtrlSizer" oldname="wxBookCtrlSizer" module="controls">
+ <class name="BookCtrlSizer" oldname="wxBookCtrlSizer" module="_controls">
<baseclass name="Sizer"/>
<constructor name="BookCtrlSizer" overloaded="no">
- <autodoc>__init__(BookCtrl nb) -> BookCtrlSizer</autodoc>
+ <autodoc>__init__(self, BookCtrl nb) -> BookCtrlSizer</autodoc>
<paramlist>
<param name="nb" type="BookCtrl" default=""/>
</paramlist>
</constructor>
<method name="RecalcSizes" type="" overloaded="no">
- <autodoc>RecalcSizes()</autodoc>
+ <autodoc>RecalcSizes(self)</autodoc>
+ <docstring>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`.</docstring>
</method>
<method name="CalcMin" type="Size" overloaded="no">
- <autodoc>CalcMin() -> Size</autodoc>
+ <autodoc>CalcMin(self) -> Size</autodoc>
+ <docstring>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`.</docstring>
</method>
<method name="GetControl" type="BookCtrl" overloaded="no">
- <autodoc>GetControl() -> BookCtrl</autodoc>
+ <autodoc>GetControl(self) -> BookCtrl</autodoc>
</method>
</class>
- <class name="NotebookSizer" oldname="wxNotebookSizer" module="controls">
+ <class name="NotebookSizer" oldname="wxNotebookSizer" module="_controls">
<baseclass name="Sizer"/>
<constructor name="NotebookSizer" overloaded="no">
- <autodoc>__init__(Notebook nb) -> NotebookSizer</autodoc>
+ <autodoc>__init__(self, Notebook nb) -> NotebookSizer</autodoc>
<paramlist>
<param name="nb" type="Notebook" default=""/>
</paramlist>
</constructor>
<method name="RecalcSizes" type="" overloaded="no">
- <autodoc>RecalcSizes()</autodoc>
+ <autodoc>RecalcSizes(self)</autodoc>
+ <docstring>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`.</docstring>
</method>
<method name="CalcMin" type="Size" overloaded="no">
- <autodoc>CalcMin() -> Size</autodoc>
+ <autodoc>CalcMin(self) -> Size</autodoc>
+ <docstring>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`.</docstring>
</method>
<method name="GetNotebook" type="Notebook" overloaded="no">
- <autodoc>GetNotebook() -> Notebook</autodoc>
+ <autodoc>GetNotebook(self) -> Notebook</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ToolBarToolBase" oldname="wxToolBarToolBase" module="controls">
+ <class name="ToolBarToolBase" oldname="wxToolBarToolBase" module="_controls">
<baseclass name="Object"/>
<method name="GetId" type="int" overloaded="no">
- <autodoc>GetId() -> int</autodoc>
+ <autodoc>GetId(self) -> int</autodoc>
</method>
<method name="GetControl" type="Control" overloaded="no">
- <autodoc>GetControl() -> Control</autodoc>
+ <autodoc>GetControl(self) -> Control</autodoc>
</method>
<method name="GetToolBar" type="wxToolBarBase" overloaded="no">
- <autodoc>GetToolBar() -> ToolBarBase</autodoc>
+ <autodoc>GetToolBar(self) -> ToolBarBase</autodoc>
</method>
<method name="IsButton" type="int" overloaded="no">
- <autodoc>IsButton() -> int</autodoc>
+ <autodoc>IsButton(self) -> int</autodoc>
</method>
<method name="IsControl" type="int" overloaded="no">
- <autodoc>IsControl() -> int</autodoc>
+ <autodoc>IsControl(self) -> int</autodoc>
</method>
<method name="IsSeparator" type="int" overloaded="no">
- <autodoc>IsSeparator() -> int</autodoc>
+ <autodoc>IsSeparator(self) -> int</autodoc>
</method>
<method name="GetStyle" type="int" overloaded="no">
- <autodoc>GetStyle() -> int</autodoc>
+ <autodoc>GetStyle(self) -> int</autodoc>
</method>
<method name="GetKind" type="wxItemKind" overloaded="no">
- <autodoc>GetKind() -> int</autodoc>
+ <autodoc>GetKind(self) -> int</autodoc>
</method>
<method name="IsEnabled" type="bool" overloaded="no">
- <autodoc>IsEnabled() -> bool</autodoc>
+ <autodoc>IsEnabled(self) -> bool</autodoc>
</method>
<method name="IsToggled" type="bool" overloaded="no">
- <autodoc>IsToggled() -> bool</autodoc>
+ <autodoc>IsToggled(self) -> bool</autodoc>
</method>
<method name="CanBeToggled" type="bool" overloaded="no">
- <autodoc>CanBeToggled() -> bool</autodoc>
+ <autodoc>CanBeToggled(self) -> bool</autodoc>
</method>
<method name="GetNormalBitmap" type="Bitmap" overloaded="no">
- <autodoc>GetNormalBitmap() -> Bitmap</autodoc>
+ <autodoc>GetNormalBitmap(self) -> Bitmap</autodoc>
</method>
<method name="GetDisabledBitmap" type="Bitmap" overloaded="no">
- <autodoc>GetDisabledBitmap() -> Bitmap</autodoc>
+ <autodoc>GetDisabledBitmap(self) -> Bitmap</autodoc>
</method>
<method name="GetBitmap" type="Bitmap" overloaded="no">
- <autodoc>GetBitmap() -> Bitmap</autodoc>
+ <autodoc>GetBitmap(self) -> Bitmap</autodoc>
</method>
<method name="GetLabel" type="String" overloaded="no">
- <autodoc>GetLabel() -> String</autodoc>
+ <autodoc>GetLabel(self) -> String</autodoc>
</method>
<method name="GetShortHelp" type="String" overloaded="no">
- <autodoc>GetShortHelp() -> String</autodoc>
+ <autodoc>GetShortHelp(self) -> String</autodoc>
</method>
<method name="GetLongHelp" type="String" overloaded="no">
- <autodoc>GetLongHelp() -> String</autodoc>
+ <autodoc>GetLongHelp(self) -> String</autodoc>
</method>
<method name="Enable" type="bool" overloaded="no">
- <autodoc>Enable(bool enable) -> bool</autodoc>
+ <autodoc>Enable(self, bool enable) -> bool</autodoc>
<paramlist>
<param name="enable" type="bool" default=""/>
</paramlist>
</method>
<method name="Toggle" type="" overloaded="no">
- <autodoc>Toggle()</autodoc>
+ <autodoc>Toggle(self)</autodoc>
</method>
<method name="SetToggle" type="bool" overloaded="no">
- <autodoc>SetToggle(bool toggle) -> bool</autodoc>
+ <autodoc>SetToggle(self, bool toggle) -> bool</autodoc>
<paramlist>
<param name="toggle" type="bool" default=""/>
</paramlist>
</method>
<method name="SetShortHelp" type="bool" overloaded="no">
- <autodoc>SetShortHelp(String help) -> bool</autodoc>
+ <autodoc>SetShortHelp(self, String help) -> bool</autodoc>
<paramlist>
<param name="help" type="String" default=""/>
</paramlist>
</method>
<method name="SetLongHelp" type="bool" overloaded="no">
- <autodoc>SetLongHelp(String help) -> bool</autodoc>
+ <autodoc>SetLongHelp(self, String help) -> bool</autodoc>
<paramlist>
<param name="help" type="String" default=""/>
</paramlist>
</method>
<method name="SetNormalBitmap" type="" overloaded="no">
- <autodoc>SetNormalBitmap(Bitmap bmp)</autodoc>
+ <autodoc>SetNormalBitmap(self, Bitmap bmp)</autodoc>
<paramlist>
<param name="bmp" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="SetDisabledBitmap" type="" overloaded="no">
- <autodoc>SetDisabledBitmap(Bitmap bmp)</autodoc>
+ <autodoc>SetDisabledBitmap(self, Bitmap bmp)</autodoc>
<paramlist>
<param name="bmp" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="SetLabel" type="" overloaded="no">
- <autodoc>SetLabel(String label)</autodoc>
+ <autodoc>SetLabel(self, String label)</autodoc>
<paramlist>
<param name="label" type="String" default=""/>
</paramlist>
</method>
<method name="Detach" type="" overloaded="no">
- <autodoc>Detach()</autodoc>
+ <autodoc>Detach(self)</autodoc>
</method>
<method name="Attach" type="" overloaded="no">
- <autodoc>Attach(ToolBarBase tbar)</autodoc>
+ <autodoc>Attach(self, ToolBarBase tbar)</autodoc>
<paramlist>
<param name="tbar" type="wxToolBarBase" default=""/>
</paramlist>
</method>
<method name="GetClientData" type="PyObject" overloaded="no">
- <autodoc>GetClientData() -> PyObject</autodoc>
+ <autodoc>GetClientData(self) -> PyObject</autodoc>
</method>
<method name="SetClientData" type="" overloaded="no">
- <autodoc>SetClientData(PyObject clientData)</autodoc>
+ <autodoc>SetClientData(self, PyObject clientData)</autodoc>
<paramlist>
<param name="clientData" type="PyObject" default=""/>
</paramlist>
</method>
</class>
- <class name="ToolBarBase" oldname="wxToolBarBase" module="controls">
+ <class name="ToolBarBase" oldname="wxToolBarBase" module="_controls">
<baseclass name="Control"/>
<method name="DoAddTool" type="ToolBarToolBase" overloaded="no">
- <autodoc>DoAddTool(int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap,
+ <autodoc>DoAddTool(self, int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap,
int kind=ITEM_NORMAL, String shortHelp=EmptyString,
String longHelp=EmptyString,
PyObject clientData=None) -> ToolBarToolBase</autodoc>
</paramlist>
</method>
<method name="DoInsertTool" type="ToolBarToolBase" overloaded="no">
- <autodoc>DoInsertTool(size_t pos, int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap,
+ <autodoc>DoInsertTool(self, size_t pos, int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap,
int kind=ITEM_NORMAL,
String shortHelp=EmptyString, String longHelp=EmptyString,
PyObject clientData=None) -> ToolBarToolBase</autodoc>
</paramlist>
</method>
<method name="AddToolItem" type="ToolBarToolBase" overloaded="no">
- <autodoc>AddToolItem(ToolBarToolBase tool) -> ToolBarToolBase</autodoc>
+ <autodoc>AddToolItem(self, ToolBarToolBase tool) -> ToolBarToolBase</autodoc>
<paramlist>
<param name="tool" type="ToolBarToolBase" default=""/>
</paramlist>
</method>
<method name="InsertToolItem" type="ToolBarToolBase" overloaded="no">
- <autodoc>InsertToolItem(size_t pos, ToolBarToolBase tool) -> ToolBarToolBase</autodoc>
+ <autodoc>InsertToolItem(self, size_t pos, ToolBarToolBase tool) -> ToolBarToolBase</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="tool" type="ToolBarToolBase" default=""/>
</paramlist>
</method>
<method name="AddControl" type="ToolBarToolBase" overloaded="no">
- <autodoc>AddControl(Control control) -> ToolBarToolBase</autodoc>
+ <autodoc>AddControl(self, Control control) -> ToolBarToolBase</autodoc>
<paramlist>
<param name="control" type="Control" default=""/>
</paramlist>
</method>
<method name="InsertControl" type="ToolBarToolBase" overloaded="no">
- <autodoc>InsertControl(size_t pos, Control control) -> ToolBarToolBase</autodoc>
+ <autodoc>InsertControl(self, size_t pos, Control control) -> ToolBarToolBase</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="control" type="Control" default=""/>
</paramlist>
</method>
<method name="FindControl" type="Control" overloaded="no">
- <autodoc>FindControl(int id) -> Control</autodoc>
+ <autodoc>FindControl(self, int id) -> Control</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="AddSeparator" type="ToolBarToolBase" overloaded="no">
- <autodoc>AddSeparator() -> ToolBarToolBase</autodoc>
+ <autodoc>AddSeparator(self) -> ToolBarToolBase</autodoc>
</method>
<method name="InsertSeparator" type="ToolBarToolBase" overloaded="no">
- <autodoc>InsertSeparator(size_t pos) -> ToolBarToolBase</autodoc>
+ <autodoc>InsertSeparator(self, size_t pos) -> ToolBarToolBase</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
</paramlist>
</method>
<method name="RemoveTool" type="ToolBarToolBase" overloaded="no">
- <autodoc>RemoveTool(int id) -> ToolBarToolBase</autodoc>
+ <autodoc>RemoveTool(self, int id) -> ToolBarToolBase</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="DeleteToolByPos" type="bool" overloaded="no">
- <autodoc>DeleteToolByPos(size_t pos) -> bool</autodoc>
+ <autodoc>DeleteToolByPos(self, size_t pos) -> bool</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
</paramlist>
</method>
<method name="DeleteTool" type="bool" overloaded="no">
- <autodoc>DeleteTool(int id) -> bool</autodoc>
+ <autodoc>DeleteTool(self, int id) -> bool</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="ClearTools" type="" overloaded="no">
- <autodoc>ClearTools()</autodoc>
+ <autodoc>ClearTools(self)</autodoc>
</method>
<method name="Realize" type="bool" overloaded="no">
- <autodoc>Realize() -> bool</autodoc>
+ <autodoc>Realize(self) -> bool</autodoc>
</method>
<method name="EnableTool" type="" overloaded="no">
- <autodoc>EnableTool(int id, bool enable)</autodoc>
+ <autodoc>EnableTool(self, int id, bool enable)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="enable" type="bool" default=""/>
</paramlist>
</method>
<method name="ToggleTool" type="" overloaded="no">
- <autodoc>ToggleTool(int id, bool toggle)</autodoc>
+ <autodoc>ToggleTool(self, int id, bool toggle)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="toggle" type="bool" default=""/>
</paramlist>
</method>
<method name="SetToggle" type="" overloaded="no">
- <autodoc>SetToggle(int id, bool toggle)</autodoc>
+ <autodoc>SetToggle(self, int id, bool toggle)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="toggle" type="bool" default=""/>
</paramlist>
</method>
<method name="GetToolClientData" type="PyObject" overloaded="no">
- <autodoc>GetToolClientData(int id) -> PyObject</autodoc>
+ <autodoc>GetToolClientData(self, int id) -> PyObject</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="SetToolClientData" type="" overloaded="no">
- <autodoc>SetToolClientData(int id, PyObject clientData)</autodoc>
+ <autodoc>SetToolClientData(self, int id, PyObject clientData)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="clientData" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetToolPos" type="int" overloaded="no">
- <autodoc>GetToolPos(int id) -> int</autodoc>
+ <autodoc>GetToolPos(self, int id) -> int</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="GetToolState" type="bool" overloaded="no">
- <autodoc>GetToolState(int id) -> bool</autodoc>
+ <autodoc>GetToolState(self, int id) -> bool</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="GetToolEnabled" type="bool" overloaded="no">
- <autodoc>GetToolEnabled(int id) -> bool</autodoc>
+ <autodoc>GetToolEnabled(self, int id) -> bool</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="SetToolShortHelp" type="" overloaded="no">
- <autodoc>SetToolShortHelp(int id, String helpString)</autodoc>
+ <autodoc>SetToolShortHelp(self, int id, String helpString)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="helpString" type="String" default=""/>
</paramlist>
</method>
<method name="GetToolShortHelp" type="String" overloaded="no">
- <autodoc>GetToolShortHelp(int id) -> String</autodoc>
+ <autodoc>GetToolShortHelp(self, int id) -> String</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="SetToolLongHelp" type="" overloaded="no">
- <autodoc>SetToolLongHelp(int id, String helpString)</autodoc>
+ <autodoc>SetToolLongHelp(self, int id, String helpString)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
<param name="helpString" type="String" default=""/>
</paramlist>
</method>
<method name="GetToolLongHelp" type="String" overloaded="no">
- <autodoc>GetToolLongHelp(int id) -> String</autodoc>
+ <autodoc>GetToolLongHelp(self, int id) -> String</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="SetMarginsXY" type="" overloaded="no">
- <autodoc>SetMarginsXY(int x, int y)</autodoc>
+ <autodoc>SetMarginsXY(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="SetMargins" type="" overloaded="no">
- <autodoc>SetMargins(Size size)</autodoc>
+ <autodoc>SetMargins(self, Size size)</autodoc>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="SetToolPacking" type="" overloaded="no">
- <autodoc>SetToolPacking(int packing)</autodoc>
+ <autodoc>SetToolPacking(self, int packing)</autodoc>
<paramlist>
<param name="packing" type="int" default=""/>
</paramlist>
</method>
<method name="SetToolSeparation" type="" overloaded="no">
- <autodoc>SetToolSeparation(int separation)</autodoc>
+ <autodoc>SetToolSeparation(self, int separation)</autodoc>
<paramlist>
<param name="separation" type="int" default=""/>
</paramlist>
</method>
<method name="GetToolMargins" type="Size" overloaded="no">
- <autodoc>GetToolMargins() -> Size</autodoc>
+ <autodoc>GetToolMargins(self) -> Size</autodoc>
</method>
<method name="GetMargins" type="Size" overloaded="no">
- <autodoc>GetMargins() -> Size</autodoc>
+ <autodoc>GetMargins(self) -> Size</autodoc>
</method>
<method name="GetToolPacking" type="int" overloaded="no">
- <autodoc>GetToolPacking() -> int</autodoc>
+ <autodoc>GetToolPacking(self) -> int</autodoc>
</method>
<method name="GetToolSeparation" type="int" overloaded="no">
- <autodoc>GetToolSeparation() -> int</autodoc>
+ <autodoc>GetToolSeparation(self) -> int</autodoc>
</method>
<method name="SetRows" type="" overloaded="no">
- <autodoc>SetRows(int nRows)</autodoc>
+ <autodoc>SetRows(self, int nRows)</autodoc>
<paramlist>
<param name="nRows" type="int" default=""/>
</paramlist>
</method>
<method name="SetMaxRowsCols" type="" overloaded="no">
- <autodoc>SetMaxRowsCols(int rows, int cols)</autodoc>
+ <autodoc>SetMaxRowsCols(self, int rows, int cols)</autodoc>
<paramlist>
<param name="rows" type="int" default=""/>
<param name="cols" type="int" default=""/>
</paramlist>
</method>
<method name="GetMaxRows" type="int" overloaded="no">
- <autodoc>GetMaxRows() -> int</autodoc>
+ <autodoc>GetMaxRows(self) -> int</autodoc>
</method>
<method name="GetMaxCols" type="int" overloaded="no">
- <autodoc>GetMaxCols() -> int</autodoc>
+ <autodoc>GetMaxCols(self) -> int</autodoc>
</method>
<method name="SetToolBitmapSize" type="" overloaded="no">
- <autodoc>SetToolBitmapSize(Size size)</autodoc>
+ <autodoc>SetToolBitmapSize(self, Size size)</autodoc>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="GetToolBitmapSize" type="Size" overloaded="no">
- <autodoc>GetToolBitmapSize() -> Size</autodoc>
+ <autodoc>GetToolBitmapSize(self) -> Size</autodoc>
</method>
<method name="GetToolSize" type="Size" overloaded="no">
- <autodoc>GetToolSize() -> Size</autodoc>
+ <autodoc>GetToolSize(self) -> Size</autodoc>
</method>
<method name="FindToolForPosition" type="ToolBarToolBase" overloaded="no">
- <autodoc>FindToolForPosition(int x, int y) -> ToolBarToolBase</autodoc>
+ <autodoc>FindToolForPosition(self, int x, int y) -> ToolBarToolBase</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="FindById" type="ToolBarToolBase" overloaded="no">
- <autodoc>FindById(int toolid) -> ToolBarToolBase</autodoc>
+ <autodoc>FindById(self, int toolid) -> ToolBarToolBase</autodoc>
<paramlist>
<param name="toolid" type="int" default=""/>
</paramlist>
</method>
<method name="IsVertical" type="bool" overloaded="no">
- <autodoc>IsVertical() -> bool</autodoc>
+ <autodoc>IsVertical(self) -> bool</autodoc>
</method>
</class>
- <class name="ToolBar" oldname="wxToolBar" module="controls">
+ <class name="ToolBar" oldname="wxToolBar" module="_controls">
<baseclass name="ToolBarBase"/>
<constructor name="ToolBar" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=wxNO_BORDER|wxTB_HORIZONTAL,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL,
String name=wxPyToolBarNameStr) -> ToolBar</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxNO_BORDER|wxTB_HORIZONTAL"/>
<autodoc>PreToolBar() -> ToolBar</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=wxNO_BORDER|wxTB_HORIZONTAL,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL,
String name=wxPyToolBarNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxNO_BORDER|wxTB_HORIZONTAL"/>
</paramlist>
</method>
<method name="FindToolForPosition" type="ToolBarToolBase" overloaded="no">
- <autodoc>FindToolForPosition(int x, int y) -> ToolBarToolBase</autodoc>
+ <autodoc>FindToolForPosition(self, int x, int y) -> ToolBarToolBase</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ListItemAttr" oldname="wxListItemAttr" module="controls">
+ <class name="ListItemAttr" oldname="wxListItemAttr" module="_controls">
<constructor name="ListItemAttr" overloaded="no">
- <autodoc>__init__(Colour colText=wxNullColour, Colour colBack=wxNullColour,
+ <autodoc>__init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour,
Font font=wxNullFont) -> ListItemAttr</autodoc>
<paramlist>
<param name="colText" type="Colour" default="wxNullColour"/>
</paramlist>
</constructor>
<method name="SetTextColour" type="" overloaded="no">
- <autodoc>SetTextColour(Colour colText)</autodoc>
+ <autodoc>SetTextColour(self, Colour colText)</autodoc>
<paramlist>
<param name="colText" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetBackgroundColour" type="" overloaded="no">
- <autodoc>SetBackgroundColour(Colour colBack)</autodoc>
+ <autodoc>SetBackgroundColour(self, Colour colBack)</autodoc>
<paramlist>
<param name="colBack" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetFont" type="" overloaded="no">
- <autodoc>SetFont(Font font)</autodoc>
+ <autodoc>SetFont(self, Font font)</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="HasTextColour" type="bool" overloaded="no">
- <autodoc>HasTextColour() -> bool</autodoc>
+ <autodoc>HasTextColour(self) -> bool</autodoc>
</method>
<method name="HasBackgroundColour" type="bool" overloaded="no">
- <autodoc>HasBackgroundColour() -> bool</autodoc>
+ <autodoc>HasBackgroundColour(self) -> bool</autodoc>
</method>
<method name="HasFont" type="bool" overloaded="no">
- <autodoc>HasFont() -> bool</autodoc>
+ <autodoc>HasFont(self) -> bool</autodoc>
</method>
<method name="GetTextColour" type="Colour" overloaded="no">
- <autodoc>GetTextColour() -> Colour</autodoc>
+ <autodoc>GetTextColour(self) -> Colour</autodoc>
</method>
<method name="GetBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetBackgroundColour() -> Colour</autodoc>
+ <autodoc>GetBackgroundColour(self) -> Colour</autodoc>
</method>
<method name="GetFont" type="Font" overloaded="no">
- <autodoc>GetFont() -> Font</autodoc>
+ <autodoc>GetFont(self) -> Font</autodoc>
</method>
<method name="Destroy" type="" overloaded="no">
- <autodoc>Destroy()</autodoc>
+ <autodoc>Destroy(self)</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ListItem" oldname="wxListItem" module="controls">
+ <class name="ListItem" oldname="wxListItem" module="_controls">
<baseclass name="Object"/>
<constructor name="ListItem" overloaded="no">
- <autodoc>__init__() -> ListItem</autodoc>
+ <autodoc>__init__(self) -> ListItem</autodoc>
</constructor>
<destructor name="~wxListItem" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear()</autodoc>
+ <autodoc>Clear(self)</autodoc>
</method>
<method name="ClearAttributes" type="" overloaded="no">
- <autodoc>ClearAttributes()</autodoc>
+ <autodoc>ClearAttributes(self)</autodoc>
</method>
<method name="SetMask" type="" overloaded="no">
- <autodoc>SetMask(long mask)</autodoc>
+ <autodoc>SetMask(self, long mask)</autodoc>
<paramlist>
<param name="mask" type="long" default=""/>
</paramlist>
</method>
<method name="SetId" type="" overloaded="no">
- <autodoc>SetId(long id)</autodoc>
+ <autodoc>SetId(self, long id)</autodoc>
<paramlist>
<param name="id" type="long" default=""/>
</paramlist>
</method>
<method name="SetColumn" type="" overloaded="no">
- <autodoc>SetColumn(int col)</autodoc>
+ <autodoc>SetColumn(self, int col)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetState" type="" overloaded="no">
- <autodoc>SetState(long state)</autodoc>
+ <autodoc>SetState(self, long state)</autodoc>
<paramlist>
<param name="state" type="long" default=""/>
</paramlist>
</method>
<method name="SetStateMask" type="" overloaded="no">
- <autodoc>SetStateMask(long stateMask)</autodoc>
+ <autodoc>SetStateMask(self, long stateMask)</autodoc>
<paramlist>
<param name="stateMask" type="long" default=""/>
</paramlist>
</method>
<method name="SetText" type="" overloaded="no">
- <autodoc>SetText(String text)</autodoc>
+ <autodoc>SetText(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SetImage" type="" overloaded="no">
- <autodoc>SetImage(int image)</autodoc>
+ <autodoc>SetImage(self, int image)</autodoc>
<paramlist>
<param name="image" type="int" default=""/>
</paramlist>
</method>
<method name="SetData" type="" overloaded="no">
- <autodoc>SetData(long data)</autodoc>
+ <autodoc>SetData(self, long data)</autodoc>
<paramlist>
<param name="data" type="long" default=""/>
</paramlist>
</method>
<method name="SetWidth" type="" overloaded="no">
- <autodoc>SetWidth(int width)</autodoc>
+ <autodoc>SetWidth(self, int width)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="SetAlign" type="" overloaded="no">
- <autodoc>SetAlign(int align)</autodoc>
+ <autodoc>SetAlign(self, int align)</autodoc>
<paramlist>
<param name="align" type="wxListColumnFormat" default=""/>
</paramlist>
</method>
<method name="SetTextColour" type="" overloaded="no">
- <autodoc>SetTextColour(Colour colText)</autodoc>
+ <autodoc>SetTextColour(self, Colour colText)</autodoc>
<paramlist>
<param name="colText" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetBackgroundColour" type="" overloaded="no">
- <autodoc>SetBackgroundColour(Colour colBack)</autodoc>
+ <autodoc>SetBackgroundColour(self, Colour colBack)</autodoc>
<paramlist>
<param name="colBack" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetFont" type="" overloaded="no">
- <autodoc>SetFont(Font font)</autodoc>
+ <autodoc>SetFont(self, Font font)</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="GetMask" type="long" overloaded="no">
- <autodoc>GetMask() -> long</autodoc>
+ <autodoc>GetMask(self) -> long</autodoc>
</method>
<method name="GetId" type="long" overloaded="no">
- <autodoc>GetId() -> long</autodoc>
+ <autodoc>GetId(self) -> long</autodoc>
</method>
<method name="GetColumn" type="int" overloaded="no">
- <autodoc>GetColumn() -> int</autodoc>
+ <autodoc>GetColumn(self) -> int</autodoc>
</method>
<method name="GetState" type="long" overloaded="no">
- <autodoc>GetState() -> long</autodoc>
+ <autodoc>GetState(self) -> long</autodoc>
</method>
<method name="GetText" type="String" overloaded="no">
- <autodoc>GetText() -> String</autodoc>
+ <autodoc>GetText(self) -> String</autodoc>
</method>
<method name="GetImage" type="int" overloaded="no">
- <autodoc>GetImage() -> int</autodoc>
+ <autodoc>GetImage(self) -> int</autodoc>
</method>
<method name="GetData" type="long" overloaded="no">
- <autodoc>GetData() -> long</autodoc>
+ <autodoc>GetData(self) -> long</autodoc>
</method>
<method name="GetWidth" type="int" overloaded="no">
- <autodoc>GetWidth() -> int</autodoc>
+ <autodoc>GetWidth(self) -> int</autodoc>
</method>
<method name="GetAlign" type="wxListColumnFormat" overloaded="no">
- <autodoc>GetAlign() -> int</autodoc>
+ <autodoc>GetAlign(self) -> int</autodoc>
</method>
<method name="GetAttributes" type="ListItemAttr" overloaded="no">
- <autodoc>GetAttributes() -> ListItemAttr</autodoc>
+ <autodoc>GetAttributes(self) -> ListItemAttr</autodoc>
</method>
<method name="HasAttributes" type="bool" overloaded="no">
- <autodoc>HasAttributes() -> bool</autodoc>
+ <autodoc>HasAttributes(self) -> bool</autodoc>
</method>
<method name="GetTextColour" type="Colour" overloaded="no">
- <autodoc>GetTextColour() -> Colour</autodoc>
+ <autodoc>GetTextColour(self) -> Colour</autodoc>
</method>
<method name="GetBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetBackgroundColour() -> Colour</autodoc>
+ <autodoc>GetBackgroundColour(self) -> Colour</autodoc>
</method>
<method name="GetFont" type="Font" overloaded="no">
- <autodoc>GetFont() -> Font</autodoc>
+ <autodoc>GetFont(self) -> Font</autodoc>
</method>
<property name="m_mask" type="long" readonly="no"/>
<property name="m_itemId" type="long" readonly="no"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ListEvent" oldname="wxListEvent" module="controls">
+ <class name="ListEvent" oldname="wxListEvent" module="_controls">
<baseclass name="NotifyEvent"/>
<constructor name="ListEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int id=0) -> ListEvent</autodoc>
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> ListEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
<param name="id" type="int" default="0"/>
<property name="m_pointDrag" type="Point" readonly="no"/>
<property name="m_item" type="ListItem" readonly="yes"/>
<method name="GetKeyCode" type="int" overloaded="no">
- <autodoc>GetKeyCode() -> int</autodoc>
+ <autodoc>GetKeyCode(self) -> int</autodoc>
</method>
<method name="GetIndex" type="long" overloaded="no">
- <autodoc>GetIndex() -> long</autodoc>
+ <autodoc>GetIndex(self) -> long</autodoc>
</method>
<method name="GetColumn" type="int" overloaded="no">
- <autodoc>GetColumn() -> int</autodoc>
+ <autodoc>GetColumn(self) -> int</autodoc>
</method>
<method name="GetPoint" type="Point" overloaded="no">
- <autodoc>GetPoint() -> Point</autodoc>
+ <autodoc>GetPoint(self) -> Point</autodoc>
</method>
<method name="GetLabel" type="String" overloaded="no">
- <autodoc>GetLabel() -> String</autodoc>
+ <autodoc>GetLabel(self) -> String</autodoc>
</method>
<method name="GetText" type="String" overloaded="no">
- <autodoc>GetText() -> String</autodoc>
+ <autodoc>GetText(self) -> String</autodoc>
</method>
<method name="GetImage" type="int" overloaded="no">
- <autodoc>GetImage() -> int</autodoc>
+ <autodoc>GetImage(self) -> int</autodoc>
</method>
<method name="GetData" type="long" overloaded="no">
- <autodoc>GetData() -> long</autodoc>
+ <autodoc>GetData(self) -> long</autodoc>
</method>
<method name="GetMask" type="long" overloaded="no">
- <autodoc>GetMask() -> long</autodoc>
+ <autodoc>GetMask(self) -> long</autodoc>
</method>
<method name="GetItem" type="ListItem" overloaded="no">
- <autodoc>GetItem() -> ListItem</autodoc>
+ <autodoc>GetItem(self) -> ListItem</autodoc>
</method>
<method name="GetCacheFrom" type="long" overloaded="no">
- <autodoc>GetCacheFrom() -> long</autodoc>
+ <autodoc>GetCacheFrom(self) -> long</autodoc>
</method>
<method name="GetCacheTo" type="long" overloaded="no">
- <autodoc>GetCacheTo() -> long</autodoc>
+ <autodoc>GetCacheTo(self) -> long</autodoc>
</method>
<method name="IsEditCancelled" type="bool" overloaded="no">
- <autodoc>IsEditCancelled() -> bool</autodoc>
+ <autodoc>IsEditCancelled(self) -> bool</autodoc>
</method>
<method name="SetEditCanceled" type="" overloaded="no">
- <autodoc>SetEditCanceled(bool editCancelled)</autodoc>
+ <autodoc>SetEditCanceled(self, bool editCancelled)</autodoc>
<paramlist>
<param name="editCancelled" type="bool" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ListCtrl" oldname="wxPyListCtrl" module="controls">
+ <class name="ListCtrl" oldname="wxPyListCtrl" module="_controls">
<baseclass name="Control"/>
<constructor name="wxPyListCtrl" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=LC_ICON,
Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListCtrl</autodoc>
<paramlist>
<autodoc>PreListCtrl() -> ListCtrl</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=LC_ICON,
Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool</autodoc>
<docstring>Do the 2nd phase and create the GUI control.</docstring>
</paramlist>
</method>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetForegroundColour" type="bool" overloaded="no">
- <autodoc>SetForegroundColour(Colour col) -> bool</autodoc>
+ <autodoc>SetForegroundColour(self, Colour col) -> bool</autodoc>
<paramlist>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetBackgroundColour" type="bool" overloaded="no">
- <autodoc>SetBackgroundColour(Colour col) -> bool</autodoc>
+ <autodoc>SetBackgroundColour(self, Colour col) -> bool</autodoc>
<paramlist>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetColumn" type="ListItem" overloaded="no">
- <autodoc>GetColumn(int col) -> ListItem</autodoc>
+ <autodoc>GetColumn(self, int col) -> ListItem</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetColumn" type="bool" overloaded="no">
- <autodoc>SetColumn(int col, ListItem item) -> bool</autodoc>
+ <autodoc>SetColumn(self, int col, ListItem item) -> bool</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="item" type="ListItem" default=""/>
</paramlist>
</method>
<method name="GetColumnWidth" type="int" overloaded="no">
- <autodoc>GetColumnWidth(int col) -> int</autodoc>
+ <autodoc>GetColumnWidth(self, int col) -> int</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetColumnWidth" type="bool" overloaded="no">
- <autodoc>SetColumnWidth(int col, int width) -> bool</autodoc>
+ <autodoc>SetColumnWidth(self, int col, int width) -> bool</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="GetCountPerPage" type="int" overloaded="no">
- <autodoc>GetCountPerPage() -> int</autodoc>
+ <autodoc>GetCountPerPage(self) -> int</autodoc>
</method>
<method name="GetViewRect" type="Rect" overloaded="no">
- <autodoc>GetViewRect() -> Rect</autodoc>
+ <autodoc>GetViewRect(self) -> Rect</autodoc>
</method>
<method name="GetItem" type="ListItem" overloaded="no">
- <autodoc>GetItem(long itemId, int col=0) -> ListItem</autodoc>
+ <autodoc>GetItem(self, long itemId, int col=0) -> ListItem</autodoc>
<paramlist>
<param name="itemId" type="long" default=""/>
<param name="col" type="int" default="0"/>
</paramlist>
</method>
<method name="SetItem" type="bool" overloaded="no">
- <autodoc>SetItem(ListItem info) -> bool</autodoc>
+ <autodoc>SetItem(self, ListItem info) -> bool</autodoc>
<paramlist>
<param name="info" type="ListItem" default=""/>
</paramlist>
</method>
<method name="SetStringItem" type="long" overloaded="no">
- <autodoc>SetStringItem(long index, int col, String label, int imageId=-1) -> long</autodoc>
+ <autodoc>SetStringItem(self, long index, int col, String label, int imageId=-1) -> long</autodoc>
<paramlist>
<param name="index" type="long" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetItemState" type="int" overloaded="no">
- <autodoc>GetItemState(long item, long stateMask) -> int</autodoc>
+ <autodoc>GetItemState(self, long item, long stateMask) -> int</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
<param name="stateMask" type="long" default=""/>
</paramlist>
</method>
<method name="SetItemState" type="bool" overloaded="no">
- <autodoc>SetItemState(long item, long state, long stateMask) -> bool</autodoc>
+ <autodoc>SetItemState(self, long item, long state, long stateMask) -> bool</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
<param name="state" type="long" default=""/>
</paramlist>
</method>
<method name="SetItemImage" type="bool" overloaded="no">
- <autodoc>SetItemImage(long item, int image, int selImage) -> bool</autodoc>
+ <autodoc>SetItemImage(self, long item, int image, int selImage) -> bool</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
<param name="image" type="int" default=""/>
</paramlist>
</method>
<method name="GetItemText" type="String" overloaded="no">
- <autodoc>GetItemText(long item) -> String</autodoc>
+ <autodoc>GetItemText(self, long item) -> String</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
</paramlist>
</method>
<method name="SetItemText" type="" overloaded="no">
- <autodoc>SetItemText(long item, String str)</autodoc>
+ <autodoc>SetItemText(self, long item, String str)</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
<param name="str" type="String" default=""/>
</paramlist>
</method>
<method name="GetItemData" type="long" overloaded="no">
- <autodoc>GetItemData(long item) -> long</autodoc>
+ <autodoc>GetItemData(self, long item) -> long</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
</paramlist>
</method>
<method name="SetItemData" type="bool" overloaded="no">
- <autodoc>SetItemData(long item, long data) -> bool</autodoc>
+ <autodoc>SetItemData(self, long item, long data) -> bool</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
<param name="data" type="long" default=""/>
</paramlist>
</method>
<method name="GetItemPosition" type="Point" overloaded="no">
- <autodoc>GetItemPosition(long item) -> Point</autodoc>
+ <autodoc>GetItemPosition(self, long item) -> Point</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
</paramlist>
</method>
<method name="GetItemRect" type="Rect" overloaded="no">
- <autodoc>GetItemRect(long item, int code=LIST_RECT_BOUNDS) -> Rect</autodoc>
+ <autodoc>GetItemRect(self, long item, int code=LIST_RECT_BOUNDS) -> Rect</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
<param name="code" type="int" default="wxLIST_RECT_BOUNDS"/>
</paramlist>
</method>
<method name="SetItemPosition" type="bool" overloaded="no">
- <autodoc>SetItemPosition(long item, Point pos) -> bool</autodoc>
+ <autodoc>SetItemPosition(self, long item, Point pos) -> bool</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
<param name="pos" type="Point" default=""/>
</paramlist>
</method>
<method name="GetItemCount" type="int" overloaded="no">
- <autodoc>GetItemCount() -> int</autodoc>
+ <autodoc>GetItemCount(self) -> int</autodoc>
</method>
<method name="GetColumnCount" type="int" overloaded="no">
- <autodoc>GetColumnCount() -> int</autodoc>
+ <autodoc>GetColumnCount(self) -> int</autodoc>
</method>
<method name="GetItemSpacing" type="Size" overloaded="no">
- <autodoc>GetItemSpacing() -> Size</autodoc>
+ <autodoc>GetItemSpacing(self) -> Size</autodoc>
</method>
<method name="SetItemSpacing" type="" overloaded="no">
- <autodoc>SetItemSpacing(int spacing, bool isSmall=False)</autodoc>
+ <autodoc>SetItemSpacing(self, int spacing, bool isSmall=False)</autodoc>
<paramlist>
<param name="spacing" type="int" default=""/>
<param name="isSmall" type="bool" default="False"/>
</paramlist>
</method>
<method name="GetSelectedItemCount" type="int" overloaded="no">
- <autodoc>GetSelectedItemCount() -> int</autodoc>
+ <autodoc>GetSelectedItemCount(self) -> int</autodoc>
</method>
<method name="GetTextColour" type="Colour" overloaded="no">
- <autodoc>GetTextColour() -> Colour</autodoc>
+ <autodoc>GetTextColour(self) -> Colour</autodoc>
</method>
<method name="SetTextColour" type="" overloaded="no">
- <autodoc>SetTextColour(Colour col)</autodoc>
+ <autodoc>SetTextColour(self, Colour col)</autodoc>
<paramlist>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetTopItem" type="long" overloaded="no">
- <autodoc>GetTopItem() -> long</autodoc>
+ <autodoc>GetTopItem(self) -> long</autodoc>
</method>
<method name="SetSingleStyle" type="" overloaded="no">
- <autodoc>SetSingleStyle(long style, bool add=True)</autodoc>
+ <autodoc>SetSingleStyle(self, long style, bool add=True)</autodoc>
<paramlist>
<param name="style" type="long" default=""/>
<param name="add" type="bool" default="True"/>
</paramlist>
</method>
<method name="SetWindowStyleFlag" type="" overloaded="no">
- <autodoc>SetWindowStyleFlag(long style)</autodoc>
+ <autodoc>SetWindowStyleFlag(self, long style)</autodoc>
<docstring>Sets the style of the window. Please note that some styles cannot be
-changed after the window creation and that Refresh() might be called
-after changing the others for the change to take place immediately.</docstring>
+changed after the window creation and that Refresh() might need to be
+called after changing the others for the change to take place
+immediately.</docstring>
<paramlist>
<param name="style" type="long" default=""/>
</paramlist>
</method>
<method name="GetNextItem" type="long" overloaded="no">
- <autodoc>GetNextItem(long item, int geometry=LIST_NEXT_ALL, int state=LIST_STATE_DONTCARE) -> long</autodoc>
+ <autodoc>GetNextItem(self, long item, int geometry=LIST_NEXT_ALL, int state=LIST_STATE_DONTCARE) -> long</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
<param name="geometry" type="int" default="wxLIST_NEXT_ALL"/>
</paramlist>
</method>
<method name="GetImageList" type="ImageList" overloaded="no">
- <autodoc>GetImageList(int which) -> ImageList</autodoc>
+ <autodoc>GetImageList(self, int which) -> ImageList</autodoc>
<paramlist>
<param name="which" type="int" default=""/>
</paramlist>
</method>
<method name="SetImageList" type="" overloaded="no">
- <autodoc>SetImageList(ImageList imageList, int which)</autodoc>
+ <autodoc>SetImageList(self, ImageList imageList, int which)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
<param name="which" type="int" default=""/>
</paramlist>
</method>
<method name="AssignImageList" type="" overloaded="no">
- <autodoc>AssignImageList(ImageList imageList, int which)</autodoc>
+ <autodoc>AssignImageList(self, ImageList imageList, int which)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
<param name="which" type="int" default=""/>
</paramlist>
</method>
<method name="InReportView" type="bool" overloaded="no">
- <autodoc>InReportView() -> bool</autodoc>
+ <autodoc>InReportView(self) -> bool</autodoc>
</method>
<method name="IsVirtual" type="bool" overloaded="no">
- <autodoc>IsVirtual() -> bool</autodoc>
+ <autodoc>IsVirtual(self) -> bool</autodoc>
</method>
<method name="RefreshItem" type="" overloaded="no">
- <autodoc>RefreshItem(long item)</autodoc>
+ <autodoc>RefreshItem(self, long item)</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
</paramlist>
</method>
<method name="RefreshItems" type="" overloaded="no">
- <autodoc>RefreshItems(long itemFrom, long itemTo)</autodoc>
+ <autodoc>RefreshItems(self, long itemFrom, long itemTo)</autodoc>
<paramlist>
<param name="itemFrom" type="long" default=""/>
<param name="itemTo" type="long" default=""/>
</paramlist>
</method>
<method name="Arrange" type="bool" overloaded="no">
- <autodoc>Arrange(int flag=LIST_ALIGN_DEFAULT) -> bool</autodoc>
+ <autodoc>Arrange(self, int flag=LIST_ALIGN_DEFAULT) -> bool</autodoc>
<paramlist>
<param name="flag" type="int" default="wxLIST_ALIGN_DEFAULT"/>
</paramlist>
</method>
<method name="DeleteItem" type="bool" overloaded="no">
- <autodoc>DeleteItem(long item) -> bool</autodoc>
+ <autodoc>DeleteItem(self, long item) -> bool</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
</paramlist>
</method>
<method name="DeleteAllItems" type="bool" overloaded="no">
- <autodoc>DeleteAllItems() -> bool</autodoc>
+ <autodoc>DeleteAllItems(self) -> bool</autodoc>
</method>
<method name="DeleteColumn" type="bool" overloaded="no">
- <autodoc>DeleteColumn(int col) -> bool</autodoc>
+ <autodoc>DeleteColumn(self, int col) -> bool</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="DeleteAllColumns" type="bool" overloaded="no">
- <autodoc>DeleteAllColumns() -> bool</autodoc>
+ <autodoc>DeleteAllColumns(self) -> bool</autodoc>
</method>
<method name="ClearAll" type="" overloaded="no">
- <autodoc>ClearAll()</autodoc>
+ <autodoc>ClearAll(self)</autodoc>
</method>
<method name="EditLabel" type="" overloaded="no">
- <autodoc>EditLabel(long item)</autodoc>
+ <autodoc>EditLabel(self, long item)</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
</paramlist>
</method>
<method name="EnsureVisible" type="bool" overloaded="no">
- <autodoc>EnsureVisible(long item) -> bool</autodoc>
+ <autodoc>EnsureVisible(self, long item) -> bool</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
</paramlist>
</method>
<method name="FindItem" type="long" overloaded="no">
- <autodoc>FindItem(long start, String str, bool partial=False) -> long</autodoc>
+ <autodoc>FindItem(self, long start, String str, bool partial=False) -> long</autodoc>
<paramlist>
<param name="start" type="long" default=""/>
<param name="str" type="String" default=""/>
</paramlist>
</method>
<method name="FindItemData" type="long" overloaded="no">
- <autodoc>FindItemData(long start, long data) -> long</autodoc>
+ <autodoc>FindItemData(self, long start, long data) -> long</autodoc>
<paramlist>
<param name="start" type="long" default=""/>
<param name="data" type="long" default=""/>
</paramlist>
</method>
<method name="FindItemAtPos" type="long" overloaded="no">
- <autodoc>FindItemAtPos(long start, Point pt, int direction) -> long</autodoc>
+ <autodoc>FindItemAtPos(self, long start, Point pt, int direction) -> long</autodoc>
<paramlist>
<param name="start" type="long" default=""/>
<param name="pt" type="Point" default=""/>
</method>
<method name="HitTest" type="long" overloaded="no">
<autodoc>HitTest(Point point) -> (item, where)</autodoc>
- <docstring>Determines which item (if any) is at the specified point,
-giving details in the second return value (see wxLIST_HITTEST_... flags.)</docstring>
<paramlist>
<param name="point" type="Point" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="InsertItem" type="long" overloaded="no">
- <autodoc>InsertItem(ListItem info) -> long</autodoc>
+ <autodoc>InsertItem(self, ListItem info) -> long</autodoc>
<paramlist>
<param name="info" type="ListItem" default=""/>
</paramlist>
</method>
<method name="InsertStringItem" type="long" overloaded="no">
- <autodoc>InsertStringItem(long index, String label) -> long</autodoc>
+ <autodoc>InsertStringItem(self, long index, String label) -> long</autodoc>
<paramlist>
<param name="index" type="long" default=""/>
<param name="label" type="String" default=""/>
</paramlist>
</method>
<method name="InsertImageItem" type="long" overloaded="no">
- <autodoc>InsertImageItem(long index, int imageIndex) -> long</autodoc>
+ <autodoc>InsertImageItem(self, long index, int imageIndex) -> long</autodoc>
<paramlist>
<param name="index" type="long" default=""/>
<param name="imageIndex" type="int" default=""/>
</paramlist>
</method>
<method name="InsertImageStringItem" type="long" overloaded="no">
- <autodoc>InsertImageStringItem(long index, String label, int imageIndex) -> long</autodoc>
+ <autodoc>InsertImageStringItem(self, long index, String label, int imageIndex) -> long</autodoc>
<paramlist>
<param name="index" type="long" default=""/>
<param name="label" type="String" default=""/>
</paramlist>
</method>
<method name="InsertColumnInfo" type="long" overloaded="no">
- <autodoc>InsertColumnInfo(long col, ListItem info) -> long</autodoc>
+ <autodoc>InsertColumnInfo(self, long col, ListItem info) -> long</autodoc>
<paramlist>
<param name="col" type="long" default=""/>
<param name="info" type="ListItem" default=""/>
</paramlist>
</method>
<method name="InsertColumn" type="long" overloaded="no">
- <autodoc>InsertColumn(long col, String heading, int format=LIST_FORMAT_LEFT,
+ <autodoc>InsertColumn(self, long col, String heading, int format=LIST_FORMAT_LEFT,
int width=-1) -> long</autodoc>
<paramlist>
<param name="col" type="long" default=""/>
</paramlist>
</method>
<method name="SetItemCount" type="" overloaded="no">
- <autodoc>SetItemCount(long count)</autodoc>
+ <autodoc>SetItemCount(self, long count)</autodoc>
<paramlist>
<param name="count" type="long" default=""/>
</paramlist>
</method>
<method name="ScrollList" type="bool" overloaded="no">
- <autodoc>ScrollList(int dx, int dy) -> bool</autodoc>
+ <autodoc>ScrollList(self, int dx, int dy) -> bool</autodoc>
<paramlist>
<param name="dx" type="int" default=""/>
<param name="dy" type="int" default=""/>
</paramlist>
</method>
<method name="SetItemTextColour" type="" overloaded="no">
- <autodoc>SetItemTextColour(long item, Colour col)</autodoc>
+ <autodoc>SetItemTextColour(self, long item, Colour col)</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetItemTextColour" type="Colour" overloaded="no">
- <autodoc>GetItemTextColour(long item) -> Colour</autodoc>
+ <autodoc>GetItemTextColour(self, long item) -> Colour</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
</paramlist>
</method>
<method name="SetItemBackgroundColour" type="" overloaded="no">
- <autodoc>SetItemBackgroundColour(long item, Colour col)</autodoc>
+ <autodoc>SetItemBackgroundColour(self, long item, Colour col)</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetItemBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetItemBackgroundColour(long item) -> Colour</autodoc>
+ <autodoc>GetItemBackgroundColour(self, long item) -> Colour</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
</paramlist>
</method>
<method name="SortItems" type="bool" overloaded="no">
- <autodoc>SortItems(PyObject func) -> bool</autodoc>
+ <autodoc>SortItems(self, PyObject func) -> bool</autodoc>
<paramlist>
<param name="func" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetMainWindow" type="Window" overloaded="no">
- <autodoc>GetMainWindow() -> Window</autodoc>
+ <autodoc>GetMainWindow(self) -> Window</autodoc>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ListView" oldname="wxListView" module="controls">
+ <class name="ListView" oldname="wxListView" module="_controls">
<baseclass name="ListCtrl"/>
<constructor name="ListView" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=LC_REPORT,
Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListView</autodoc>
<paramlist>
<autodoc>PreListView() -> ListView</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=LC_REPORT,
Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool</autodoc>
<docstring>Do the 2nd phase and create the GUI control.</docstring>
</paramlist>
</method>
<method name="Select" type="" overloaded="no">
- <autodoc>Select(long n, bool on=True)</autodoc>
+ <autodoc>Select(self, long n, bool on=True)</autodoc>
<paramlist>
<param name="n" type="long" default=""/>
<param name="on" type="bool" default="True"/>
</paramlist>
</method>
<method name="Focus" type="" overloaded="no">
- <autodoc>Focus(long index)</autodoc>
+ <autodoc>Focus(self, long index)</autodoc>
<paramlist>
<param name="index" type="long" default=""/>
</paramlist>
</method>
<method name="GetFocusedItem" type="long" overloaded="no">
- <autodoc>GetFocusedItem() -> long</autodoc>
+ <autodoc>GetFocusedItem(self) -> long</autodoc>
</method>
<method name="GetNextSelected" type="long" overloaded="no">
- <autodoc>GetNextSelected(long item) -> long</autodoc>
+ <autodoc>GetNextSelected(self, long item) -> long</autodoc>
<paramlist>
<param name="item" type="long" default=""/>
</paramlist>
</method>
<method name="GetFirstSelected" type="long" overloaded="no">
- <autodoc>GetFirstSelected() -> long</autodoc>
+ <autodoc>GetFirstSelected(self) -> long</autodoc>
</method>
<method name="IsSelected" type="bool" overloaded="no">
- <autodoc>IsSelected(long index) -> bool</autodoc>
+ <autodoc>IsSelected(self, long index) -> bool</autodoc>
<paramlist>
<param name="index" type="long" default=""/>
</paramlist>
</method>
<method name="SetColumnImage" type="" overloaded="no">
- <autodoc>SetColumnImage(int col, int image)</autodoc>
+ <autodoc>SetColumnImage(self, int col, int image)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="image" type="int" default=""/>
</paramlist>
</method>
<method name="ClearColumnImage" type="" overloaded="no">
- <autodoc>ClearColumnImage(int col)</autodoc>
+ <autodoc>ClearColumnImage(self, int col)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="TreeItemId" oldname="wxTreeItemId" module="controls">
+ <class name="TreeItemId" oldname="wxTreeItemId" module="_controls">
<constructor name="TreeItemId" overloaded="no">
- <autodoc>__init__() -> TreeItemId</autodoc>
+ <autodoc>__init__(self) -> TreeItemId</autodoc>
</constructor>
<destructor name="~wxTreeItemId" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="IsOk" type="bool" overloaded="no">
- <autodoc>IsOk() -> bool</autodoc>
+ <autodoc>IsOk(self) -> bool</autodoc>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(TreeItemId other) -> bool</autodoc>
+ <autodoc>__eq__(self, TreeItemId other) -> bool</autodoc>
<paramlist>
<param name="other" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(TreeItemId other) -> bool</autodoc>
+ <autodoc>__ne__(self, TreeItemId other) -> bool</autodoc>
<paramlist>
<param name="other" type="TreeItemId" default=""/>
</paramlist>
</method>
<property name="m_pItem" type="" readonly="no"/>
</class>
- <class name="TreeItemData" oldname="wxPyTreeItemData" module="controls">
+ <class name="TreeItemData" oldname="wxPyTreeItemData" module="_controls">
<constructor name="wxPyTreeItemData" overloaded="no">
- <autodoc>__init__(PyObject obj=None) -> TreeItemData</autodoc>
+ <autodoc>__init__(self, PyObject obj=None) -> TreeItemData</autodoc>
<paramlist>
<param name="obj" type="PyObject" default="NULL"/>
</paramlist>
</constructor>
<method name="GetData" type="PyObject" overloaded="no">
- <autodoc>GetData() -> PyObject</autodoc>
+ <autodoc>GetData(self) -> PyObject</autodoc>
</method>
<method name="SetData" type="" overloaded="no">
- <autodoc>SetData(PyObject obj)</autodoc>
+ <autodoc>SetData(self, PyObject obj)</autodoc>
<paramlist>
<param name="obj" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetId" type="TreeItemId" overloaded="no">
- <autodoc>GetId() -> TreeItemId</autodoc>
+ <autodoc>GetId(self) -> TreeItemId</autodoc>
</method>
<method name="SetId" type="" overloaded="no">
- <autodoc>SetId(TreeItemId id)</autodoc>
+ <autodoc>SetId(self, TreeItemId id)</autodoc>
<paramlist>
<param name="id" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="Destroy" type="" overloaded="no">
- <autodoc>Destroy()</autodoc>
+ <autodoc>Destroy(self)</autodoc>
</method>
</class>
<pythoncode>
EVT_TREE_STATE_IMAGE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, 1)
EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP, 1)
</pythoncode>
- <class name="TreeEvent" oldname="wxTreeEvent" module="controls">
+ <class name="TreeEvent" oldname="wxTreeEvent" module="_controls">
<baseclass name="NotifyEvent"/>
<constructor name="TreeEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=wxEVT_NULL, int id=0) -> TreeEvent</autodoc>
+ <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> TreeEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="wxEVT_NULL"/>
<param name="id" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetItem" type="TreeItemId" overloaded="no">
- <autodoc>GetItem() -> TreeItemId</autodoc>
+ <autodoc>GetItem(self) -> TreeItemId</autodoc>
</method>
<method name="SetItem" type="" overloaded="no">
- <autodoc>SetItem(TreeItemId item)</autodoc>
+ <autodoc>SetItem(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetOldItem" type="TreeItemId" overloaded="no">
- <autodoc>GetOldItem() -> TreeItemId</autodoc>
+ <autodoc>GetOldItem(self) -> TreeItemId</autodoc>
</method>
<method name="SetOldItem" type="" overloaded="no">
- <autodoc>SetOldItem(TreeItemId item)</autodoc>
+ <autodoc>SetOldItem(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetPoint" type="Point" overloaded="no">
- <autodoc>GetPoint() -> Point</autodoc>
+ <autodoc>GetPoint(self) -> Point</autodoc>
</method>
<method name="SetPoint" type="" overloaded="no">
- <autodoc>SetPoint(Point pt)</autodoc>
+ <autodoc>SetPoint(self, Point pt)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="GetKeyEvent" type="KeyEvent" overloaded="no">
- <autodoc>GetKeyEvent() -> KeyEvent</autodoc>
+ <autodoc>GetKeyEvent(self) -> KeyEvent</autodoc>
</method>
<method name="GetKeyCode" type="int" overloaded="no">
- <autodoc>GetKeyCode() -> int</autodoc>
+ <autodoc>GetKeyCode(self) -> int</autodoc>
</method>
<method name="SetKeyEvent" type="" overloaded="no">
- <autodoc>SetKeyEvent(KeyEvent evt)</autodoc>
+ <autodoc>SetKeyEvent(self, KeyEvent evt)</autodoc>
<paramlist>
<param name="evt" type="KeyEvent" default=""/>
</paramlist>
</method>
<method name="GetLabel" type="String" overloaded="no">
- <autodoc>GetLabel() -> String</autodoc>
+ <autodoc>GetLabel(self) -> String</autodoc>
</method>
<method name="SetLabel" type="" overloaded="no">
- <autodoc>SetLabel(String label)</autodoc>
+ <autodoc>SetLabel(self, String label)</autodoc>
<paramlist>
<param name="label" type="String" default=""/>
</paramlist>
</method>
<method name="IsEditCancelled" type="bool" overloaded="no">
- <autodoc>IsEditCancelled() -> bool</autodoc>
+ <autodoc>IsEditCancelled(self) -> bool</autodoc>
</method>
<method name="SetEditCanceled" type="" overloaded="no">
- <autodoc>SetEditCanceled(bool editCancelled)</autodoc>
+ <autodoc>SetEditCanceled(self, bool editCancelled)</autodoc>
<paramlist>
<param name="editCancelled" type="bool" default=""/>
</paramlist>
</method>
<method name="SetToolTip" type="" overloaded="no">
- <autodoc>SetToolTip(String toolTip)</autodoc>
+ <autodoc>SetToolTip(self, String toolTip)</autodoc>
<paramlist>
<param name="toolTip" type="String" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="TreeCtrl" oldname="wxPyTreeCtrl" module="controls">
+ <class name="TreeCtrl" oldname="wxPyTreeCtrl" module="_controls">
<baseclass name="Control"/>
<constructor name="wxPyTreeCtrl" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
Validator validator=DefaultValidator,
String name=TreeCtrlNameStr) -> TreeCtrl</autodoc>
<autodoc>PreTreeCtrl() -> TreeCtrl</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
Validator validator=DefaultValidator,
String name=TreeCtrlNameStr) -> bool</autodoc>
</paramlist>
</method>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetCount" type="size_t" overloaded="no">
- <autodoc>GetCount() -> size_t</autodoc>
+ <autodoc>GetCount(self) -> size_t</autodoc>
</method>
<method name="GetIndent" type="unsigned int" overloaded="no">
- <autodoc>GetIndent() -> unsigned int</autodoc>
+ <autodoc>GetIndent(self) -> unsigned int</autodoc>
</method>
<method name="SetIndent" type="" overloaded="no">
- <autodoc>SetIndent(unsigned int indent)</autodoc>
+ <autodoc>SetIndent(self, unsigned int indent)</autodoc>
<paramlist>
<param name="indent" type="unsigned int" default=""/>
</paramlist>
</method>
<method name="GetSpacing" type="unsigned int" overloaded="no">
- <autodoc>GetSpacing() -> unsigned int</autodoc>
+ <autodoc>GetSpacing(self) -> unsigned int</autodoc>
</method>
<method name="SetSpacing" type="" overloaded="no">
- <autodoc>SetSpacing(unsigned int spacing)</autodoc>
+ <autodoc>SetSpacing(self, unsigned int spacing)</autodoc>
<paramlist>
<param name="spacing" type="unsigned int" default=""/>
</paramlist>
</method>
<method name="GetImageList" type="ImageList" overloaded="no">
- <autodoc>GetImageList() -> ImageList</autodoc>
+ <autodoc>GetImageList(self) -> ImageList</autodoc>
</method>
<method name="GetStateImageList" type="ImageList" overloaded="no">
- <autodoc>GetStateImageList() -> ImageList</autodoc>
+ <autodoc>GetStateImageList(self) -> ImageList</autodoc>
</method>
<method name="SetImageList" type="" overloaded="no">
- <autodoc>SetImageList(ImageList imageList)</autodoc>
+ <autodoc>SetImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="SetStateImageList" type="" overloaded="no">
- <autodoc>SetStateImageList(ImageList imageList)</autodoc>
+ <autodoc>SetStateImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="AssignImageList" type="" overloaded="no">
- <autodoc>AssignImageList(ImageList imageList)</autodoc>
+ <autodoc>AssignImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="AssignStateImageList" type="" overloaded="no">
- <autodoc>AssignStateImageList(ImageList imageList)</autodoc>
+ <autodoc>AssignStateImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="GetItemText" type="String" overloaded="no">
- <autodoc>GetItemText(TreeItemId item) -> String</autodoc>
+ <autodoc>GetItemText(self, TreeItemId item) -> String</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetItemImage" type="int" overloaded="no">
- <autodoc>GetItemImage(TreeItemId item, int which=TreeItemIcon_Normal) -> int</autodoc>
+ <autodoc>GetItemImage(self, TreeItemId item, int which=TreeItemIcon_Normal) -> int</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="which" type="wxTreeItemIcon" default="wxTreeItemIcon_Normal"/>
</paramlist>
</method>
<method name="GetItemData" type="TreeItemData" overloaded="no">
- <autodoc>GetItemData(TreeItemId item) -> TreeItemData</autodoc>
+ <autodoc>GetItemData(self, TreeItemId item) -> TreeItemData</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetItemPyData" type="PyObject" overloaded="no">
- <autodoc>GetItemPyData(TreeItemId item) -> PyObject</autodoc>
+ <autodoc>GetItemPyData(self, TreeItemId item) -> PyObject</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetItemTextColour" type="Colour" overloaded="no">
- <autodoc>GetItemTextColour(TreeItemId item) -> Colour</autodoc>
+ <autodoc>GetItemTextColour(self, TreeItemId item) -> Colour</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetItemBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetItemBackgroundColour(TreeItemId item) -> Colour</autodoc>
+ <autodoc>GetItemBackgroundColour(self, TreeItemId item) -> Colour</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetItemFont" type="Font" overloaded="no">
- <autodoc>GetItemFont(TreeItemId item) -> Font</autodoc>
+ <autodoc>GetItemFont(self, TreeItemId item) -> Font</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="SetItemText" type="" overloaded="no">
- <autodoc>SetItemText(TreeItemId item, String text)</autodoc>
+ <autodoc>SetItemText(self, TreeItemId item, String text)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SetItemImage" type="" overloaded="no">
- <autodoc>SetItemImage(TreeItemId item, int image, int which=TreeItemIcon_Normal)</autodoc>
+ <autodoc>SetItemImage(self, TreeItemId item, int image, int which=TreeItemIcon_Normal)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="image" type="int" default=""/>
</paramlist>
</method>
<method name="SetItemData" type="" overloaded="no">
- <autodoc>SetItemData(TreeItemId item, TreeItemData data)</autodoc>
+ <autodoc>SetItemData(self, TreeItemId item, TreeItemData data)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="data" type="TreeItemData" default=""/>
</paramlist>
</method>
<method name="SetItemPyData" type="" overloaded="no">
- <autodoc>SetItemPyData(TreeItemId item, PyObject obj)</autodoc>
+ <autodoc>SetItemPyData(self, TreeItemId item, PyObject obj)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="obj" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetItemHasChildren" type="" overloaded="no">
- <autodoc>SetItemHasChildren(TreeItemId item, bool has=True)</autodoc>
+ <autodoc>SetItemHasChildren(self, TreeItemId item, bool has=True)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="has" type="bool" default="True"/>
</paramlist>
</method>
<method name="SetItemBold" type="" overloaded="no">
- <autodoc>SetItemBold(TreeItemId item, bool bold=True)</autodoc>
+ <autodoc>SetItemBold(self, TreeItemId item, bool bold=True)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="bold" type="bool" default="True"/>
</paramlist>
</method>
<method name="SetItemTextColour" type="" overloaded="no">
- <autodoc>SetItemTextColour(TreeItemId item, Colour col)</autodoc>
+ <autodoc>SetItemTextColour(self, TreeItemId item, Colour col)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetItemBackgroundColour" type="" overloaded="no">
- <autodoc>SetItemBackgroundColour(TreeItemId item, Colour col)</autodoc>
+ <autodoc>SetItemBackgroundColour(self, TreeItemId item, Colour col)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetItemFont" type="" overloaded="no">
- <autodoc>SetItemFont(TreeItemId item, Font font)</autodoc>
+ <autodoc>SetItemFont(self, TreeItemId item, Font font)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="IsVisible" type="bool" overloaded="no">
- <autodoc>IsVisible(TreeItemId item) -> bool</autodoc>
+ <autodoc>IsVisible(self, TreeItemId item) -> bool</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="ItemHasChildren" type="bool" overloaded="no">
- <autodoc>ItemHasChildren(TreeItemId item) -> bool</autodoc>
+ <autodoc>ItemHasChildren(self, TreeItemId item) -> bool</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="IsExpanded" type="bool" overloaded="no">
- <autodoc>IsExpanded(TreeItemId item) -> bool</autodoc>
+ <autodoc>IsExpanded(self, TreeItemId item) -> bool</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="IsSelected" type="bool" overloaded="no">
- <autodoc>IsSelected(TreeItemId item) -> bool</autodoc>
+ <autodoc>IsSelected(self, TreeItemId item) -> bool</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="IsBold" type="bool" overloaded="no">
- <autodoc>IsBold(TreeItemId item) -> bool</autodoc>
+ <autodoc>IsBold(self, TreeItemId item) -> bool</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetChildrenCount" type="size_t" overloaded="no">
- <autodoc>GetChildrenCount(TreeItemId item, bool recursively=True) -> size_t</autodoc>
+ <autodoc>GetChildrenCount(self, TreeItemId item, bool recursively=True) -> size_t</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="recursively" type="bool" default="True"/>
</paramlist>
</method>
<method name="GetRootItem" type="TreeItemId" overloaded="no">
- <autodoc>GetRootItem() -> TreeItemId</autodoc>
+ <autodoc>GetRootItem(self) -> TreeItemId</autodoc>
</method>
<method name="GetSelection" type="TreeItemId" overloaded="no">
- <autodoc>GetSelection() -> TreeItemId</autodoc>
+ <autodoc>GetSelection(self) -> TreeItemId</autodoc>
</method>
<method name="GetSelections" type="PyObject" overloaded="no">
- <autodoc>GetSelections() -> PyObject</autodoc>
+ <autodoc>GetSelections(self) -> PyObject</autodoc>
</method>
<method name="GetItemParent" type="TreeItemId" overloaded="no">
- <autodoc>GetItemParent(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetItemParent(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetFirstChild" type="PyObject" overloaded="no">
- <autodoc>GetFirstChild(TreeItemId item) -> PyObject</autodoc>
+ <autodoc>GetFirstChild(self, TreeItemId item) -> PyObject</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetNextChild" type="PyObject" overloaded="no">
- <autodoc>GetNextChild(TreeItemId item, void cookie) -> PyObject</autodoc>
+ <autodoc>GetNextChild(self, TreeItemId item, void cookie) -> PyObject</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="cookie" type="" default=""/>
</paramlist>
</method>
<method name="GetLastChild" type="TreeItemId" overloaded="no">
- <autodoc>GetLastChild(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetLastChild(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetNextSibling" type="TreeItemId" overloaded="no">
- <autodoc>GetNextSibling(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetNextSibling(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetPrevSibling" type="TreeItemId" overloaded="no">
- <autodoc>GetPrevSibling(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetPrevSibling(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetFirstVisibleItem" type="TreeItemId" overloaded="no">
- <autodoc>GetFirstVisibleItem() -> TreeItemId</autodoc>
+ <autodoc>GetFirstVisibleItem(self) -> TreeItemId</autodoc>
</method>
<method name="GetNextVisible" type="TreeItemId" overloaded="no">
- <autodoc>GetNextVisible(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetNextVisible(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetPrevVisible" type="TreeItemId" overloaded="no">
- <autodoc>GetPrevVisible(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetPrevVisible(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="AddRoot" type="TreeItemId" overloaded="no">
- <autodoc>AddRoot(String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc>
+ <autodoc>AddRoot(self, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="image" type="int" default="-1"/>
</paramlist>
</method>
<method name="PrependItem" type="TreeItemId" overloaded="no">
- <autodoc>PrependItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1,
+ <autodoc>PrependItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1,
TreeItemData data=None) -> TreeItemId</autodoc>
<paramlist>
<param name="parent" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="InsertItem" type="TreeItemId" overloaded="no">
- <autodoc>InsertItem(TreeItemId parent, TreeItemId idPrevious, String text,
+ <autodoc>InsertItem(self, TreeItemId parent, TreeItemId idPrevious, String text,
int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc>
<paramlist>
<param name="parent" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="InsertItemBefore" type="TreeItemId" overloaded="no">
- <autodoc>InsertItemBefore(TreeItemId parent, size_t index, String text, int image=-1,
+ <autodoc>InsertItemBefore(self, TreeItemId parent, size_t index, String text, int image=-1,
int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc>
<paramlist>
<param name="parent" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="AppendItem" type="TreeItemId" overloaded="no">
- <autodoc>AppendItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1,
+ <autodoc>AppendItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1,
TreeItemData data=None) -> TreeItemId</autodoc>
<paramlist>
<param name="parent" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="Delete" type="" overloaded="no">
- <autodoc>Delete(TreeItemId item)</autodoc>
+ <autodoc>Delete(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="DeleteChildren" type="" overloaded="no">
- <autodoc>DeleteChildren(TreeItemId item)</autodoc>
+ <autodoc>DeleteChildren(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="DeleteAllItems" type="" overloaded="no">
- <autodoc>DeleteAllItems()</autodoc>
+ <autodoc>DeleteAllItems(self)</autodoc>
</method>
<method name="Expand" type="" overloaded="no">
- <autodoc>Expand(TreeItemId item)</autodoc>
+ <autodoc>Expand(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="Collapse" type="" overloaded="no">
- <autodoc>Collapse(TreeItemId item)</autodoc>
+ <autodoc>Collapse(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="CollapseAndReset" type="" overloaded="no">
- <autodoc>CollapseAndReset(TreeItemId item)</autodoc>
+ <autodoc>CollapseAndReset(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="Toggle" type="" overloaded="no">
- <autodoc>Toggle(TreeItemId item)</autodoc>
+ <autodoc>Toggle(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="Unselect" type="" overloaded="no">
- <autodoc>Unselect()</autodoc>
+ <autodoc>Unselect(self)</autodoc>
</method>
<method name="UnselectItem" type="" overloaded="no">
- <autodoc>UnselectItem(TreeItemId item)</autodoc>
+ <autodoc>UnselectItem(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="UnselectAll" type="" overloaded="no">
- <autodoc>UnselectAll()</autodoc>
+ <autodoc>UnselectAll(self)</autodoc>
</method>
<method name="SelectItem" type="" overloaded="no">
- <autodoc>SelectItem(TreeItemId item, bool select=True)</autodoc>
+ <autodoc>SelectItem(self, TreeItemId item, bool select=True)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="select" type="bool" default="True"/>
</paramlist>
</method>
<method name="ToggleItemSelection" type="" overloaded="no">
- <autodoc>ToggleItemSelection(TreeItemId item)</autodoc>
+ <autodoc>ToggleItemSelection(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="EnsureVisible" type="" overloaded="no">
- <autodoc>EnsureVisible(TreeItemId item)</autodoc>
+ <autodoc>EnsureVisible(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="ScrollTo" type="" overloaded="no">
- <autodoc>ScrollTo(TreeItemId item)</autodoc>
+ <autodoc>ScrollTo(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="EditLabel" type="" overloaded="no">
- <autodoc>EditLabel(TreeItemId item)</autodoc>
+ <autodoc>EditLabel(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetEditControl" type="TextCtrl" overloaded="no">
- <autodoc>GetEditControl() -> TextCtrl</autodoc>
+ <autodoc>GetEditControl(self) -> TextCtrl</autodoc>
</method>
<method name="SortChildren" type="" overloaded="no">
- <autodoc>SortChildren(TreeItemId item)</autodoc>
+ <autodoc>SortChildren(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="HitTest" type="TreeItemId" overloaded="no">
<autodoc>HitTest(Point point) -> (item, where)</autodoc>
- <docstring>Determine which item (if any) belongs the given point. The
-coordinates specified are relative to the client area of tree ctrl
-and the where return value is set to a bitmask of wxTREE_HITTEST_xxx
-constants.
-</docstring>
<paramlist>
<param name="point" type="Point" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="GetBoundingRect" type="PyObject" overloaded="no">
- <autodoc>GetBoundingRect(TreeItemId item, bool textOnly=False) -> PyObject</autodoc>
+ <autodoc>GetBoundingRect(self, TreeItemId item, bool textOnly=False) -> PyObject</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="textOnly" type="bool" default="False"/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="GenericDirCtrl" oldname="wxGenericDirCtrl" module="controls">
+ <class name="GenericDirCtrl" oldname="wxGenericDirCtrl" module="_controls">
<baseclass name="Control"/>
<constructor name="GenericDirCtrl" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, String dir=DirDialogDefaultFolderStr,
+ <autodoc>__init__(self, Window parent, int id=-1, String dir=DirDialogDefaultFolderStr,
Point pos=DefaultPosition, Size size=DefaultSize,
long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
String filter=EmptyString,
<autodoc>PreGenericDirCtrl() -> GenericDirCtrl</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, String dir=DirDialogDefaultFolderStr,
+ <autodoc>Create(self, Window parent, int id=-1, String dir=DirDialogDefaultFolderStr,
Point pos=DefaultPosition, Size size=DefaultSize,
long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
String filter=EmptyString,
</paramlist>
</method>
<method name="ExpandPath" type="bool" overloaded="no">
- <autodoc>ExpandPath(String path) -> bool</autodoc>
+ <autodoc>ExpandPath(self, String path) -> bool</autodoc>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="GetDefaultPath" type="String" overloaded="no">
- <autodoc>GetDefaultPath() -> String</autodoc>
+ <autodoc>GetDefaultPath(self) -> String</autodoc>
</method>
<method name="SetDefaultPath" type="" overloaded="no">
- <autodoc>SetDefaultPath(String path)</autodoc>
+ <autodoc>SetDefaultPath(self, String path)</autodoc>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="GetPath" type="String" overloaded="no">
- <autodoc>GetPath() -> String</autodoc>
+ <autodoc>GetPath(self) -> String</autodoc>
</method>
<method name="GetFilePath" type="String" overloaded="no">
- <autodoc>GetFilePath() -> String</autodoc>
+ <autodoc>GetFilePath(self) -> String</autodoc>
</method>
<method name="SetPath" type="" overloaded="no">
- <autodoc>SetPath(String path)</autodoc>
+ <autodoc>SetPath(self, String path)</autodoc>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="ShowHidden" type="" overloaded="no">
- <autodoc>ShowHidden(bool show)</autodoc>
+ <autodoc>ShowHidden(self, bool show)</autodoc>
<paramlist>
<param name="show" type="bool" default=""/>
</paramlist>
</method>
<method name="GetShowHidden" type="bool" overloaded="no">
- <autodoc>GetShowHidden() -> bool</autodoc>
+ <autodoc>GetShowHidden(self) -> bool</autodoc>
</method>
<method name="GetFilter" type="String" overloaded="no">
- <autodoc>GetFilter() -> String</autodoc>
+ <autodoc>GetFilter(self) -> String</autodoc>
</method>
<method name="SetFilter" type="" overloaded="no">
- <autodoc>SetFilter(String filter)</autodoc>
+ <autodoc>SetFilter(self, String filter)</autodoc>
<paramlist>
<param name="filter" type="String" default=""/>
</paramlist>
</method>
<method name="GetFilterIndex" type="int" overloaded="no">
- <autodoc>GetFilterIndex() -> int</autodoc>
+ <autodoc>GetFilterIndex(self) -> int</autodoc>
</method>
<method name="SetFilterIndex" type="" overloaded="no">
- <autodoc>SetFilterIndex(int n)</autodoc>
+ <autodoc>SetFilterIndex(self, int n)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetRootId" type="TreeItemId" overloaded="no">
- <autodoc>GetRootId() -> TreeItemId</autodoc>
+ <autodoc>GetRootId(self) -> TreeItemId</autodoc>
</method>
<method name="GetTreeCtrl" type="TreeCtrl" overloaded="no">
- <autodoc>GetTreeCtrl() -> TreeCtrl</autodoc>
+ <autodoc>GetTreeCtrl(self) -> TreeCtrl</autodoc>
</method>
<method name="GetFilterListCtrl" type="wxDirFilterListCtrl" overloaded="no">
- <autodoc>GetFilterListCtrl() -> DirFilterListCtrl</autodoc>
+ <autodoc>GetFilterListCtrl(self) -> DirFilterListCtrl</autodoc>
</method>
<method name="FindChild" type="TreeItemId" overloaded="no">
<autodoc>FindChild(wxTreeItemId parentId, wxString path) -> (item, done)</autodoc>
- <docstring>Find the child that matches the first part of 'path'. E.g. if a child path is
-"/usr" and 'path' is "/usr/include" then the child for /usr is returned.
-If the path string has been used (we're at the leaf), done is set to True
-</docstring>
<paramlist>
<param name="parentId" type="TreeItemId" default=""/>
<param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="DoResize" type="" overloaded="no">
- <autodoc>DoResize()</autodoc>
+ <autodoc>DoResize(self)</autodoc>
</method>
<method name="ReCreateTree" type="" overloaded="no">
- <autodoc>ReCreateTree()</autodoc>
+ <autodoc>ReCreateTree(self)</autodoc>
</method>
</class>
- <class name="DirFilterListCtrl" oldname="wxDirFilterListCtrl" module="controls">
+ <class name="DirFilterListCtrl" oldname="wxDirFilterListCtrl" module="_controls">
<baseclass name="Choice"/>
<constructor name="DirFilterListCtrl" overloaded="no">
- <autodoc>__init__(GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0) -> DirFilterListCtrl</autodoc>
<paramlist>
<param name="parent" type="GenericDirCtrl" default=""/>
<autodoc>PreDirFilterListCtrl() -> DirFilterListCtrl</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>Create(self, GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0) -> bool</autodoc>
<paramlist>
<param name="parent" type="GenericDirCtrl" default=""/>
</paramlist>
</method>
<method name="FillFilterList" type="" overloaded="no">
- <autodoc>FillFilterList(String filter, int defaultFilter)</autodoc>
+ <autodoc>FillFilterList(self, String filter, int defaultFilter)</autodoc>
<paramlist>
<param name="filter" type="String" default=""/>
<param name="defaultFilter" type="int" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="PyControl" oldname="wxPyControl" module="controls">
+ <class name="PyControl" oldname="wxPyControl" module="_controls">
<baseclass name="Control"/>
<constructor name="PyControl" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, Validator validator=DefaultValidator,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
String name=ControlNameStr) -> PyControl</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<param name="name" type="String" default="wxPyControlNameStr"/>
</paramlist>
</constructor>
+ <constructor name="PrePyControl" overloaded="no">
+ <autodoc>PrePyControl() -> PyControl</autodoc>
+ </constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
+ <method name="SetBestSize" type="" overloaded="no">
+ <autodoc>SetBestSize(self, Size size)</autodoc>
+ <paramlist>
+ <param name="size" type="Size" default=""/>
+ </paramlist>
+ </method>
<method name="base_DoMoveWindow" type="" overloaded="no">
- <autodoc>base_DoMoveWindow(int x, int y, int width, int height)</autodoc>
+ <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetSize" type="" overloaded="no">
- <autodoc>base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
+ <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetClientSize" type="" overloaded="no">
- <autodoc>base_DoSetClientSize(int width, int height)</autodoc>
+ <autodoc>base_DoSetClientSize(self, int width, int height)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetVirtualSize" type="" overloaded="no">
- <autodoc>base_DoSetVirtualSize(int x, int y)</autodoc>
+ <autodoc>base_DoSetVirtualSize(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoGetVirtualSize" type="Size" overloaded="no">
- <autodoc>base_DoGetVirtualSize() -> Size</autodoc>
+ <autodoc>base_DoGetVirtualSize(self) -> Size</autodoc>
</method>
<method name="base_DoGetBestSize" type="Size" overloaded="no">
- <autodoc>base_DoGetBestSize() -> Size</autodoc>
+ <autodoc>base_DoGetBestSize(self) -> Size</autodoc>
</method>
<method name="base_InitDialog" type="" overloaded="no">
- <autodoc>base_InitDialog()</autodoc>
+ <autodoc>base_InitDialog(self)</autodoc>
</method>
<method name="base_TransferDataToWindow" type="bool" overloaded="no">
- <autodoc>base_TransferDataToWindow() -> bool</autodoc>
+ <autodoc>base_TransferDataToWindow(self) -> bool</autodoc>
</method>
<method name="base_TransferDataFromWindow" type="bool" overloaded="no">
- <autodoc>base_TransferDataFromWindow() -> bool</autodoc>
+ <autodoc>base_TransferDataFromWindow(self) -> bool</autodoc>
</method>
<method name="base_Validate" type="bool" overloaded="no">
- <autodoc>base_Validate() -> bool</autodoc>
+ <autodoc>base_Validate(self) -> bool</autodoc>
</method>
<method name="base_AcceptsFocus" type="bool" overloaded="no">
- <autodoc>base_AcceptsFocus() -> bool</autodoc>
+ <autodoc>base_AcceptsFocus(self) -> bool</autodoc>
</method>
<method name="base_AcceptsFocusFromKeyboard" type="bool" overloaded="no">
- <autodoc>base_AcceptsFocusFromKeyboard() -> bool</autodoc>
+ <autodoc>base_AcceptsFocusFromKeyboard(self) -> bool</autodoc>
</method>
<method name="base_GetMaxSize" type="Size" overloaded="no">
- <autodoc>base_GetMaxSize() -> Size</autodoc>
+ <autodoc>base_GetMaxSize(self) -> Size</autodoc>
</method>
<method name="base_AddChild" type="" overloaded="no">
- <autodoc>base_AddChild(Window child)</autodoc>
+ <autodoc>base_AddChild(self, Window child)</autodoc>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
<method name="base_RemoveChild" type="" overloaded="no">
- <autodoc>base_RemoveChild(Window child)</autodoc>
+ <autodoc>base_RemoveChild(self, Window child)</autodoc>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
+ <method name="base_ShouldInheritColours" type="bool" overloaded="no">
+ <autodoc>base_ShouldInheritColours(self) -> bool</autodoc>
+ </method>
+ <method name="base_ApplyParentThemeBackground" type="" overloaded="no">
+ <autodoc>base_ApplyParentThemeBackground(self, Colour c)</autodoc>
+ <paramlist>
+ <param name="c" type="Colour" default=""/>
+ </paramlist>
+ </method>
+ <method name="base_GetDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>base_GetDefaultAttributes(self) -> VisualAttributes</autodoc>
+ </method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
EVT_DETAILED_HELP = wx.PyEventBinder( wxEVT_DETAILED_HELP, 1)
EVT_DETAILED_HELP_RANGE = wx.PyEventBinder( wxEVT_DETAILED_HELP, 2)
</pythoncode>
- <class name="HelpEvent" oldname="wxHelpEvent" module="controls">
- <docstring>A help event is sent when the user has requested
-context-sensitive help. This can either be caused by the
-application requesting context-sensitive help mode via
-wx.ContextHelp, or (on MS Windows) by the system generating a
-WM_HELP message when the user pressed F1 or clicked on the query
-button in a dialog caption.
-
-A help event is sent to the window that the user clicked on, and
-is propagated up the window hierarchy until the event is
-processed or there are no more event handlers. The application
-should call event.GetId to check the identity of the clicked-on
-window, and then either show some suitable help or call
-event.Skip if the identifier is unrecognised. Calling Skip is
-important because it allows wxWindows to generate further events
-for ancestors of the clicked-on window. Otherwise it would be
-impossible to show help for container windows, since processing
-would stop after the first window found.
-
- Events
- EVT_HELP Sent when the user has requested context-
- sensitive help.
- EVT_HELP_RANGE Allows to catch EVT_HELP for a range of IDs
-</docstring>
+ <class name="HelpEvent" oldname="wxHelpEvent" module="_controls">
+ <docstring>A help event is sent when the user has requested context-sensitive
+help. This can either be caused by the application requesting
+context-sensitive help mode via wx.ContextHelp, or (on MS Windows) by
+the system generating a WM_HELP message when the user pressed F1 or
+clicked on the query button in a dialog caption.
+
+A help event is sent to the window that the user clicked on, and is
+propagated up the window hierarchy until the event is processed or
+there are no more event handlers. The application should call
+event.GetId to check the identity of the clicked-on window, and then
+either show some suitable help or call event.Skip if the identifier is
+unrecognised. Calling Skip is important because it allows wxWindows to
+generate further events for ancestors of the clicked-on
+window. Otherwise it would be impossible to show help for container
+windows, since processing would stop after the first window found.</docstring>
<baseclass name="CommandEvent"/>
<constructor name="HelpEvent" overloaded="no">
- <autodoc>__init__(wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> HelpEvent</autodoc>
+ <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> HelpEvent</autodoc>
<paramlist>
<param name="type" type="wxEventType" default="wxEVT_NULL"/>
<param name="winid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
<docstring>Returns the left-click position of the mouse, in screen
coordinates. This allows the application to position the help
appropriately.</docstring>
</method>
<method name="SetPosition" type="" overloaded="no">
- <autodoc>SetPosition(Point pos)</autodoc>
+ <autodoc>SetPosition(self, Point pos)</autodoc>
<docstring>Sets the left-click position of the mouse, in screen coordinates.</docstring>
<paramlist>
<param name="pos" type="Point" default=""/>
</paramlist>
</method>
<method name="GetLink" type="String" overloaded="no">
- <autodoc>GetLink() -> String</autodoc>
+ <autodoc>GetLink(self) -> String</autodoc>
<docstring>Get an optional link to further help</docstring>
</method>
<method name="SetLink" type="" overloaded="no">
- <autodoc>SetLink(String link)</autodoc>
+ <autodoc>SetLink(self, String link)</autodoc>
<docstring>Set an optional link to further help</docstring>
<paramlist>
<param name="link" type="String" default=""/>
</paramlist>
</method>
<method name="GetTarget" type="String" overloaded="no">
- <autodoc>GetTarget() -> String</autodoc>
+ <autodoc>GetTarget(self) -> String</autodoc>
<docstring>Get an optional target to display help in. E.g. a window specification</docstring>
</method>
<method name="SetTarget" type="" overloaded="no">
- <autodoc>SetTarget(String target)</autodoc>
+ <autodoc>SetTarget(self, String target)</autodoc>
<docstring>Set an optional target to display help in. E.g. a window specification</docstring>
<paramlist>
<param name="target" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="ContextHelp" oldname="wxContextHelp" module="controls">
- <docstring>This class changes the cursor to a query and puts the application
-into a 'context-sensitive help mode'. When the user left-clicks
-on a window within the specified window, a EVT_HELP event is sent
-to that control, and the application may respond to it by popping
-up some help.
+ <class name="ContextHelp" oldname="wxContextHelp" module="_controls">
+ <docstring>This class changes the cursor to a query and puts the application into
+a 'context-sensitive help mode'. When the user left-clicks on a window
+within the specified window, a ``EVT_HELP`` event is sent to that
+control, and the application may respond to it by popping up some
+help.
There are a couple of ways to invoke this behaviour implicitly:
- * Use the wx.DIALOG_EX_CONTEXTHELP extended style for a
- dialog (Windows only). This will put a question mark in the
- titlebar, and Windows will put the application into
- context-sensitive help mode automatically, with further
- programming.
-
- * Create a wx.ContextHelpButton, whose predefined behaviour
- is to create a context help object. Normally you will write
- your application so that this button is only added to a
- dialog for non-Windows platforms (use
- wx.DIALOG_EX_CONTEXTHELP on Windows).
+ * Use the wx.DIALOG_EX_CONTEXTHELP extended style for a dialog
+ (Windows only). This will put a question mark in the titlebar,
+ and Windows will put the application into context-sensitive help
+ mode automatically, with further programming.
+
+ * Create a `wx.ContextHelpButton`, whose predefined behaviour is
+ to create a context help object. Normally you will write your
+ application so that this button is only added to a dialog for
+ non-Windows platforms (use ``wx.DIALOG_EX_CONTEXTHELP`` on
+ Windows).
+
+:see: `wx.ContextHelpButton`
</docstring>
<baseclass name="Object"/>
<constructor name="ContextHelp" overloaded="no">
- <autodoc>__init__(Window window=None, bool doNow=True) -> ContextHelp</autodoc>
- <docstring>Constructs a context help object, calling BeginContextHelp if
-doNow is true (the default).
+ <autodoc>__init__(self, Window window=None, bool doNow=True) -> ContextHelp</autodoc>
+ <docstring>Constructs a context help object, calling BeginContextHelp if doNow is
+true (the default).
If window is None, the top window is used.</docstring>
<paramlist>
</paramlist>
</constructor>
<destructor name="~wxContextHelp" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="BeginContextHelp" type="bool" overloaded="no">
- <autodoc>BeginContextHelp(Window window=None) -> bool</autodoc>
- <docstring>Puts the application into context-sensitive help mode. window is
-the window which will be used to catch events; if NULL, the top
-window will be used.
+ <autodoc>BeginContextHelp(self, Window window=None) -> bool</autodoc>
+ <docstring>Puts the application into context-sensitive help mode. window is the
+window which will be used to catch events; if NULL, the top window
+will be used.
Returns true if the application was successfully put into
-context-sensitive help mode. This function only returns when the
-event loop has finished.</docstring>
+context-sensitive help mode. This function only returns when the event
+loop has finished.</docstring>
<paramlist>
<param name="window" type="Window" default="NULL"/>
</paramlist>
</method>
<method name="EndContextHelp" type="bool" overloaded="no">
- <autodoc>EndContextHelp() -> bool</autodoc>
+ <autodoc>EndContextHelp(self) -> bool</autodoc>
<docstring>Ends context-sensitive help mode. Not normally called by the
application.</docstring>
</method>
</class>
- <class name="ContextHelpButton" oldname="wxContextHelpButton" module="controls">
- <docstring>Instances of this class may be used to add a question mark button
-that when pressed, puts the application into context-help
-mode. It does this by creating a wx.ContextHelp object which
-itself generates a EVT_HELP event when the user clicks on a
-window.
+ <class name="ContextHelpButton" oldname="wxContextHelpButton" module="_controls">
+ <docstring>Instances of this class may be used to add a question mark button that
+when pressed, puts the application into context-help mode. It does
+this by creating a wx.ContextHelp object which itself generates a
+``EVT_HELP`` event when the user clicks on a window.
+
+On Windows, you may add a question-mark icon to a dialog by use of the
+``wx.DIALOG_EX_CONTEXTHELP`` extra style, but on other platforms you
+will have to add a button explicitly, usually next to OK, Cancel or
+similar buttons.
-On Windows, you may add a question-mark icon to a dialog by use
-of the wx.DIALOG_EX_CONTEXTHELP extra style, but on other
-platforms you will have to add a button explicitly, usually next
-to OK, Cancel or similar buttons.
+:see: `wx.ContextHelp`, `wx.ContextHelpButton`
</docstring>
<baseclass name="BitmapButton"/>
<constructor name="ContextHelpButton" overloaded="no">
- <autodoc>__init__(Window parent, int id=ID_CONTEXT_HELP, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=ID_CONTEXT_HELP, Point pos=DefaultPosition,
Size size=DefaultSize, long style=BU_AUTODRAW) -> ContextHelpButton</autodoc>
<docstring>Constructor, creating and showing a context help button.</docstring>
<paramlist>
</paramlist>
</constructor>
</class>
- <class name="HelpProvider" oldname="wxHelpProvider" module="controls">
+ <class name="HelpProvider" oldname="wxHelpProvider" module="_controls">
<docstring>wx.HelpProvider is an abstract class used by a program
implementing context-sensitive help to show the help text for the
given window.
application using wx.HelpProvider.Set().</docstring>
<staticmethod name="Set" type="HelpProvider" overloaded="no">
<autodoc>Set(HelpProvider helpProvider) -> HelpProvider</autodoc>
- <docstring>Sset the current, application-wide help provider. Returns the
-previous one. Unlike some other classes, the help provider is
-not created on demand. This must be explicitly done by the
-application.</docstring>
+ <docstring>Sset the current, application-wide help provider. Returns the previous
+one. Unlike some other classes, the help provider is not created on
+demand. This must be explicitly done by the application.</docstring>
<paramlist>
<param name="helpProvider" type="HelpProvider" default=""/>
</paramlist>
<docstring>Return the current application-wide help provider.</docstring>
</staticmethod>
<method name="GetHelp" type="String" overloaded="no">
- <autodoc>GetHelp(Window window) -> String</autodoc>
- <docstring>Gets the help string for this window. Its interpretation is
-dependent on the help provider except that empty string always
-means that no help is associated with the window.</docstring>
+ <autodoc>GetHelp(self, Window window) -> String</autodoc>
+ <docstring>Gets the help string for this window. Its interpretation is dependent
+on the help provider except that empty string always means that no
+help is associated with the window.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="ShowHelp" type="bool" overloaded="no">
- <autodoc>ShowHelp(Window window) -> bool</autodoc>
+ <autodoc>ShowHelp(self, Window window) -> bool</autodoc>
<docstring>Shows help for the given window. Uses GetHelp internally if
-applicable.
-
-Returns true if it was done, or false if no help was available
-for this window.</docstring>
+applicable. Returns True if it was done, or False if no help was
+available for this window.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="AddHelp" type="" overloaded="no">
- <autodoc>AddHelp(Window window, String text)</autodoc>
+ <autodoc>AddHelp(self, Window window, String text)</autodoc>
<docstring>Associates the text with the given window.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="AddHelpById" type="" overloaded="no">
- <autodoc>AddHelpById(int id, String text)</autodoc>
+ <autodoc>AddHelpById(self, int id, String text)</autodoc>
<docstring>This version associates the given text with all windows with this
-id. May be used to set the same help string for all Cancel
-buttons in the application, for example.</docstring>
+id. May be used to set the same help string for all Cancel buttons in
+the application, for example.</docstring>
<paramlist>
<param name="id" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="RemoveHelp" type="" overloaded="no">
- <autodoc>RemoveHelp(Window window)</autodoc>
+ <autodoc>RemoveHelp(self, Window window)</autodoc>
<docstring>Removes the association between the window pointer and the help
-text. This is called by the wx.Window destructor. Without this,
-the table of help strings will fill up and when window pointers
-are reused, the wrong help string will be found.</docstring>
+text. This is called by the wx.Window destructor. Without this, the
+table of help strings will fill up and when window pointers are
+reused, the wrong help string will be found.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="Destroy" type="" overloaded="no">
- <autodoc>Destroy()</autodoc>
+ <autodoc>Destroy(self)</autodoc>
</method>
</class>
- <class name="SimpleHelpProvider" oldname="wxSimpleHelpProvider" module="controls">
- <docstring>wx.SimpleHelpProvider is an implementation of wx.HelpProvider
-which supports only plain text help strings, and shows the string
-associated with the control (if any) in a tooltip.</docstring>
+ <class name="SimpleHelpProvider" oldname="wxSimpleHelpProvider" module="_controls">
+ <docstring>wx.SimpleHelpProvider is an implementation of `wx.HelpProvider` which
+supports only plain text help strings, and shows the string associated
+with the control (if any) in a tooltip.</docstring>
<baseclass name="HelpProvider"/>
<constructor name="SimpleHelpProvider" overloaded="no">
- <autodoc>__init__() -> SimpleHelpProvider</autodoc>
- <docstring>wx.SimpleHelpProvider is an implementation of wx.HelpProvider
-which supports only plain text help strings, and shows the string
-associated with the control (if any) in a tooltip.</docstring>
+ <autodoc>__init__(self) -> SimpleHelpProvider</autodoc>
+ <docstring>wx.SimpleHelpProvider is an implementation of `wx.HelpProvider` which
+supports only plain text help strings, and shows the string associated
+with the control (if any) in a tooltip.</docstring>
</constructor>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="DragImage" oldname="wxGenericDragImage" module="controls">
+ <class name="DragImage" oldname="wxGenericDragImage" module="_controls">
<baseclass name="Object"/>
<constructor name="wxGenericDragImage" overloaded="no">
- <autodoc>__init__(Bitmap image, Cursor cursor=wxNullCursor) -> DragImage</autodoc>
+ <autodoc>__init__(self, Bitmap image, Cursor cursor=wxNullCursor) -> DragImage</autodoc>
<paramlist>
<param name="image" type="Bitmap" default=""/>
<param name="cursor" type="Cursor" default="wxNullCursor"/>
</paramlist>
</constructor>
<destructor name="~wxGenericDragImage" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetBackingBitmap" type="" overloaded="no">
- <autodoc>SetBackingBitmap(Bitmap bitmap)</autodoc>
+ <autodoc>SetBackingBitmap(self, Bitmap bitmap)</autodoc>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="BeginDrag" type="bool" overloaded="no">
- <autodoc>BeginDrag(Point hotspot, Window window, bool fullScreen=False,
+ <autodoc>BeginDrag(self, Point hotspot, Window window, bool fullScreen=False,
Rect rect=None) -> bool</autodoc>
<paramlist>
<param name="hotspot" type="Point" default=""/>
</paramlist>
</method>
<method name="BeginDragBounded" type="bool" overloaded="no">
- <autodoc>BeginDragBounded(Point hotspot, Window window, Window boundingWindow) -> bool</autodoc>
+ <autodoc>BeginDragBounded(self, Point hotspot, Window window, Window boundingWindow) -> bool</autodoc>
<paramlist>
<param name="hotspot" type="Point" default=""/>
<param name="window" type="Window" default=""/>
</paramlist>
</method>
<method name="EndDrag" type="bool" overloaded="no">
- <autodoc>EndDrag() -> bool</autodoc>
+ <autodoc>EndDrag(self) -> bool</autodoc>
</method>
<method name="Move" type="bool" overloaded="no">
- <autodoc>Move(Point pt) -> bool</autodoc>
+ <autodoc>Move(self, Point pt) -> bool</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="Show" type="bool" overloaded="no">
- <autodoc>Show() -> bool</autodoc>
+ <autodoc>Show(self) -> bool</autodoc>
</method>
<method name="Hide" type="bool" overloaded="no">
- <autodoc>Hide() -> bool</autodoc>
+ <autodoc>Hide(self) -> bool</autodoc>
</method>
<method name="GetImageRect" type="Rect" overloaded="no">
- <autodoc>GetImageRect(Point pos) -> Rect</autodoc>
+ <autodoc>GetImageRect(self, Point pos) -> Rect</autodoc>
<paramlist>
<param name="pos" type="Point" default=""/>
</paramlist>
</method>
<method name="DoDrawImage" type="bool" overloaded="no">
- <autodoc>DoDrawImage(DC dc, Point pos) -> bool</autodoc>
+ <autodoc>DoDrawImage(self, DC dc, Point pos) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="pos" type="Point" default=""/>
</paramlist>
</method>
<method name="UpdateBackingFromWindow" type="bool" overloaded="no">
- <autodoc>UpdateBackingFromWindow(DC windowDC, MemoryDC destDC, Rect sourceRect, Rect destRect) -> bool</autodoc>
+ <autodoc>UpdateBackingFromWindow(self, DC windowDC, MemoryDC destDC, Rect sourceRect, Rect destRect) -> bool</autodoc>
<paramlist>
<param name="windowDC" type="DC" default=""/>
<param name="destDC" type="MemoryDC" default=""/>
</paramlist>
</method>
<method name="RedrawImage" type="bool" overloaded="no">
- <autodoc>RedrawImage(Point oldPos, Point newPos, bool eraseOld, bool drawNew) -> bool</autodoc>
+ <autodoc>RedrawImage(self, Point oldPos, Point newPos, bool eraseOld, bool drawNew) -> bool</autodoc>
<paramlist>
<param name="oldPos" type="Point" default=""/>
<param name="newPos" type="Point" default=""/>
</method>
</class>
</module>
- <module name="misc">
- <import name="core"/>
- <pythoncode> wx = core </pythoncode>
+ <module name="_misc">
+ <import name="_core"/>
+ <pythoncode> wx = _core </pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="SystemSettings" oldname="wxSystemSettings" module="misc">
+ <class name="SystemSettings" oldname="wxSystemSettings" module="_misc">
<staticmethod name="GetColour" type="Colour" overloaded="no">
<autodoc>GetColour(int index) -> Colour</autodoc>
<paramlist>
</paramlist>
</staticmethod>
</class>
- <class name="SystemOptions" oldname="wxSystemOptions" module="misc">
+ <class name="SystemOptions" oldname="wxSystemOptions" module="_misc">
<baseclass name="Object"/>
<constructor name="SystemOptions" overloaded="no">
- <autodoc>__init__() -> SystemOptions</autodoc>
+ <autodoc>__init__(self) -> SystemOptions</autodoc>
</constructor>
<staticmethod name="SetOption" type="" overloaded="no">
<autodoc>SetOption(String name, String value)</autodoc>
</method>
<method name="GetKeyState" oldname="wxGetKeyState" type="bool" overloaded="no">
<autodoc>GetKeyState(int key) -> bool</autodoc>
+ <docstring>Get the state of a key (true if pressed or toggled on, false if not.)
+This is generally most useful getting the state of the modifier or
+toggle keys. On some platforms those may be the only keys that work.
+</docstring>
<paramlist>
<param name="key" type="wxKeyCode" default=""/>
</paramlist>
<method name="MutexGuiLeave" oldname="wxMutexGuiLeave" type="" overloaded="no">
<autodoc>MutexGuiLeave()</autodoc>
</method>
- <class name="MutexGuiLocker" oldname="wxMutexGuiLocker" module="misc">
+ <class name="MutexGuiLocker" oldname="wxMutexGuiLocker" module="_misc">
<constructor name="MutexGuiLocker" overloaded="no">
- <autodoc>__init__() -> MutexGuiLocker</autodoc>
+ <autodoc>__init__(self) -> MutexGuiLocker</autodoc>
</constructor>
<destructor name="~wxMutexGuiLocker" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
</class>
<method name="Thread_IsMain" oldname="wxThread_IsMain" type="bool" overloaded="no">
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ToolTip" oldname="wxToolTip" module="misc">
+ <class name="ToolTip" oldname="wxToolTip" module="_misc">
<baseclass name="Object"/>
<constructor name="ToolTip" overloaded="no">
- <autodoc>__init__(String tip) -> ToolTip</autodoc>
+ <autodoc>__init__(self, String tip) -> ToolTip</autodoc>
<paramlist>
<param name="tip" type="String" default=""/>
</paramlist>
</constructor>
<method name="SetTip" type="" overloaded="no">
- <autodoc>SetTip(String tip)</autodoc>
+ <autodoc>SetTip(self, String tip)</autodoc>
<paramlist>
<param name="tip" type="String" default=""/>
</paramlist>
</method>
<method name="GetTip" type="String" overloaded="no">
- <autodoc>GetTip() -> String</autodoc>
+ <autodoc>GetTip(self) -> String</autodoc>
</method>
<method name="GetWindow" type="Window" overloaded="no">
- <autodoc>GetWindow() -> Window</autodoc>
+ <autodoc>GetWindow(self) -> Window</autodoc>
</method>
<staticmethod name="Enable" type="" overloaded="no">
<autodoc>Enable(bool flag)</autodoc>
</paramlist>
</staticmethod>
</class>
- <class name="Caret" oldname="wxCaret" module="misc">
+ <class name="Caret" oldname="wxCaret" module="_misc">
<constructor name="Caret" overloaded="no">
- <autodoc>__init__(Window window, Size size) -> Caret</autodoc>
+ <autodoc>__init__(self, Window window, Size size) -> Caret</autodoc>
<paramlist>
<param name="window" type="Window" default=""/>
<param name="size" type="Size" default=""/>
</paramlist>
</constructor>
<destructor name="~wxCaret" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="IsOk" type="bool" overloaded="no">
- <autodoc>IsOk() -> bool</autodoc>
+ <autodoc>IsOk(self) -> bool</autodoc>
</method>
<method name="IsVisible" type="bool" overloaded="no">
- <autodoc>IsVisible() -> bool</autodoc>
+ <autodoc>IsVisible(self) -> bool</autodoc>
</method>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
</method>
<method name="GetPositionTuple" type="" overloaded="no">
<autodoc>GetPositionTuple() -> (x,y)</autodoc>
</paramlist>
</method>
<method name="GetSize" type="Size" overloaded="no">
- <autodoc>GetSize() -> Size</autodoc>
+ <autodoc>GetSize(self) -> Size</autodoc>
</method>
<method name="GetSizeTuple" type="" overloaded="no">
<autodoc>GetSizeTuple() -> (width, height)</autodoc>
</paramlist>
</method>
<method name="GetWindow" type="Window" overloaded="no">
- <autodoc>GetWindow() -> Window</autodoc>
+ <autodoc>GetWindow(self) -> Window</autodoc>
</method>
<method name="MoveXY" type="" overloaded="no">
- <autodoc>MoveXY(int x, int y)</autodoc>
+ <autodoc>MoveXY(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="Move" type="" overloaded="no">
- <autodoc>Move(Point pt)</autodoc>
+ <autodoc>Move(self, Point pt)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="SetSizeWH" type="" overloaded="no">
- <autodoc>SetSizeWH(int width, int height)</autodoc>
+ <autodoc>SetSizeWH(self, int width, int height)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(Size size)</autodoc>
+ <autodoc>SetSize(self, Size size)</autodoc>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="Show" type="" overloaded="no">
- <autodoc>Show(int show=True)</autodoc>
+ <autodoc>Show(self, int show=True)</autodoc>
<paramlist>
<param name="show" type="int" default="True"/>
</paramlist>
</method>
<method name="Hide" type="" overloaded="no">
- <autodoc>Hide()</autodoc>
+ <autodoc>Hide(self)</autodoc>
</method>
</class>
<method name="Caret_GetBlinkTime" oldname="wxCaret_GetBlinkTime" type="int" overloaded="no">
<param name="milliseconds" type="int" default=""/>
</paramlist>
</method>
- <class name="BusyCursor" oldname="wxBusyCursor" module="misc">
+ <class name="BusyCursor" oldname="wxBusyCursor" module="_misc">
<constructor name="BusyCursor" overloaded="no">
- <autodoc>__init__(Cursor cursor=wxHOURGLASS_CURSOR) -> BusyCursor</autodoc>
+ <autodoc>__init__(self, Cursor cursor=wxHOURGLASS_CURSOR) -> BusyCursor</autodoc>
<paramlist>
<param name="cursor" type="Cursor" default="wxHOURGLASS_CURSOR"/>
</paramlist>
</constructor>
<destructor name="~wxBusyCursor" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
</class>
- <class name="WindowDisabler" oldname="wxWindowDisabler" module="misc">
+ <class name="WindowDisabler" oldname="wxWindowDisabler" module="_misc">
<constructor name="WindowDisabler" overloaded="no">
- <autodoc>__init__(Window winToSkip=None) -> WindowDisabler</autodoc>
+ <autodoc>__init__(self, Window winToSkip=None) -> WindowDisabler</autodoc>
<paramlist>
<param name="winToSkip" type="Window" default="NULL"/>
</paramlist>
</constructor>
<destructor name="~wxWindowDisabler" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
</class>
- <class name="BusyInfo" oldname="wxBusyInfo" module="misc">
+ <class name="BusyInfo" oldname="wxBusyInfo" module="_misc">
<baseclass name="Object"/>
<constructor name="BusyInfo" overloaded="no">
- <autodoc>__init__(String message) -> BusyInfo</autodoc>
+ <autodoc>__init__(self, String message) -> BusyInfo</autodoc>
<paramlist>
<param name="message" type="String" default=""/>
</paramlist>
</constructor>
<destructor name="~wxBusyInfo" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
</class>
- <class name="StopWatch" oldname="wxStopWatch" module="misc">
+ <class name="StopWatch" oldname="wxStopWatch" module="_misc">
<constructor name="StopWatch" overloaded="no">
- <autodoc>__init__() -> StopWatch</autodoc>
+ <autodoc>__init__(self) -> StopWatch</autodoc>
</constructor>
<method name="Start" type="" overloaded="no">
- <autodoc>Start(long t0=0)</autodoc>
+ <autodoc>Start(self, long t0=0)</autodoc>
<paramlist>
<param name="t0" type="long" default="0"/>
</paramlist>
</method>
<method name="Pause" type="" overloaded="no">
- <autodoc>Pause()</autodoc>
+ <autodoc>Pause(self)</autodoc>
</method>
<method name="Resume" type="" overloaded="no">
- <autodoc>Resume()</autodoc>
+ <autodoc>Resume(self)</autodoc>
</method>
<method name="Time" type="long" overloaded="no">
- <autodoc>Time() -> long</autodoc>
+ <autodoc>Time(self) -> long</autodoc>
</method>
</class>
- <class name="FileHistory" oldname="wxFileHistory" module="misc">
+ <class name="FileHistory" oldname="wxFileHistory" module="_misc">
<baseclass name="Object"/>
<constructor name="FileHistory" overloaded="no">
- <autodoc>__init__(int maxFiles=9) -> FileHistory</autodoc>
+ <autodoc>__init__(self, int maxFiles=9) -> FileHistory</autodoc>
<paramlist>
<param name="maxFiles" type="int" default="9"/>
</paramlist>
</constructor>
<destructor name="~wxFileHistory" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="AddFileToHistory" type="" overloaded="no">
- <autodoc>AddFileToHistory(String file)</autodoc>
+ <autodoc>AddFileToHistory(self, String file)</autodoc>
<paramlist>
<param name="file" type="String" default=""/>
</paramlist>
</method>
<method name="RemoveFileFromHistory" type="" overloaded="no">
- <autodoc>RemoveFileFromHistory(int i)</autodoc>
+ <autodoc>RemoveFileFromHistory(self, int i)</autodoc>
<paramlist>
<param name="i" type="int" default=""/>
</paramlist>
</method>
<method name="GetMaxFiles" type="int" overloaded="no">
- <autodoc>GetMaxFiles() -> int</autodoc>
+ <autodoc>GetMaxFiles(self) -> int</autodoc>
</method>
<method name="UseMenu" type="" overloaded="no">
- <autodoc>UseMenu(Menu menu)</autodoc>
+ <autodoc>UseMenu(self, Menu menu)</autodoc>
<paramlist>
<param name="menu" type="Menu" default=""/>
</paramlist>
</method>
<method name="RemoveMenu" type="" overloaded="no">
- <autodoc>RemoveMenu(Menu menu)</autodoc>
+ <autodoc>RemoveMenu(self, Menu menu)</autodoc>
<paramlist>
<param name="menu" type="Menu" default=""/>
</paramlist>
</method>
<method name="Load" type="" overloaded="no">
- <autodoc>Load(ConfigBase config)</autodoc>
+ <autodoc>Load(self, ConfigBase config)</autodoc>
<paramlist>
<param name="config" type="wxConfigBase" default=""/>
</paramlist>
</method>
<method name="Save" type="" overloaded="no">
- <autodoc>Save(ConfigBase config)</autodoc>
+ <autodoc>Save(self, ConfigBase config)</autodoc>
<paramlist>
<param name="config" type="wxConfigBase" default=""/>
</paramlist>
</method>
<method name="AddFilesToMenu" type="" overloaded="no">
- <autodoc>AddFilesToMenu()</autodoc>
+ <autodoc>AddFilesToMenu(self)</autodoc>
</method>
<method name="AddFilesToThisMenu" type="" overloaded="no">
- <autodoc>AddFilesToThisMenu(Menu menu)</autodoc>
+ <autodoc>AddFilesToThisMenu(self, Menu menu)</autodoc>
<paramlist>
<param name="menu" type="Menu" default=""/>
</paramlist>
</method>
<method name="GetHistoryFile" type="String" overloaded="no">
- <autodoc>GetHistoryFile(int i) -> String</autodoc>
+ <autodoc>GetHistoryFile(self, int i) -> String</autodoc>
<paramlist>
<param name="i" type="int" default=""/>
</paramlist>
</method>
<method name="GetCount" type="int" overloaded="no">
- <autodoc>GetCount() -> int</autodoc>
+ <autodoc>GetCount(self) -> int</autodoc>
</method>
</class>
- <class name="SingleInstanceChecker" oldname="wxSingleInstanceChecker" module="misc">
+ <class name="SingleInstanceChecker" oldname="wxSingleInstanceChecker" module="_misc">
<constructor name="SingleInstanceChecker" overloaded="no">
- <autodoc>__init__(String name, String path=EmptyString) -> SingleInstanceChecker</autodoc>
+ <autodoc>__init__(self, String name, String path=EmptyString) -> SingleInstanceChecker</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="path" type="String" default="wxPyEmptyString"/>
<autodoc>PreSingleInstanceChecker() -> SingleInstanceChecker</autodoc>
</constructor>
<destructor name="~wxSingleInstanceChecker" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(String name, String path=EmptyString) -> bool</autodoc>
+ <autodoc>Create(self, String name, String path=EmptyString) -> bool</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="path" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="IsAnotherRunning" type="bool" overloaded="no">
- <autodoc>IsAnotherRunning() -> bool</autodoc>
+ <autodoc>IsAnotherRunning(self) -> bool</autodoc>
</method>
</class>
<method name="DrawWindowOnDC" oldname="wxDrawWindowOnDC" type="" overloaded="no">
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="TipProvider" oldname="wxTipProvider" module="misc">
+ <class name="TipProvider" oldname="wxTipProvider" module="_misc">
<destructor name="~wxTipProvider" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetTip" type="String" overloaded="no">
- <autodoc>GetTip() -> String</autodoc>
+ <autodoc>GetTip(self) -> String</autodoc>
</method>
<method name="GetCurrentTip" type="size_t" overloaded="no">
- <autodoc>GetCurrentTip() -> size_t</autodoc>
+ <autodoc>GetCurrentTip(self) -> size_t</autodoc>
</method>
<method name="PreprocessTip" type="String" overloaded="no">
- <autodoc>PreprocessTip(String tip) -> String</autodoc>
+ <autodoc>PreprocessTip(self, String tip) -> String</autodoc>
<paramlist>
<param name="tip" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="PyTipProvider" oldname="wxPyTipProvider" module="misc">
+ <class name="PyTipProvider" oldname="wxPyTipProvider" module="_misc">
<baseclass name="TipProvider"/>
<constructor name="PyTipProvider" overloaded="no">
- <autodoc>__init__(size_t currentTip) -> PyTipProvider</autodoc>
+ <autodoc>__init__(self, size_t currentTip) -> PyTipProvider</autodoc>
<paramlist>
<param name="currentTip" type="size_t" default=""/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Timer" oldname="wxPyTimer" module="misc">
+ <class name="Timer" oldname="wxPyTimer" module="_misc">
<baseclass name="EvtHandler"/>
<constructor name="wxPyTimer" overloaded="no">
- <autodoc>__init__(EvtHandler owner=None, int id=-1) -> Timer</autodoc>
+ <autodoc>__init__(self, EvtHandler owner=None, int id=-1) -> Timer</autodoc>
<paramlist>
<param name="owner" type="EvtHandler" default="NULL"/>
<param name="id" type="int" default="-1"/>
</paramlist>
</constructor>
<destructor name="~wxPyTimer" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class, int incref=1)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, int incref=1)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetOwner" type="" overloaded="no">
- <autodoc>SetOwner(EvtHandler owner, int id=-1)</autodoc>
+ <autodoc>SetOwner(self, EvtHandler owner, int id=-1)</autodoc>
<paramlist>
<param name="owner" type="EvtHandler" default=""/>
<param name="id" type="int" default="-1"/>
</paramlist>
</method>
+ <method name="GetOwner" type="EvtHandler" overloaded="no">
+ <autodoc>GetOwner(self) -> EvtHandler</autodoc>
+ </method>
<method name="Start" type="bool" overloaded="no">
- <autodoc>Start(int milliseconds=-1, bool oneShot=False) -> bool</autodoc>
+ <autodoc>Start(self, int milliseconds=-1, bool oneShot=False) -> bool</autodoc>
<paramlist>
<param name="milliseconds" type="int" default="-1"/>
<param name="oneShot" type="bool" default="False"/>
</paramlist>
</method>
<method name="Stop" type="" overloaded="no">
- <autodoc>Stop()</autodoc>
+ <autodoc>Stop(self)</autodoc>
</method>
<method name="IsRunning" type="bool" overloaded="no">
- <autodoc>IsRunning() -> bool</autodoc>
+ <autodoc>IsRunning(self) -> bool</autodoc>
</method>
<method name="GetInterval" type="int" overloaded="no">
- <autodoc>GetInterval() -> int</autodoc>
+ <autodoc>GetInterval(self) -> int</autodoc>
</method>
<method name="IsOneShot" type="bool" overloaded="no">
- <autodoc>IsOneShot() -> bool</autodoc>
+ <autodoc>IsOneShot(self) -> bool</autodoc>
</method>
<method name="GetId" type="int" overloaded="no">
- <autodoc>GetId() -> int</autodoc>
+ <autodoc>GetId(self) -> int</autodoc>
</method>
</class>
<pythoncode>
EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 )
</pythoncode>
- <class name="TimerEvent" oldname="wxTimerEvent" module="misc">
+ <class name="TimerEvent" oldname="wxTimerEvent" module="_misc">
<baseclass name="Event"/>
<constructor name="TimerEvent" overloaded="no">
- <autodoc>__init__(int timerid=0, int interval=0) -> TimerEvent</autodoc>
+ <autodoc>__init__(self, int timerid=0, int interval=0) -> TimerEvent</autodoc>
<paramlist>
<param name="timerid" type="int" default="0"/>
<param name="interval" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetInterval" type="int" overloaded="no">
- <autodoc>GetInterval() -> int</autodoc>
+ <autodoc>GetInterval(self) -> int</autodoc>
</method>
</class>
- <class name="TimerRunner" oldname="wxTimerRunner" module="misc">
+ <class name="TimerRunner" oldname="wxTimerRunner" module="_misc">
<constructor name="TimerRunner" overloaded="yes">
<paramlist>
<param name="timer" type="wxTimer" default=""/>
</paramlist>
</constructor>
<constructor name="TimerRunner" overloaded="yes">
- <autodoc>__init__(wxTimer timer) -> TimerRunner
-__init__(wxTimer timer, int milli, bool oneShot=False) -> TimerRunner</autodoc>
+ <autodoc>__init__(self, wxTimer timer) -> TimerRunner
+__init__(self, wxTimer timer, int milli, bool oneShot=False) -> TimerRunner</autodoc>
<paramlist>
<param name="timer" type="wxTimer" default=""/>
<param name="milli" type="int" default=""/>
</paramlist>
</constructor>
<destructor name="~wxTimerRunner" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Start" type="" overloaded="no">
- <autodoc>Start(int milli, bool oneShot=False)</autodoc>
+ <autodoc>Start(self, int milli, bool oneShot=False)</autodoc>
<paramlist>
<param name="milli" type="int" default=""/>
<param name="oneShot" type="bool" default="False"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Log" oldname="wxLog" module="misc">
+ <class name="Log" oldname="wxLog" module="_misc">
<constructor name="Log" overloaded="no">
- <autodoc>__init__() -> Log</autodoc>
+ <autodoc>__init__(self) -> Log</autodoc>
</constructor>
<staticmethod name="IsEnabled" type="bool" overloaded="no">
<autodoc>IsEnabled() -> bool</autodoc>
</paramlist>
</staticmethod>
<method name="Flush" type="" overloaded="no">
- <autodoc>Flush()</autodoc>
+ <autodoc>Flush(self)</autodoc>
</method>
<staticmethod name="FlushActive" type="" overloaded="no">
<autodoc>FlushActive()</autodoc>
<autodoc>TimeStamp() -> String</autodoc>
</staticmethod>
<method name="Destroy" type="" overloaded="no">
- <autodoc>Destroy()</autodoc>
+ <autodoc>Destroy(self)</autodoc>
</method>
</class>
- <class name="LogStderr" oldname="wxLogStderr" module="misc">
+ <class name="LogStderr" oldname="wxLogStderr" module="_misc">
<baseclass name="Log"/>
<constructor name="LogStderr" overloaded="no">
- <autodoc>__init__() -> LogStderr</autodoc>
+ <autodoc>__init__(self) -> LogStderr</autodoc>
</constructor>
</class>
- <class name="LogTextCtrl" oldname="wxLogTextCtrl" module="misc">
+ <class name="LogTextCtrl" oldname="wxLogTextCtrl" module="_misc">
<baseclass name="Log"/>
<constructor name="LogTextCtrl" overloaded="no">
- <autodoc>__init__(wxTextCtrl pTextCtrl) -> LogTextCtrl</autodoc>
+ <autodoc>__init__(self, wxTextCtrl pTextCtrl) -> LogTextCtrl</autodoc>
<paramlist>
<param name="pTextCtrl" type="TextCtrl" default=""/>
</paramlist>
</constructor>
</class>
- <class name="LogGui" oldname="wxLogGui" module="misc">
+ <class name="LogGui" oldname="wxLogGui" module="_misc">
<baseclass name="Log"/>
<constructor name="LogGui" overloaded="no">
- <autodoc>__init__() -> LogGui</autodoc>
+ <autodoc>__init__(self) -> LogGui</autodoc>
</constructor>
</class>
- <class name="LogWindow" oldname="wxLogWindow" module="misc">
+ <class name="LogWindow" oldname="wxLogWindow" module="_misc">
<baseclass name="Log"/>
<constructor name="LogWindow" overloaded="no">
- <autodoc>__init__(wxFrame pParent, String szTitle, bool bShow=True, bool bPassToOld=True) -> LogWindow</autodoc>
+ <autodoc>__init__(self, wxFrame pParent, String szTitle, bool bShow=True, bool bPassToOld=True) -> LogWindow</autodoc>
<paramlist>
<param name="pParent" type="Frame" default=""/>
<param name="szTitle" type="String" default=""/>
</paramlist>
</constructor>
<method name="Show" type="" overloaded="no">
- <autodoc>Show(bool bShow=True)</autodoc>
+ <autodoc>Show(self, bool bShow=True)</autodoc>
<paramlist>
<param name="bShow" type="bool" default="True"/>
</paramlist>
</method>
<method name="GetFrame" type="Frame" overloaded="no">
- <autodoc>GetFrame() -> wxFrame</autodoc>
+ <autodoc>GetFrame(self) -> wxFrame</autodoc>
</method>
<method name="GetOldLog" type="Log" overloaded="no">
- <autodoc>GetOldLog() -> Log</autodoc>
+ <autodoc>GetOldLog(self) -> Log</autodoc>
</method>
<method name="IsPassingMessages" type="bool" overloaded="no">
- <autodoc>IsPassingMessages() -> bool</autodoc>
+ <autodoc>IsPassingMessages(self) -> bool</autodoc>
</method>
<method name="PassMessages" type="" overloaded="no">
- <autodoc>PassMessages(bool bDoPass)</autodoc>
+ <autodoc>PassMessages(self, bool bDoPass)</autodoc>
<paramlist>
<param name="bDoPass" type="bool" default=""/>
</paramlist>
</method>
</class>
- <class name="LogChain" oldname="wxLogChain" module="misc">
+ <class name="LogChain" oldname="wxLogChain" module="_misc">
<baseclass name="Log"/>
<constructor name="LogChain" overloaded="no">
- <autodoc>__init__(Log logger) -> LogChain</autodoc>
+ <autodoc>__init__(self, Log logger) -> LogChain</autodoc>
<paramlist>
<param name="logger" type="Log" default=""/>
</paramlist>
</constructor>
<method name="SetLog" type="" overloaded="no">
- <autodoc>SetLog(Log logger)</autodoc>
+ <autodoc>SetLog(self, Log logger)</autodoc>
<paramlist>
<param name="logger" type="Log" default=""/>
</paramlist>
</method>
<method name="PassMessages" type="" overloaded="no">
- <autodoc>PassMessages(bool bDoPass)</autodoc>
+ <autodoc>PassMessages(self, bool bDoPass)</autodoc>
<paramlist>
<param name="bDoPass" type="bool" default=""/>
</paramlist>
</method>
<method name="IsPassingMessages" type="bool" overloaded="no">
- <autodoc>IsPassingMessages() -> bool</autodoc>
+ <autodoc>IsPassingMessages(self) -> bool</autodoc>
</method>
<method name="GetOldLog" type="Log" overloaded="no">
- <autodoc>GetOldLog() -> Log</autodoc>
+ <autodoc>GetOldLog(self) -> Log</autodoc>
</method>
</class>
<method name="SysErrorCode" oldname="wxSysErrorCode" type="unsigned long" overloaded="no">
<param name="text" type="String" default=""/>
</paramlist>
</method>
- <class name="LogNull" oldname="wxLogNull" module="misc">
+ <class name="LogNull" oldname="wxLogNull" module="_misc">
<constructor name="LogNull" overloaded="no">
- <autodoc>__init__() -> LogNull</autodoc>
+ <autodoc>__init__(self) -> LogNull</autodoc>
</constructor>
<destructor name="~wxLogNull" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
</class>
- <class name="PyLog" oldname="wxPyLog" module="misc">
+ <class name="PyLog" oldname="wxPyLog" module="_misc">
<baseclass name="Log"/>
<constructor name="PyLog" overloaded="no">
- <autodoc>__init__() -> PyLog</autodoc>
+ <autodoc>__init__(self) -> PyLog</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Process" oldname="wxPyProcess" module="misc">
+ <class name="Process" oldname="wxPyProcess" module="_misc">
<baseclass name="EvtHandler"/>
<constructor name="wxPyProcess" overloaded="no">
- <autodoc>__init__(EvtHandler parent=None, int id=-1) -> Process</autodoc>
+ <autodoc>__init__(self, EvtHandler parent=None, int id=-1) -> Process</autodoc>
<paramlist>
<param name="parent" type="EvtHandler" default="NULL"/>
<param name="id" type="int" default="-1"/>
</paramlist>
</staticmethod>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="base_OnTerminate" type="" overloaded="no">
- <autodoc>base_OnTerminate(int pid, int status)</autodoc>
+ <autodoc>base_OnTerminate(self, int pid, int status)</autodoc>
<paramlist>
<param name="pid" type="int" default=""/>
<param name="status" type="int" default=""/>
</paramlist>
</method>
<method name="Redirect" type="" overloaded="no">
- <autodoc>Redirect()</autodoc>
+ <autodoc>Redirect(self)</autodoc>
</method>
<method name="IsRedirected" type="bool" overloaded="no">
- <autodoc>IsRedirected() -> bool</autodoc>
+ <autodoc>IsRedirected(self) -> bool</autodoc>
</method>
<method name="Detach" type="" overloaded="no">
- <autodoc>Detach()</autodoc>
+ <autodoc>Detach(self)</autodoc>
</method>
<method name="GetInputStream" type="wxInputStream" overloaded="no">
- <autodoc>GetInputStream() -> InputStream</autodoc>
+ <autodoc>GetInputStream(self) -> InputStream</autodoc>
</method>
<method name="GetErrorStream" type="wxInputStream" overloaded="no">
- <autodoc>GetErrorStream() -> InputStream</autodoc>
+ <autodoc>GetErrorStream(self) -> InputStream</autodoc>
</method>
<method name="GetOutputStream" type="OutputStream" overloaded="no">
- <autodoc>GetOutputStream() -> OutputStream</autodoc>
+ <autodoc>GetOutputStream(self) -> OutputStream</autodoc>
</method>
<method name="CloseOutput" type="" overloaded="no">
- <autodoc>CloseOutput()</autodoc>
+ <autodoc>CloseOutput(self)</autodoc>
</method>
<method name="IsInputOpened" type="bool" overloaded="no">
- <autodoc>IsInputOpened() -> bool</autodoc>
+ <autodoc>IsInputOpened(self) -> bool</autodoc>
</method>
<method name="IsInputAvailable" type="bool" overloaded="no">
- <autodoc>IsInputAvailable() -> bool</autodoc>
+ <autodoc>IsInputAvailable(self) -> bool</autodoc>
</method>
<method name="IsErrorAvailable" type="bool" overloaded="no">
- <autodoc>IsErrorAvailable() -> bool</autodoc>
+ <autodoc>IsErrorAvailable(self) -> bool</autodoc>
</method>
</class>
- <class name="ProcessEvent" oldname="wxProcessEvent" module="misc">
+ <class name="ProcessEvent" oldname="wxProcessEvent" module="_misc">
<baseclass name="Event"/>
<constructor name="ProcessEvent" overloaded="no">
- <autodoc>__init__(int id=0, int pid=0, int exitcode=0) -> ProcessEvent</autodoc>
+ <autodoc>__init__(self, int id=0, int pid=0, int exitcode=0) -> ProcessEvent</autodoc>
<paramlist>
<param name="id" type="int" default="0"/>
<param name="pid" type="int" default="0"/>
</paramlist>
</constructor>
<method name="GetPid" type="int" overloaded="no">
- <autodoc>GetPid() -> int</autodoc>
+ <autodoc>GetPid(self) -> int</autodoc>
</method>
<method name="GetExitCode" type="int" overloaded="no">
- <autodoc>GetExitCode() -> int</autodoc>
+ <autodoc>GetExitCode(self) -> int</autodoc>
</method>
<property name="m_pid" type="int" readonly="no"/>
<property name="m_exitcode" type="int" readonly="no"/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Joystick" oldname="wxJoystick" module="misc">
+ <class name="Joystick" oldname="wxJoystick" module="_misc">
<constructor name="Joystick" overloaded="no">
- <autodoc>__init__(int joystick=JOYSTICK1) -> Joystick</autodoc>
+ <autodoc>__init__(self, int joystick=JOYSTICK1) -> Joystick</autodoc>
<paramlist>
<param name="joystick" type="int" default="wxJOYSTICK1"/>
</paramlist>
</constructor>
<destructor name="~wxJoystick" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
</method>
<method name="GetZPosition" type="int" overloaded="no">
- <autodoc>GetZPosition() -> int</autodoc>
+ <autodoc>GetZPosition(self) -> int</autodoc>
</method>
<method name="GetButtonState" type="int" overloaded="no">
- <autodoc>GetButtonState() -> int</autodoc>
+ <autodoc>GetButtonState(self) -> int</autodoc>
</method>
<method name="GetPOVPosition" type="int" overloaded="no">
- <autodoc>GetPOVPosition() -> int</autodoc>
+ <autodoc>GetPOVPosition(self) -> int</autodoc>
</method>
<method name="GetPOVCTSPosition" type="int" overloaded="no">
- <autodoc>GetPOVCTSPosition() -> int</autodoc>
+ <autodoc>GetPOVCTSPosition(self) -> int</autodoc>
</method>
<method name="GetRudderPosition" type="int" overloaded="no">
- <autodoc>GetRudderPosition() -> int</autodoc>
+ <autodoc>GetRudderPosition(self) -> int</autodoc>
</method>
<method name="GetUPosition" type="int" overloaded="no">
- <autodoc>GetUPosition() -> int</autodoc>
+ <autodoc>GetUPosition(self) -> int</autodoc>
</method>
<method name="GetVPosition" type="int" overloaded="no">
- <autodoc>GetVPosition() -> int</autodoc>
+ <autodoc>GetVPosition(self) -> int</autodoc>
</method>
<method name="GetMovementThreshold" type="int" overloaded="no">
- <autodoc>GetMovementThreshold() -> int</autodoc>
+ <autodoc>GetMovementThreshold(self) -> int</autodoc>
</method>
<method name="SetMovementThreshold" type="" overloaded="no">
- <autodoc>SetMovementThreshold(int threshold)</autodoc>
+ <autodoc>SetMovementThreshold(self, int threshold)</autodoc>
<paramlist>
<param name="threshold" type="int" default=""/>
</paramlist>
</method>
<method name="IsOk" type="bool" overloaded="no">
- <autodoc>IsOk() -> bool</autodoc>
+ <autodoc>IsOk(self) -> bool</autodoc>
</method>
<method name="GetNumberJoysticks" type="int" overloaded="no">
- <autodoc>GetNumberJoysticks() -> int</autodoc>
+ <autodoc>GetNumberJoysticks(self) -> int</autodoc>
</method>
<method name="GetManufacturerId" type="int" overloaded="no">
- <autodoc>GetManufacturerId() -> int</autodoc>
+ <autodoc>GetManufacturerId(self) -> int</autodoc>
</method>
<method name="GetProductId" type="int" overloaded="no">
- <autodoc>GetProductId() -> int</autodoc>
+ <autodoc>GetProductId(self) -> int</autodoc>
</method>
<method name="GetProductName" type="String" overloaded="no">
- <autodoc>GetProductName() -> String</autodoc>
+ <autodoc>GetProductName(self) -> String</autodoc>
</method>
<method name="GetXMin" type="int" overloaded="no">
- <autodoc>GetXMin() -> int</autodoc>
+ <autodoc>GetXMin(self) -> int</autodoc>
</method>
<method name="GetYMin" type="int" overloaded="no">
- <autodoc>GetYMin() -> int</autodoc>
+ <autodoc>GetYMin(self) -> int</autodoc>
</method>
<method name="GetZMin" type="int" overloaded="no">
- <autodoc>GetZMin() -> int</autodoc>
+ <autodoc>GetZMin(self) -> int</autodoc>
</method>
<method name="GetXMax" type="int" overloaded="no">
- <autodoc>GetXMax() -> int</autodoc>
+ <autodoc>GetXMax(self) -> int</autodoc>
</method>
<method name="GetYMax" type="int" overloaded="no">
- <autodoc>GetYMax() -> int</autodoc>
+ <autodoc>GetYMax(self) -> int</autodoc>
</method>
<method name="GetZMax" type="int" overloaded="no">
- <autodoc>GetZMax() -> int</autodoc>
+ <autodoc>GetZMax(self) -> int</autodoc>
</method>
<method name="GetNumberButtons" type="int" overloaded="no">
- <autodoc>GetNumberButtons() -> int</autodoc>
+ <autodoc>GetNumberButtons(self) -> int</autodoc>
</method>
<method name="GetNumberAxes" type="int" overloaded="no">
- <autodoc>GetNumberAxes() -> int</autodoc>
+ <autodoc>GetNumberAxes(self) -> int</autodoc>
</method>
<method name="GetMaxButtons" type="int" overloaded="no">
- <autodoc>GetMaxButtons() -> int</autodoc>
+ <autodoc>GetMaxButtons(self) -> int</autodoc>
</method>
<method name="GetMaxAxes" type="int" overloaded="no">
- <autodoc>GetMaxAxes() -> int</autodoc>
+ <autodoc>GetMaxAxes(self) -> int</autodoc>
</method>
<method name="GetPollingMin" type="int" overloaded="no">
- <autodoc>GetPollingMin() -> int</autodoc>
+ <autodoc>GetPollingMin(self) -> int</autodoc>
</method>
<method name="GetPollingMax" type="int" overloaded="no">
- <autodoc>GetPollingMax() -> int</autodoc>
+ <autodoc>GetPollingMax(self) -> int</autodoc>
</method>
<method name="GetRudderMin" type="int" overloaded="no">
- <autodoc>GetRudderMin() -> int</autodoc>
+ <autodoc>GetRudderMin(self) -> int</autodoc>
</method>
<method name="GetRudderMax" type="int" overloaded="no">
- <autodoc>GetRudderMax() -> int</autodoc>
+ <autodoc>GetRudderMax(self) -> int</autodoc>
</method>
<method name="GetUMin" type="int" overloaded="no">
- <autodoc>GetUMin() -> int</autodoc>
+ <autodoc>GetUMin(self) -> int</autodoc>
</method>
<method name="GetUMax" type="int" overloaded="no">
- <autodoc>GetUMax() -> int</autodoc>
+ <autodoc>GetUMax(self) -> int</autodoc>
</method>
<method name="GetVMin" type="int" overloaded="no">
- <autodoc>GetVMin() -> int</autodoc>
+ <autodoc>GetVMin(self) -> int</autodoc>
</method>
<method name="GetVMax" type="int" overloaded="no">
- <autodoc>GetVMax() -> int</autodoc>
+ <autodoc>GetVMax(self) -> int</autodoc>
</method>
<method name="HasRudder" type="bool" overloaded="no">
- <autodoc>HasRudder() -> bool</autodoc>
+ <autodoc>HasRudder(self) -> bool</autodoc>
</method>
<method name="HasZ" type="bool" overloaded="no">
- <autodoc>HasZ() -> bool</autodoc>
+ <autodoc>HasZ(self) -> bool</autodoc>
</method>
<method name="HasU" type="bool" overloaded="no">
- <autodoc>HasU() -> bool</autodoc>
+ <autodoc>HasU(self) -> bool</autodoc>
</method>
<method name="HasV" type="bool" overloaded="no">
- <autodoc>HasV() -> bool</autodoc>
+ <autodoc>HasV(self) -> bool</autodoc>
</method>
<method name="HasPOV" type="bool" overloaded="no">
- <autodoc>HasPOV() -> bool</autodoc>
+ <autodoc>HasPOV(self) -> bool</autodoc>
</method>
<method name="HasPOV4Dir" type="bool" overloaded="no">
- <autodoc>HasPOV4Dir() -> bool</autodoc>
+ <autodoc>HasPOV4Dir(self) -> bool</autodoc>
</method>
<method name="HasPOVCTS" type="bool" overloaded="no">
- <autodoc>HasPOVCTS() -> bool</autodoc>
+ <autodoc>HasPOVCTS(self) -> bool</autodoc>
</method>
<method name="SetCapture" type="bool" overloaded="no">
- <autodoc>SetCapture(Window win, int pollingFreq=0) -> bool</autodoc>
+ <autodoc>SetCapture(self, Window win, int pollingFreq=0) -> bool</autodoc>
<paramlist>
<param name="win" type="Window" default=""/>
<param name="pollingFreq" type="int" default="0"/>
</paramlist>
</method>
<method name="ReleaseCapture" type="bool" overloaded="no">
- <autodoc>ReleaseCapture() -> bool</autodoc>
+ <autodoc>ReleaseCapture(self) -> bool</autodoc>
</method>
</class>
- <class name="JoystickEvent" oldname="wxJoystickEvent" module="misc">
+ <class name="JoystickEvent" oldname="wxJoystickEvent" module="_misc">
<baseclass name="Event"/>
<constructor name="JoystickEvent" overloaded="no">
- <autodoc>__init__(wxEventType type=wxEVT_NULL, int state=0, int joystick=JOYSTICK1,
+ <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int state=0, int joystick=JOYSTICK1,
int change=0) -> JoystickEvent</autodoc>
<paramlist>
<param name="type" type="wxEventType" default="wxEVT_NULL"/>
<property name="m_buttonState" type="int" readonly="no"/>
<property name="m_joyStick" type="int" readonly="no"/>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
</method>
<method name="GetZPosition" type="int" overloaded="no">
- <autodoc>GetZPosition() -> int</autodoc>
+ <autodoc>GetZPosition(self) -> int</autodoc>
</method>
<method name="GetButtonState" type="int" overloaded="no">
- <autodoc>GetButtonState() -> int</autodoc>
+ <autodoc>GetButtonState(self) -> int</autodoc>
</method>
<method name="GetButtonChange" type="int" overloaded="no">
- <autodoc>GetButtonChange() -> int</autodoc>
+ <autodoc>GetButtonChange(self) -> int</autodoc>
</method>
<method name="GetJoystick" type="int" overloaded="no">
- <autodoc>GetJoystick() -> int</autodoc>
+ <autodoc>GetJoystick(self) -> int</autodoc>
</method>
<method name="SetJoystick" type="" overloaded="no">
- <autodoc>SetJoystick(int stick)</autodoc>
+ <autodoc>SetJoystick(self, int stick)</autodoc>
<paramlist>
<param name="stick" type="int" default=""/>
</paramlist>
</method>
<method name="SetButtonState" type="" overloaded="no">
- <autodoc>SetButtonState(int state)</autodoc>
+ <autodoc>SetButtonState(self, int state)</autodoc>
<paramlist>
<param name="state" type="int" default=""/>
</paramlist>
</method>
<method name="SetButtonChange" type="" overloaded="no">
- <autodoc>SetButtonChange(int change)</autodoc>
+ <autodoc>SetButtonChange(self, int change)</autodoc>
<paramlist>
<param name="change" type="int" default=""/>
</paramlist>
</method>
<method name="SetPosition" type="" overloaded="no">
- <autodoc>SetPosition(Point pos)</autodoc>
+ <autodoc>SetPosition(self, Point pos)</autodoc>
<paramlist>
<param name="pos" type="Point" default=""/>
</paramlist>
</method>
<method name="SetZPosition" type="" overloaded="no">
- <autodoc>SetZPosition(int zPos)</autodoc>
+ <autodoc>SetZPosition(self, int zPos)</autodoc>
<paramlist>
<param name="zPos" type="int" default=""/>
</paramlist>
</method>
<method name="IsButton" type="bool" overloaded="no">
- <autodoc>IsButton() -> bool</autodoc>
+ <autodoc>IsButton(self) -> bool</autodoc>
</method>
<method name="IsMove" type="bool" overloaded="no">
- <autodoc>IsMove() -> bool</autodoc>
+ <autodoc>IsMove(self) -> bool</autodoc>
</method>
<method name="IsZMove" type="bool" overloaded="no">
- <autodoc>IsZMove() -> bool</autodoc>
+ <autodoc>IsZMove(self) -> bool</autodoc>
</method>
<method name="ButtonDown" type="bool" overloaded="no">
- <autodoc>ButtonDown(int but=JOY_BUTTON_ANY) -> bool</autodoc>
+ <autodoc>ButtonDown(self, int but=JOY_BUTTON_ANY) -> bool</autodoc>
<paramlist>
<param name="but" type="int" default="wxJOY_BUTTON_ANY"/>
</paramlist>
</method>
<method name="ButtonUp" type="bool" overloaded="no">
- <autodoc>ButtonUp(int but=JOY_BUTTON_ANY) -> bool</autodoc>
+ <autodoc>ButtonUp(self, int but=JOY_BUTTON_ANY) -> bool</autodoc>
<paramlist>
<param name="but" type="int" default="wxJOY_BUTTON_ANY"/>
</paramlist>
</method>
<method name="ButtonIsDown" type="bool" overloaded="no">
- <autodoc>ButtonIsDown(int but=JOY_BUTTON_ANY) -> bool</autodoc>
+ <autodoc>ButtonIsDown(self, int but=JOY_BUTTON_ANY) -> bool</autodoc>
<paramlist>
<param name="but" type="int" default="wxJOY_BUTTON_ANY"/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Sound" oldname="wxSound" module="misc">
- <constructor name="Sound" overloaded="yes"/>
- <constructor name="Sound" overloaded="yes">
+ <class name="Sound" oldname="wxSound" module="_misc">
+ <constructor name="Sound" overloaded="no">
+ <autodoc>__init__(self, String fileName=EmptyString) -> Sound</autodoc>
<paramlist>
- <param name="fileName" type="String" default=""/>
- <param name="isResource" type="bool" default="false"/>
+ <param name="fileName" type="String" default="wxPyEmptyString"/>
</paramlist>
</constructor>
- <constructor name="Sound" overloaded="yes">
- <autodoc>__init__() -> Sound
-__init__(String fileName, bool isResource=false) -> Sound
-__init__(int size, wxByte data) -> Sound</autodoc>
+ <constructor name="SoundFromData" overloaded="no">
+ <autodoc>SoundFromData(PyObject data) -> Sound</autodoc>
<paramlist>
- <param name="size" type="int" default=""/>
- <param name="data" type="wxByte" default=""/>
+ <param name="data" type="PyObject" default=""/>
</paramlist>
</constructor>
<destructor name="~wxSound" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
- <method name="Create" type="bool" overloaded="yes">
+ <method name="Create" type="bool" overloaded="no">
+ <autodoc>Create(self, String fileName) -> bool</autodoc>
<paramlist>
<param name="fileName" type="String" default=""/>
- <param name="isResource" type="bool" default="false"/>
</paramlist>
</method>
- <method name="Create" type="bool" overloaded="yes">
- <autodoc>Create(String fileName, bool isResource=false) -> bool
-Create(int size, wxByte data) -> bool</autodoc>
+ <method name="CreateFromData" type="bool" overloaded="no">
+ <autodoc>CreateFromData(self, PyObject data) -> bool</autodoc>
<paramlist>
- <param name="size" type="int" default=""/>
- <param name="data" type="wxByte" default=""/>
+ <param name="data" type="PyObject" default=""/>
</paramlist>
</method>
<method name="IsOk" type="bool" overloaded="no">
- <autodoc>IsOk() -> bool</autodoc>
+ <autodoc>IsOk(self) -> bool</autodoc>
</method>
<method name="Play" type="bool" overloaded="no">
- <autodoc>Play(unsigned int flags=SOUND_ASYNC) -> bool</autodoc>
+ <autodoc>Play(self, unsigned int flags=SOUND_ASYNC) -> bool</autodoc>
<paramlist>
<param name="flags" type="unsigned int" default="wxSOUND_ASYNC"/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="FileTypeInfo" oldname="wxFileTypeInfo" module="misc">
+ <class name="FileTypeInfo" oldname="wxFileTypeInfo" module="_misc">
<constructor name="FileTypeInfo" overloaded="no">
- <autodoc>__init__(String mimeType, String openCmd, String printCmd, String desc) -> FileTypeInfo</autodoc>
+ <autodoc>__init__(self, String mimeType, String openCmd, String printCmd, String desc) -> FileTypeInfo</autodoc>
<paramlist>
<param name="mimeType" type="String" default=""/>
<param name="openCmd" type="String" default=""/>
<autodoc>NullFileTypeInfo() -> FileTypeInfo</autodoc>
</constructor>
<method name="IsValid" type="bool" overloaded="no">
- <autodoc>IsValid() -> bool</autodoc>
+ <autodoc>IsValid(self) -> bool</autodoc>
</method>
<method name="SetIcon" type="" overloaded="no">
- <autodoc>SetIcon(String iconFile, int iconIndex=0)</autodoc>
+ <autodoc>SetIcon(self, String iconFile, int iconIndex=0)</autodoc>
<paramlist>
<param name="iconFile" type="String" default=""/>
<param name="iconIndex" type="int" default="0"/>
</paramlist>
</method>
<method name="SetShortDesc" type="" overloaded="no">
- <autodoc>SetShortDesc(String shortDesc)</autodoc>
+ <autodoc>SetShortDesc(self, String shortDesc)</autodoc>
<paramlist>
<param name="shortDesc" type="String" default=""/>
</paramlist>
</method>
<method name="GetMimeType" type="String" overloaded="no">
- <autodoc>GetMimeType() -> String</autodoc>
+ <autodoc>GetMimeType(self) -> String</autodoc>
</method>
<method name="GetOpenCommand" type="String" overloaded="no">
- <autodoc>GetOpenCommand() -> String</autodoc>
+ <autodoc>GetOpenCommand(self) -> String</autodoc>
</method>
<method name="GetPrintCommand" type="String" overloaded="no">
- <autodoc>GetPrintCommand() -> String</autodoc>
+ <autodoc>GetPrintCommand(self) -> String</autodoc>
</method>
<method name="GetShortDesc" type="String" overloaded="no">
- <autodoc>GetShortDesc() -> String</autodoc>
+ <autodoc>GetShortDesc(self) -> String</autodoc>
</method>
<method name="GetDescription" type="String" overloaded="no">
- <autodoc>GetDescription() -> String</autodoc>
+ <autodoc>GetDescription(self) -> String</autodoc>
</method>
<method name="GetExtensions" type="wxArrayString" overloaded="no">
- <autodoc>GetExtensions() -> wxArrayString</autodoc>
+ <autodoc>GetExtensions(self) -> wxArrayString</autodoc>
</method>
<method name="GetExtensionsCount" type="int" overloaded="no">
- <autodoc>GetExtensionsCount() -> int</autodoc>
+ <autodoc>GetExtensionsCount(self) -> int</autodoc>
</method>
<method name="GetIconFile" type="String" overloaded="no">
- <autodoc>GetIconFile() -> String</autodoc>
+ <autodoc>GetIconFile(self) -> String</autodoc>
</method>
<method name="GetIconIndex" type="int" overloaded="no">
- <autodoc>GetIconIndex() -> int</autodoc>
+ <autodoc>GetIconIndex(self) -> int</autodoc>
</method>
</class>
- <class name="FileType" oldname="wxFileType" module="misc">
+ <class name="FileType" oldname="wxFileType" module="_misc">
<constructor name="FileType" overloaded="no">
- <autodoc>__init__(FileTypeInfo ftInfo) -> FileType</autodoc>
+ <autodoc>__init__(self, FileTypeInfo ftInfo) -> FileType</autodoc>
<paramlist>
<param name="ftInfo" type="FileTypeInfo" default=""/>
</paramlist>
</constructor>
<destructor name="~wxFileType" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetMimeType" type="PyObject" overloaded="no">
- <autodoc>GetMimeType() -> PyObject</autodoc>
+ <autodoc>GetMimeType(self) -> PyObject</autodoc>
</method>
<method name="GetMimeTypes" type="PyObject" overloaded="no">
- <autodoc>GetMimeTypes() -> PyObject</autodoc>
+ <autodoc>GetMimeTypes(self) -> PyObject</autodoc>
</method>
<method name="GetExtensions" type="PyObject" overloaded="no">
- <autodoc>GetExtensions() -> PyObject</autodoc>
+ <autodoc>GetExtensions(self) -> PyObject</autodoc>
</method>
<method name="GetIcon" type="Icon" overloaded="no">
- <autodoc>GetIcon() -> Icon</autodoc>
+ <autodoc>GetIcon(self) -> Icon</autodoc>
</method>
<method name="GetIconInfo" type="PyObject" overloaded="no">
- <autodoc>GetIconInfo() -> PyObject</autodoc>
+ <autodoc>GetIconInfo(self) -> PyObject</autodoc>
</method>
<method name="GetDescription" type="PyObject" overloaded="no">
- <autodoc>GetDescription() -> PyObject</autodoc>
+ <autodoc>GetDescription(self) -> PyObject</autodoc>
</method>
<method name="GetOpenCommand" type="PyObject" overloaded="no">
- <autodoc>GetOpenCommand(String filename, String mimetype=EmptyString) -> PyObject</autodoc>
+ <autodoc>GetOpenCommand(self, String filename, String mimetype=EmptyString) -> PyObject</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
<param name="mimetype" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="GetPrintCommand" type="PyObject" overloaded="no">
- <autodoc>GetPrintCommand(String filename, String mimetype=EmptyString) -> PyObject</autodoc>
+ <autodoc>GetPrintCommand(self, String filename, String mimetype=EmptyString) -> PyObject</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
<param name="mimetype" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="GetAllCommands" type="PyObject" overloaded="no">
- <autodoc>GetAllCommands(String filename, String mimetype=EmptyString) -> PyObject</autodoc>
+ <autodoc>GetAllCommands(self, String filename, String mimetype=EmptyString) -> PyObject</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
<param name="mimetype" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="SetCommand" type="bool" overloaded="no">
- <autodoc>SetCommand(String cmd, String verb, bool overwriteprompt=True) -> bool</autodoc>
+ <autodoc>SetCommand(self, String cmd, String verb, bool overwriteprompt=True) -> bool</autodoc>
<paramlist>
<param name="cmd" type="String" default=""/>
<param name="verb" type="String" default=""/>
</paramlist>
</method>
<method name="SetDefaultIcon" type="bool" overloaded="no">
- <autodoc>SetDefaultIcon(String cmd=EmptyString, int index=0) -> bool</autodoc>
+ <autodoc>SetDefaultIcon(self, String cmd=EmptyString, int index=0) -> bool</autodoc>
<paramlist>
<param name="cmd" type="String" default="wxPyEmptyString"/>
<param name="index" type="int" default="0"/>
</paramlist>
</method>
<method name="Unassociate" type="bool" overloaded="no">
- <autodoc>Unassociate() -> bool</autodoc>
+ <autodoc>Unassociate(self) -> bool</autodoc>
</method>
<staticmethod name="ExpandCommand" type="String" overloaded="no">
<autodoc>ExpandCommand(String command, String filename, String mimetype=EmptyString) -> String</autodoc>
</paramlist>
</staticmethod>
</class>
- <class name="MimeTypesManager" oldname="wxMimeTypesManager" module="misc">
+ <class name="MimeTypesManager" oldname="wxMimeTypesManager" module="_misc">
<constructor name="MimeTypesManager" overloaded="no">
- <autodoc>__init__() -> MimeTypesManager</autodoc>
+ <autodoc>__init__(self) -> MimeTypesManager</autodoc>
</constructor>
<destructor name="~wxMimeTypesManager" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<staticmethod name="IsOfType" type="bool" overloaded="no">
<autodoc>IsOfType(String mimeType, String wildcard) -> bool</autodoc>
</paramlist>
</staticmethod>
<method name="Initialize" type="" overloaded="no">
- <autodoc>Initialize(int mailcapStyle=MAILCAP_ALL, String extraDir=EmptyString)</autodoc>
+ <autodoc>Initialize(self, int mailcapStyle=MAILCAP_ALL, String extraDir=EmptyString)</autodoc>
<paramlist>
<param name="mailcapStyle" type="int" default="wxMAILCAP_ALL"/>
<param name="extraDir" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="ClearData" type="" overloaded="no">
- <autodoc>ClearData()</autodoc>
+ <autodoc>ClearData(self)</autodoc>
</method>
<method name="GetFileTypeFromExtension" type="FileType" overloaded="no">
- <autodoc>GetFileTypeFromExtension(String ext) -> FileType</autodoc>
+ <autodoc>GetFileTypeFromExtension(self, String ext) -> FileType</autodoc>
<paramlist>
<param name="ext" type="String" default=""/>
</paramlist>
</method>
<method name="GetFileTypeFromMimeType" type="FileType" overloaded="no">
- <autodoc>GetFileTypeFromMimeType(String mimeType) -> FileType</autodoc>
+ <autodoc>GetFileTypeFromMimeType(self, String mimeType) -> FileType</autodoc>
<paramlist>
<param name="mimeType" type="String" default=""/>
</paramlist>
</method>
<method name="ReadMailcap" type="bool" overloaded="no">
- <autodoc>ReadMailcap(String filename, bool fallback=False) -> bool</autodoc>
+ <autodoc>ReadMailcap(self, String filename, bool fallback=False) -> bool</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
<param name="fallback" type="bool" default="False"/>
</paramlist>
</method>
<method name="ReadMimeTypes" type="bool" overloaded="no">
- <autodoc>ReadMimeTypes(String filename) -> bool</autodoc>
+ <autodoc>ReadMimeTypes(self, String filename) -> bool</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
</paramlist>
</method>
<method name="EnumAllFileTypes" type="PyObject" overloaded="no">
- <autodoc>EnumAllFileTypes() -> PyObject</autodoc>
+ <autodoc>EnumAllFileTypes(self) -> PyObject</autodoc>
</method>
<method name="AddFallback" type="" overloaded="no">
- <autodoc>AddFallback(FileTypeInfo ft)</autodoc>
+ <autodoc>AddFallback(self, FileTypeInfo ft)</autodoc>
<paramlist>
<param name="ft" type="FileTypeInfo" default=""/>
</paramlist>
</method>
<method name="Associate" type="FileType" overloaded="no">
- <autodoc>Associate(FileTypeInfo ftInfo) -> FileType</autodoc>
+ <autodoc>Associate(self, FileTypeInfo ftInfo) -> FileType</autodoc>
<paramlist>
<param name="ftInfo" type="FileTypeInfo" default=""/>
</paramlist>
</method>
<method name="Unassociate" type="bool" overloaded="no">
- <autodoc>Unassociate(FileType ft) -> bool</autodoc>
+ <autodoc>Unassociate(self, FileType ft) -> bool</autodoc>
<paramlist>
<param name="ft" type="FileType" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ArtProvider" oldname="wxPyArtProvider" module="misc">
+ <class name="ArtProvider" oldname="wxPyArtProvider" module="_misc">
+ <docstring>The wx.ArtProvider class is used to customize the look of wxWidgets
+application. When wxWidgets needs to display an icon or a bitmap (e.g.
+in the standard file dialog), it does not use hard-coded resource but
+asks wx.ArtProvider for it instead. This way the users can plug in
+their own wx.ArtProvider class and easily replace standard art with
+his/her own version. It is easy thing to do: all that is needed is
+to derive a class from wx.ArtProvider, override it's CreateBitmap
+method and register the provider with wx.ArtProvider.PushProvider::
+
+ class MyArtProvider(wx.ArtProvider):
+ def __init__(self):
+ wx.ArtProvider.__init__(self)
+
+ def CreateBitmap(self, artid, client, size):
+ ...
+ return bmp
+</docstring>
<constructor name="wxPyArtProvider" overloaded="no">
- <autodoc>__init__() -> ArtProvider</autodoc>
+ <autodoc>__init__(self) -> ArtProvider</autodoc>
+ <docstring>The wx.ArtProvider class is used to customize the look of wxWidgets
+application. When wxWidgets needs to display an icon or a bitmap (e.g.
+in the standard file dialog), it does not use hard-coded resource but
+asks wx.ArtProvider for it instead. This way the users can plug in
+their own wx.ArtProvider class and easily replace standard art with
+his/her own version. It is easy thing to do: all that is needed is
+to derive a class from wx.ArtProvider, override it's CreateBitmap
+method and register the provider with wx.ArtProvider.PushProvider::
+
+ class MyArtProvider(wx.ArtProvider):
+ def __init__(self):
+ wx.ArtProvider.__init__(self)
+
+ def CreateBitmap(self, artid, client, size):
+ ...
+ return bmp
+</docstring>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</staticmethod>
<staticmethod name="RemoveProvider" type="bool" overloaded="no">
<autodoc>RemoveProvider(ArtProvider provider) -> bool</autodoc>
- <docstring>Remove provider. The provider must have been added previously!
-The provider is _not_ deleted.</docstring>
+ <docstring>Remove provider. The provider must have been added previously! The
+provider is _not_ deleted.</docstring>
<paramlist>
<param name="provider" type="ArtProvider" default=""/>
</paramlist>
</staticmethod>
<staticmethod name="GetIcon" type="Icon" overloaded="no">
<autodoc>GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -> Icon</autodoc>
- <docstring>Query the providers for icon with given ID and return it. Return
+ <docstring>Query the providers for icon with given ID and return it. Return
wx.NullIcon if no provider provides it.</docstring>
<paramlist>
<param name="id" type="String" default=""/>
</paramlist>
</staticmethod>
<method name="Destroy" type="" overloaded="no">
- <autodoc>Destroy()</autodoc>
+ <autodoc>Destroy(self)</autodoc>
</method>
</class>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="ConfigBase" oldname="wxConfigBase" module="misc">
+ <class name="ConfigBase" oldname="wxConfigBase" module="_misc">
<docstring>wx.ConfigBase class defines the basic interface of all config
-classes. It can not be used by itself (it is an abstract base
-class) and you will always use one of its derivations: wx.Config
-or wx.FileConfig.
-
-wx.ConfigBase organizes the items in a tree-like structure,
-modeled after the Unix/Dos filesystem. There are groups that act
-like directories and entries, key/value pairs that act like
-files. There is always one current group given by the current
-path. As in the file system case, to specify a key in the config
-class you must use a path to it. Config classes also support the
-notion of the current group, which makes it possible to use
-relative paths.
+classes. It can not be used by itself (it is an abstract base class)
+and you will always use one of its derivations: wx.Config or
+wx.FileConfig.
+
+wx.ConfigBase organizes the items in a tree-like structure, modeled
+after the Unix/Dos filesystem. There are groups that act like
+directories and entries, key/value pairs that act like files. There
+is always one current group given by the current path. As in the file
+system case, to specify a key in the config class you must use a path
+to it. Config classes also support the notion of the current group,
+which makes it possible to use relative paths.
Keys are pairs "key_name = value" where value may be of string,
integer floating point or boolean, you can not store binary data
-without first encoding it as a string. For performance reasons
-items should be kept small, no more than a couple kilobytes.
+without first encoding it as a string. For performance reasons items
+should be kept small, no more than a couple kilobytes.
</docstring>
<destructor name="~wxConfigBase" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<staticmethod name="Set" type="ConfigBase" overloaded="no">
<autodoc>Set(ConfigBase config) -> ConfigBase</autodoc>
- <docstring>Sets the global config object (the one returned by Get) and
-returns a reference to the previous global config object.</docstring>
+ <docstring>Sets the global config object (the one returned by Get) and returns a
+reference to the previous global config object.</docstring>
<paramlist>
<param name="config" type="ConfigBase" default=""/>
</paramlist>
</staticmethod>
<staticmethod name="DontCreateOnDemand" type="" overloaded="no">
<autodoc>DontCreateOnDemand()</autodoc>
- <docstring>Should Get() try to create a new log object if there isn't a current one?</docstring>
+ <docstring>Should Get() try to create a new log object if there isn't a current
+one?</docstring>
</staticmethod>
<method name="SetPath" type="" overloaded="no">
- <autodoc>SetPath(String path)</autodoc>
- <docstring>Set current path: if the first character is '/', it's the absolute path,
-otherwise it's a relative path. '..' is supported. If the strPath
-doesn't exist it is created.</docstring>
+ <autodoc>SetPath(self, String path)</autodoc>
+ <docstring>Set current path: if the first character is '/', it's the absolute
+path, otherwise it's a relative path. '..' is supported. If the
+strPath doesn't exist it is created.</docstring>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="GetPath" type="String" overloaded="no">
- <autodoc>GetPath() -> String</autodoc>
+ <autodoc>GetPath(self) -> String</autodoc>
<docstring>Retrieve the current path (always as absolute path)</docstring>
</method>
<method name="GetFirstGroup" type="PyObject" overloaded="no">
<autodoc>GetFirstGroup() -> (more, value, index)</autodoc>
- <docstring>Allows enumerating the subgroups in a config object. Returns
-a tuple containing a flag indicating there are more items, the
-name of the current item, and an index to pass to GetNextGroup to
-fetch the next item.</docstring>
+ <docstring>Allows enumerating the subgroups in a config object. Returns a tuple
+containing a flag indicating there are more items, the name of the
+current item, and an index to pass to GetNextGroup to fetch the next
+item.</docstring>
</method>
<method name="GetNextGroup" type="PyObject" overloaded="no">
<autodoc>GetNextGroup(long index) -> (more, value, index)</autodoc>
- <docstring>Allows enumerating the subgroups in a config object. Returns
-a tuple containing a flag indicating there are more items, the
-name of the current item, and an index to pass to GetNextGroup to
-fetch the next item.</docstring>
+ <docstring>Allows enumerating the subgroups in a config object. Returns a tuple
+containing a flag indicating there are more items, the name of the
+current item, and an index to pass to GetNextGroup to fetch the next
+item.</docstring>
<paramlist>
<param name="index" type="long" default=""/>
</paramlist>
<method name="GetFirstEntry" type="PyObject" overloaded="no">
<autodoc>GetFirstEntry() -> (more, value, index)</autodoc>
<docstring>Allows enumerating the entries in the current group in a config
-object. Returns a tuple containing a flag indicating there are
-more items, the name of the current item, and an index to pass to
+object. Returns a tuple containing a flag indicating there are more
+items, the name of the current item, and an index to pass to
GetNextGroup to fetch the next item.</docstring>
</method>
<method name="GetNextEntry" type="PyObject" overloaded="no">
<autodoc>GetNextEntry(long index) -> (more, value, index)</autodoc>
<docstring>Allows enumerating the entries in the current group in a config
-object. Returns a tuple containing a flag indicating there are
-more items, the name of the current item, and an index to pass to
+object. Returns a tuple containing a flag indicating there are more
+items, the name of the current item, and an index to pass to
GetNextGroup to fetch the next item.</docstring>
<paramlist>
<param name="index" type="long" default=""/>
</paramlist>
</method>
<method name="GetNumberOfEntries" type="size_t" overloaded="no">
- <autodoc>GetNumberOfEntries(bool recursive=False) -> size_t</autodoc>
- <docstring>Get the number of entries in the current group, with or
-without its subgroups.</docstring>
+ <autodoc>GetNumberOfEntries(self, bool recursive=False) -> size_t</autodoc>
+ <docstring>Get the number of entries in the current group, with or without its
+subgroups.</docstring>
<paramlist>
<param name="recursive" type="bool" default="False"/>
</paramlist>
</method>
<method name="GetNumberOfGroups" type="size_t" overloaded="no">
- <autodoc>GetNumberOfGroups(bool recursive=False) -> size_t</autodoc>
- <docstring>Get the number of subgroups in the current group, with or
-without its subgroups.</docstring>
+ <autodoc>GetNumberOfGroups(self, bool recursive=False) -> size_t</autodoc>
+ <docstring>Get the number of subgroups in the current group, with or without its
+subgroups.</docstring>
<paramlist>
<param name="recursive" type="bool" default="False"/>
</paramlist>
</method>
<method name="HasGroup" type="bool" overloaded="no">
- <autodoc>HasGroup(String name) -> bool</autodoc>
+ <autodoc>HasGroup(self, String name) -> bool</autodoc>
<docstring>Returns True if the group by this name exists</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="HasEntry" type="bool" overloaded="no">
- <autodoc>HasEntry(String name) -> bool</autodoc>
+ <autodoc>HasEntry(self, String name) -> bool</autodoc>
<docstring>Returns True if the entry by this name exists</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="Exists" type="bool" overloaded="no">
- <autodoc>Exists(String name) -> bool</autodoc>
+ <autodoc>Exists(self, String name) -> bool</autodoc>
<docstring>Returns True if either a group or an entry with a given name exists</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="GetEntryType" type="wxConfigBase::EntryType" overloaded="no">
- <autodoc>GetEntryType(String name) -> int</autodoc>
+ <autodoc>GetEntryType(self, String name) -> int</autodoc>
<docstring>Get the type of the entry. Returns one of the wx.Config.Type_XXX values.</docstring>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="Read" type="String" overloaded="no">
- <autodoc>Read(String key, String defaultVal=EmptyString) -> String</autodoc>
+ <autodoc>Read(self, String key, String defaultVal=EmptyString) -> String</autodoc>
<docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring>
<paramlist>
<param name="key" type="String" default=""/>
</paramlist>
</method>
<method name="ReadInt" type="long" overloaded="no">
- <autodoc>ReadInt(String key, long defaultVal=0) -> long</autodoc>
+ <autodoc>ReadInt(self, String key, long defaultVal=0) -> long</autodoc>
<docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring>
<paramlist>
<param name="key" type="String" default=""/>
</paramlist>
</method>
<method name="ReadFloat" type="double" overloaded="no">
- <autodoc>ReadFloat(String key, double defaultVal=0.0) -> double</autodoc>
+ <autodoc>ReadFloat(self, String key, double defaultVal=0.0) -> double</autodoc>
<docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring>
<paramlist>
<param name="key" type="String" default=""/>
</paramlist>
</method>
<method name="ReadBool" type="bool" overloaded="no">
- <autodoc>ReadBool(String key, bool defaultVal=False) -> bool</autodoc>
+ <autodoc>ReadBool(self, String key, bool defaultVal=False) -> bool</autodoc>
<docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring>
<paramlist>
<param name="key" type="String" default=""/>
</paramlist>
</method>
<method name="Write" type="bool" overloaded="no">
- <autodoc>Write(String key, String value) -> bool</autodoc>
+ <autodoc>Write(self, String key, String value) -> bool</autodoc>
<docstring>write the value (return True on success)</docstring>
<paramlist>
<param name="key" type="String" default=""/>
</paramlist>
</method>
<method name="WriteInt" type="bool" overloaded="no">
- <autodoc>WriteInt(String key, long value) -> bool</autodoc>
+ <autodoc>WriteInt(self, String key, long value) -> bool</autodoc>
<docstring>write the value (return True on success)</docstring>
<paramlist>
<param name="key" type="String" default=""/>
</paramlist>
</method>
<method name="WriteFloat" type="bool" overloaded="no">
- <autodoc>WriteFloat(String key, double value) -> bool</autodoc>
+ <autodoc>WriteFloat(self, String key, double value) -> bool</autodoc>
<docstring>write the value (return True on success)</docstring>
<paramlist>
<param name="key" type="String" default=""/>
</paramlist>
</method>
<method name="WriteBool" type="bool" overloaded="no">
- <autodoc>WriteBool(String key, bool value) -> bool</autodoc>
+ <autodoc>WriteBool(self, String key, bool value) -> bool</autodoc>
<docstring>write the value (return True on success)</docstring>
<paramlist>
<param name="key" type="String" default=""/>
</paramlist>
</method>
<method name="Flush" type="bool" overloaded="no">
- <autodoc>Flush(bool currentOnly=False) -> bool</autodoc>
+ <autodoc>Flush(self, bool currentOnly=False) -> bool</autodoc>
<docstring>permanently writes all changes</docstring>
<paramlist>
<param name="currentOnly" type="bool" default="False"/>
</paramlist>
</method>
<method name="RenameEntry" type="bool" overloaded="no">
- <autodoc>RenameEntry(String oldName, String newName) -> bool</autodoc>
+ <autodoc>RenameEntry(self, String oldName, String newName) -> bool</autodoc>
<docstring>Rename an entry. Returns False on failure (probably because the new
name is already taken by an existing entry)</docstring>
<paramlist>
</paramlist>
</method>
<method name="RenameGroup" type="bool" overloaded="no">
- <autodoc>RenameGroup(String oldName, String newName) -> bool</autodoc>
- <docstring>Rename aa group. Returns False on failure (probably because the new
+ <autodoc>RenameGroup(self, String oldName, String newName) -> bool</autodoc>
+ <docstring>Rename a group. Returns False on failure (probably because the new
name is already taken by an existing entry)</docstring>
<paramlist>
<param name="oldName" type="String" default=""/>
</paramlist>
</method>
<method name="DeleteEntry" type="bool" overloaded="no">
- <autodoc>DeleteEntry(String key, bool deleteGroupIfEmpty=True) -> bool</autodoc>
- <docstring>Deletes the specified entry and the group it belongs to if
-it was the last key in it and the second parameter is True</docstring>
+ <autodoc>DeleteEntry(self, String key, bool deleteGroupIfEmpty=True) -> bool</autodoc>
+ <docstring>Deletes the specified entry and the group it belongs to if it was the
+last key in it and the second parameter is True</docstring>
<paramlist>
<param name="key" type="String" default=""/>
<param name="deleteGroupIfEmpty" type="bool" default="True"/>
</paramlist>
</method>
<method name="DeleteGroup" type="bool" overloaded="no">
- <autodoc>DeleteGroup(String key) -> bool</autodoc>
+ <autodoc>DeleteGroup(self, String key) -> bool</autodoc>
<docstring>Delete the group (with all subgroups)</docstring>
<paramlist>
<param name="key" type="String" default=""/>
</paramlist>
</method>
<method name="DeleteAll" type="bool" overloaded="no">
- <autodoc>DeleteAll() -> bool</autodoc>
+ <autodoc>DeleteAll(self) -> bool</autodoc>
<docstring>Delete the whole underlying object (disk file, registry key, ...)
-primarly intended for use by desinstallation routine.</docstring>
+primarly intended for use by deinstallation routine.</docstring>
</method>
<method name="SetExpandEnvVars" type="" overloaded="no">
- <autodoc>SetExpandEnvVars(bool doIt=True)</autodoc>
- <docstring>We can automatically expand environment variables in the config entries
-(this option is on by default, you can turn it on/off at any time)</docstring>
+ <autodoc>SetExpandEnvVars(self, bool doIt=True)</autodoc>
+ <docstring>We can automatically expand environment variables in the config
+entries this option is on by default, you can turn it on/off at any
+time)</docstring>
<paramlist>
<param name="doIt" type="bool" default="True"/>
</paramlist>
</method>
<method name="IsExpandingEnvVars" type="bool" overloaded="no">
- <autodoc>IsExpandingEnvVars() -> bool</autodoc>
+ <autodoc>IsExpandingEnvVars(self) -> bool</autodoc>
<docstring>Are we currently expanding environment variables?</docstring>
</method>
<method name="SetRecordDefaults" type="" overloaded="no">
- <autodoc>SetRecordDefaults(bool doIt=True)</autodoc>
+ <autodoc>SetRecordDefaults(self, bool doIt=True)</autodoc>
<docstring>Set whether the config objec should record default values.</docstring>
<paramlist>
<param name="doIt" type="bool" default="True"/>
</paramlist>
</method>
<method name="IsRecordingDefaults" type="bool" overloaded="no">
- <autodoc>IsRecordingDefaults() -> bool</autodoc>
+ <autodoc>IsRecordingDefaults(self) -> bool</autodoc>
<docstring>Are we currently recording default values?</docstring>
</method>
<method name="ExpandEnvVars" type="String" overloaded="no">
- <autodoc>ExpandEnvVars(String str) -> String</autodoc>
+ <autodoc>ExpandEnvVars(self, String str) -> String</autodoc>
<docstring>Expand any environment variables in str and return the result</docstring>
<paramlist>
<param name="str" type="String" default=""/>
</paramlist>
</method>
<method name="GetAppName" type="String" overloaded="no">
- <autodoc>GetAppName() -> String</autodoc>
+ <autodoc>GetAppName(self) -> String</autodoc>
</method>
<method name="GetVendorName" type="String" overloaded="no">
- <autodoc>GetVendorName() -> String</autodoc>
+ <autodoc>GetVendorName(self) -> String</autodoc>
</method>
<method name="SetAppName" type="" overloaded="no">
- <autodoc>SetAppName(String appName)</autodoc>
+ <autodoc>SetAppName(self, String appName)</autodoc>
<paramlist>
<param name="appName" type="String" default=""/>
</paramlist>
</method>
<method name="SetVendorName" type="" overloaded="no">
- <autodoc>SetVendorName(String vendorName)</autodoc>
+ <autodoc>SetVendorName(self, String vendorName)</autodoc>
<paramlist>
<param name="vendorName" type="String" default=""/>
</paramlist>
</method>
<method name="SetStyle" type="" overloaded="no">
- <autodoc>SetStyle(long style)</autodoc>
+ <autodoc>SetStyle(self, long style)</autodoc>
<paramlist>
<param name="style" type="long" default=""/>
</paramlist>
</method>
<method name="GetStyle" type="long" overloaded="no">
- <autodoc>GetStyle() -> long</autodoc>
+ <autodoc>GetStyle(self) -> long</autodoc>
</method>
</class>
- <class name="Config" oldname="wxConfig" module="misc">
+ <class name="Config" oldname="wxConfig" module="_misc">
<docstring>This ConfigBase-derived class will use the registry on Windows,
and will be a wx.FileConfig on other platforms.</docstring>
<baseclass name="ConfigBase"/>
<constructor name="Config" overloaded="no">
- <autodoc>__init__(String appName=EmptyString, String vendorName=EmptyString,
+ <autodoc>__init__(self, String appName=EmptyString, String vendorName=EmptyString,
String localFilename=EmptyString, String globalFilename=EmptyString,
long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -> Config</autodoc>
<paramlist>
</paramlist>
</constructor>
<destructor name="~wxConfig" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
</class>
- <class name="FileConfig" oldname="wxFileConfig" module="misc">
+ <class name="FileConfig" oldname="wxFileConfig" module="_misc">
<docstring>This config class will use a file for storage on all platforms.</docstring>
<baseclass name="ConfigBase"/>
<constructor name="FileConfig" overloaded="no">
- <autodoc>__init__(String appName=EmptyString, String vendorName=EmptyString,
+ <autodoc>__init__(self, String appName=EmptyString, String vendorName=EmptyString,
String localFilename=EmptyString, String globalFilename=EmptyString,
long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -> FileConfig</autodoc>
<paramlist>
</paramlist>
</constructor>
<destructor name="~wxFileConfig" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
</class>
- <class name="ConfigPathChanger" oldname="wxConfigPathChanger" module="misc">
- <docstring>A handy little class which changes current path to the path of
-given entry and restores it in the destructoir: so if you declare
-a local variable of this type, you work in the entry directory
-and the path is automatically restored when the function returns.</docstring>
+ <class name="ConfigPathChanger" oldname="wxConfigPathChanger" module="_misc">
+ <docstring>A handy little class which changes current path to the path of given
+entry and restores it in the destructoir: so if you declare a local
+variable of this type, you work in the entry directory and the path is
+automatically restored when the function returns.</docstring>
<constructor name="ConfigPathChanger" overloaded="no">
- <autodoc>__init__(ConfigBase config, String entry) -> ConfigPathChanger</autodoc>
+ <autodoc>__init__(self, ConfigBase config, String entry) -> ConfigPathChanger</autodoc>
<paramlist>
<param name="config" type="ConfigBase" default=""/>
<param name="entry" type="String" default=""/>
</paramlist>
</constructor>
<destructor name="~wxConfigPathChanger" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Name" type="String" overloaded="no">
- <autodoc>Name() -> String</autodoc>
+ <autodoc>Name(self) -> String</autodoc>
<docstring>Get the key name</docstring>
</method>
</class>
<method name="ExpandEnvVars" oldname="wxExpandEnvVars" type="String" overloaded="no">
<autodoc>ExpandEnvVars(String sz) -> String</autodoc>
<docstring>Replace environment variables ($SOMETHING) with their values. The
-format is $VARNAME or ${VARNAME} where VARNAME contains
-alphanumeric characters and '_' only. '$' must be escaped ('\\$')
-in order to be taken literally.</docstring>
+format is $VARNAME or ${VARNAME} where VARNAME contains alphanumeric
+characters and '_' only. '$' must be escaped ('\\$') in order to be
+taken literally.</docstring>
<paramlist>
<param name="sz" type="String" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="DateTime" oldname="wxDateTime" module="misc">
+ <class name="DateTime" oldname="wxDateTime" module="_misc">
<constructor name="DateTime" overloaded="no">
- <autodoc>__init__() -> DateTime</autodoc>
+ <autodoc>__init__(self) -> DateTime</autodoc>
</constructor>
<constructor name="DateTimeFromTimeT" overloaded="no">
<autodoc>DateTimeFromTimeT(time_t timet) -> DateTime</autodoc>
</paramlist>
</constructor>
<destructor name="~wxDateTime" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<staticmethod name="SetCountry" type="" overloaded="no">
<autodoc>SetCountry(int country)</autodoc>
</staticmethod>
<staticmethod name="GetAmPmStrings" type="" overloaded="no">
<autodoc>GetAmPmStrings() -> (am, pm)</autodoc>
- <docstring>Get the AM and PM strings in the current locale (may be empty)</docstring>
<paramlist>
<param name="OUTPUT" type="String" default=""/>
<param name="OUTPUT" type="String" default=""/>
<autodoc>Today() -> DateTime</autodoc>
</staticmethod>
<method name="SetToCurrent" type="DateTime" overloaded="no">
- <autodoc>SetToCurrent() -> DateTime</autodoc>
+ <autodoc>SetToCurrent(self) -> DateTime</autodoc>
</method>
<method name="SetTimeT" type="DateTime" overloaded="no">
- <autodoc>SetTimeT(time_t timet) -> DateTime</autodoc>
+ <autodoc>SetTimeT(self, time_t timet) -> DateTime</autodoc>
<paramlist>
<param name="timet" type="time_t" default=""/>
</paramlist>
</method>
<method name="SetJDN" type="DateTime" overloaded="no">
- <autodoc>SetJDN(double jdn) -> DateTime</autodoc>
+ <autodoc>SetJDN(self, double jdn) -> DateTime</autodoc>
<paramlist>
<param name="jdn" type="double" default=""/>
</paramlist>
</method>
<method name="SetHMS" type="DateTime" overloaded="no">
- <autodoc>SetHMS(int hour, int minute=0, int second=0, int millisec=0) -> DateTime</autodoc>
+ <autodoc>SetHMS(self, int hour, int minute=0, int second=0, int millisec=0) -> DateTime</autodoc>
<paramlist>
<param name="hour" type="int" default=""/>
<param name="minute" type="int" default="0"/>
</paramlist>
</method>
<method name="Set" type="DateTime" overloaded="no">
- <autodoc>Set(int day, int month=Inv_Month, int year=Inv_Year, int hour=0,
+ <autodoc>Set(self, int day, int month=Inv_Month, int year=Inv_Year, int hour=0,
int minute=0, int second=0, int millisec=0) -> DateTime</autodoc>
<paramlist>
<param name="day" type="int" default=""/>
</paramlist>
</method>
<method name="ResetTime" type="DateTime" overloaded="no">
- <autodoc>ResetTime() -> DateTime</autodoc>
+ <autodoc>ResetTime(self) -> DateTime</autodoc>
</method>
<method name="SetYear" type="DateTime" overloaded="no">
- <autodoc>SetYear(int year) -> DateTime</autodoc>
+ <autodoc>SetYear(self, int year) -> DateTime</autodoc>
<paramlist>
<param name="year" type="int" default=""/>
</paramlist>
</method>
<method name="SetMonth" type="DateTime" overloaded="no">
- <autodoc>SetMonth(int month) -> DateTime</autodoc>
+ <autodoc>SetMonth(self, int month) -> DateTime</autodoc>
<paramlist>
<param name="month" type="wxDateTime::Month" default=""/>
</paramlist>
</method>
<method name="SetDay" type="DateTime" overloaded="no">
- <autodoc>SetDay(int day) -> DateTime</autodoc>
+ <autodoc>SetDay(self, int day) -> DateTime</autodoc>
<paramlist>
<param name="day" type="int" default=""/>
</paramlist>
</method>
<method name="SetHour" type="DateTime" overloaded="no">
- <autodoc>SetHour(int hour) -> DateTime</autodoc>
+ <autodoc>SetHour(self, int hour) -> DateTime</autodoc>
<paramlist>
<param name="hour" type="int" default=""/>
</paramlist>
</method>
<method name="SetMinute" type="DateTime" overloaded="no">
- <autodoc>SetMinute(int minute) -> DateTime</autodoc>
+ <autodoc>SetMinute(self, int minute) -> DateTime</autodoc>
<paramlist>
<param name="minute" type="int" default=""/>
</paramlist>
</method>
<method name="SetSecond" type="DateTime" overloaded="no">
- <autodoc>SetSecond(int second) -> DateTime</autodoc>
+ <autodoc>SetSecond(self, int second) -> DateTime</autodoc>
<paramlist>
<param name="second" type="int" default=""/>
</paramlist>
</method>
<method name="SetMillisecond" type="DateTime" overloaded="no">
- <autodoc>SetMillisecond(int millisecond) -> DateTime</autodoc>
+ <autodoc>SetMillisecond(self, int millisecond) -> DateTime</autodoc>
<paramlist>
<param name="millisecond" type="int" default=""/>
</paramlist>
</method>
<method name="SetToWeekDayInSameWeek" type="DateTime" overloaded="no">
- <autodoc>SetToWeekDayInSameWeek(int weekday, int flags=Monday_First) -> DateTime</autodoc>
+ <autodoc>SetToWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime</autodoc>
<paramlist>
<param name="weekday" type="wxDateTime::WeekDay" default=""/>
<param name="flags" type="wxDateTime::WeekFlags" default="wxDateTime::Monday_First"/>
</paramlist>
</method>
<method name="GetWeekDayInSameWeek" type="DateTime" overloaded="no">
- <autodoc>GetWeekDayInSameWeek(int weekday, int flags=Monday_First) -> DateTime</autodoc>
+ <autodoc>GetWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime</autodoc>
<paramlist>
<param name="weekday" type="wxDateTime::WeekDay" default=""/>
<param name="flags" type="wxDateTime::WeekFlags" default="wxDateTime::Monday_First"/>
</paramlist>
</method>
<method name="SetToNextWeekDay" type="DateTime" overloaded="no">
- <autodoc>SetToNextWeekDay(int weekday) -> DateTime</autodoc>
+ <autodoc>SetToNextWeekDay(self, int weekday) -> DateTime</autodoc>
<paramlist>
<param name="weekday" type="wxDateTime::WeekDay" default=""/>
</paramlist>
</method>
<method name="GetNextWeekDay" type="DateTime" overloaded="no">
- <autodoc>GetNextWeekDay(int weekday) -> DateTime</autodoc>
+ <autodoc>GetNextWeekDay(self, int weekday) -> DateTime</autodoc>
<paramlist>
<param name="weekday" type="wxDateTime::WeekDay" default=""/>
</paramlist>
</method>
<method name="SetToPrevWeekDay" type="DateTime" overloaded="no">
- <autodoc>SetToPrevWeekDay(int weekday) -> DateTime</autodoc>
+ <autodoc>SetToPrevWeekDay(self, int weekday) -> DateTime</autodoc>
<paramlist>
<param name="weekday" type="wxDateTime::WeekDay" default=""/>
</paramlist>
</method>
<method name="GetPrevWeekDay" type="DateTime" overloaded="no">
- <autodoc>GetPrevWeekDay(int weekday) -> DateTime</autodoc>
+ <autodoc>GetPrevWeekDay(self, int weekday) -> DateTime</autodoc>
<paramlist>
<param name="weekday" type="wxDateTime::WeekDay" default=""/>
</paramlist>
</method>
<method name="SetToWeekDay" type="bool" overloaded="no">
- <autodoc>SetToWeekDay(int weekday, int n=1, int month=Inv_Month, int year=Inv_Year) -> bool</autodoc>
+ <autodoc>SetToWeekDay(self, int weekday, int n=1, int month=Inv_Month, int year=Inv_Year) -> bool</autodoc>
<paramlist>
<param name="weekday" type="wxDateTime::WeekDay" default=""/>
<param name="n" type="int" default="1"/>
</paramlist>
</method>
<method name="SetToLastWeekDay" type="bool" overloaded="no">
- <autodoc>SetToLastWeekDay(int weekday, int month=Inv_Month, int year=Inv_Year) -> bool</autodoc>
+ <autodoc>SetToLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> bool</autodoc>
<paramlist>
<param name="weekday" type="wxDateTime::WeekDay" default=""/>
<param name="month" type="wxDateTime::Month" default="wxDateTime::Inv_Month"/>
</paramlist>
</method>
<method name="GetLastWeekDay" type="DateTime" overloaded="no">
- <autodoc>GetLastWeekDay(int weekday, int month=Inv_Month, int year=Inv_Year) -> DateTime</autodoc>
+ <autodoc>GetLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> DateTime</autodoc>
<paramlist>
<param name="weekday" type="wxDateTime::WeekDay" default=""/>
<param name="month" type="wxDateTime::Month" default="wxDateTime::Inv_Month"/>
</paramlist>
</method>
<method name="SetToTheWeek" type="bool" overloaded="no">
- <autodoc>SetToTheWeek(int numWeek, int weekday=Mon, int flags=Monday_First) -> bool</autodoc>
+ <autodoc>SetToTheWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> bool</autodoc>
<paramlist>
<param name="numWeek" type="int" default=""/>
<param name="weekday" type="wxDateTime::WeekDay" default="wxDateTime::Mon"/>
</paramlist>
</method>
<method name="GetWeek" type="DateTime" overloaded="no">
- <autodoc>GetWeek(int numWeek, int weekday=Mon, int flags=Monday_First) -> DateTime</autodoc>
+ <autodoc>GetWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> DateTime</autodoc>
<paramlist>
<param name="numWeek" type="int" default=""/>
<param name="weekday" type="wxDateTime::WeekDay" default="wxDateTime::Mon"/>
</paramlist>
</method>
<method name="SetToLastMonthDay" type="DateTime" overloaded="no">
- <autodoc>SetToLastMonthDay(int month=Inv_Month, int year=Inv_Year) -> DateTime</autodoc>
+ <autodoc>SetToLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime</autodoc>
<paramlist>
<param name="month" type="wxDateTime::Month" default="wxDateTime::Inv_Month"/>
<param name="year" type="int" default="wxDateTime::Inv_Year"/>
</paramlist>
</method>
<method name="GetLastMonthDay" type="DateTime" overloaded="no">
- <autodoc>GetLastMonthDay(int month=Inv_Month, int year=Inv_Year) -> DateTime</autodoc>
+ <autodoc>GetLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime</autodoc>
<paramlist>
<param name="month" type="wxDateTime::Month" default="wxDateTime::Inv_Month"/>
<param name="year" type="int" default="wxDateTime::Inv_Year"/>
</paramlist>
</method>
<method name="SetToYearDay" type="DateTime" overloaded="no">
- <autodoc>SetToYearDay(int yday) -> DateTime</autodoc>
+ <autodoc>SetToYearDay(self, int yday) -> DateTime</autodoc>
<paramlist>
<param name="yday" type="int" default=""/>
</paramlist>
</method>
<method name="GetYearDay" type="DateTime" overloaded="no">
- <autodoc>GetYearDay(int yday) -> DateTime</autodoc>
+ <autodoc>GetYearDay(self, int yday) -> DateTime</autodoc>
<paramlist>
<param name="yday" type="int" default=""/>
</paramlist>
</method>
<method name="GetJulianDayNumber" type="double" overloaded="no">
- <autodoc>GetJulianDayNumber() -> double</autodoc>
+ <autodoc>GetJulianDayNumber(self) -> double</autodoc>
</method>
<method name="GetJDN" type="double" overloaded="no">
- <autodoc>GetJDN() -> double</autodoc>
+ <autodoc>GetJDN(self) -> double</autodoc>
</method>
<method name="GetModifiedJulianDayNumber" type="double" overloaded="no">
- <autodoc>GetModifiedJulianDayNumber() -> double</autodoc>
+ <autodoc>GetModifiedJulianDayNumber(self) -> double</autodoc>
</method>
<method name="GetMJD" type="double" overloaded="no">
- <autodoc>GetMJD() -> double</autodoc>
+ <autodoc>GetMJD(self) -> double</autodoc>
</method>
<method name="GetRataDie" type="double" overloaded="no">
- <autodoc>GetRataDie() -> double</autodoc>
+ <autodoc>GetRataDie(self) -> double</autodoc>
</method>
<method name="ToTimezone" type="DateTime" overloaded="no">
- <autodoc>ToTimezone(wxDateTime::TimeZone tz, bool noDST=False) -> DateTime</autodoc>
+ <autodoc>ToTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime</autodoc>
<paramlist>
<param name="tz" type="wxDateTime::TimeZone" default=""/>
<param name="noDST" type="bool" default="False"/>
</paramlist>
</method>
<method name="MakeTimezone" type="DateTime" overloaded="no">
- <autodoc>MakeTimezone(wxDateTime::TimeZone tz, bool noDST=False) -> DateTime</autodoc>
+ <autodoc>MakeTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime</autodoc>
<paramlist>
<param name="tz" type="wxDateTime::TimeZone" default=""/>
<param name="noDST" type="bool" default="False"/>
</paramlist>
</method>
<method name="ToGMT" type="DateTime" overloaded="no">
- <autodoc>ToGMT(bool noDST=False) -> DateTime</autodoc>
+ <autodoc>ToGMT(self, bool noDST=False) -> DateTime</autodoc>
<paramlist>
<param name="noDST" type="bool" default="False"/>
</paramlist>
</method>
<method name="MakeGMT" type="DateTime" overloaded="no">
- <autodoc>MakeGMT(bool noDST=False) -> DateTime</autodoc>
+ <autodoc>MakeGMT(self, bool noDST=False) -> DateTime</autodoc>
<paramlist>
<param name="noDST" type="bool" default="False"/>
</paramlist>
</method>
<method name="IsDST" type="int" overloaded="no">
- <autodoc>IsDST(int country=Country_Default) -> int</autodoc>
+ <autodoc>IsDST(self, int country=Country_Default) -> int</autodoc>
<paramlist>
<param name="country" type="wxDateTime::Country" default="wxDateTime::Country_Default"/>
</paramlist>
</method>
<method name="IsValid" type="bool" overloaded="no">
- <autodoc>IsValid() -> bool</autodoc>
+ <autodoc>IsValid(self) -> bool</autodoc>
</method>
<method name="GetTicks" type="time_t" overloaded="no">
- <autodoc>GetTicks() -> time_t</autodoc>
+ <autodoc>GetTicks(self) -> time_t</autodoc>
</method>
<method name="GetYear" type="int" overloaded="no">
- <autodoc>GetYear(wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
+ <autodoc>GetYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
<paramlist>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="GetMonth" type="wxDateTime::Month" overloaded="no">
- <autodoc>GetMonth(wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
+ <autodoc>GetMonth(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
<paramlist>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="GetDay" type="int" overloaded="no">
- <autodoc>GetDay(wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
+ <autodoc>GetDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
<paramlist>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="GetWeekDay" type="wxDateTime::WeekDay" overloaded="no">
- <autodoc>GetWeekDay(wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
+ <autodoc>GetWeekDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
<paramlist>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="GetHour" type="int" overloaded="no">
- <autodoc>GetHour(wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
+ <autodoc>GetHour(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
<paramlist>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="GetMinute" type="int" overloaded="no">
- <autodoc>GetMinute(wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
+ <autodoc>GetMinute(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
<paramlist>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="GetSecond" type="int" overloaded="no">
- <autodoc>GetSecond(wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
+ <autodoc>GetSecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
<paramlist>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="GetMillisecond" type="int" overloaded="no">
- <autodoc>GetMillisecond(wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
+ <autodoc>GetMillisecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
<paramlist>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="GetDayOfYear" type="int" overloaded="no">
- <autodoc>GetDayOfYear(wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
+ <autodoc>GetDayOfYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
<paramlist>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="GetWeekOfYear" type="int" overloaded="no">
- <autodoc>GetWeekOfYear(int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
+ <autodoc>GetWeekOfYear(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
<paramlist>
<param name="flags" type="wxDateTime::WeekFlags" default="wxDateTime::Monday_First"/>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="GetWeekOfMonth" type="int" overloaded="no">
- <autodoc>GetWeekOfMonth(int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
+ <autodoc>GetWeekOfMonth(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc>
<paramlist>
<param name="flags" type="wxDateTime::WeekFlags" default="wxDateTime::Monday_First"/>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="IsWorkDay" type="bool" overloaded="no">
- <autodoc>IsWorkDay(int country=Country_Default) -> bool</autodoc>
+ <autodoc>IsWorkDay(self, int country=Country_Default) -> bool</autodoc>
<paramlist>
<param name="country" type="wxDateTime::Country" default="wxDateTime::Country_Default"/>
</paramlist>
</method>
<method name="IsEqualTo" type="bool" overloaded="no">
- <autodoc>IsEqualTo(DateTime datetime) -> bool</autodoc>
+ <autodoc>IsEqualTo(self, DateTime datetime) -> bool</autodoc>
<paramlist>
<param name="datetime" type="DateTime" default=""/>
</paramlist>
</method>
<method name="IsEarlierThan" type="bool" overloaded="no">
- <autodoc>IsEarlierThan(DateTime datetime) -> bool</autodoc>
+ <autodoc>IsEarlierThan(self, DateTime datetime) -> bool</autodoc>
<paramlist>
<param name="datetime" type="DateTime" default=""/>
</paramlist>
</method>
<method name="IsLaterThan" type="bool" overloaded="no">
- <autodoc>IsLaterThan(DateTime datetime) -> bool</autodoc>
+ <autodoc>IsLaterThan(self, DateTime datetime) -> bool</autodoc>
<paramlist>
<param name="datetime" type="DateTime" default=""/>
</paramlist>
</method>
<method name="IsStrictlyBetween" type="bool" overloaded="no">
- <autodoc>IsStrictlyBetween(DateTime t1, DateTime t2) -> bool</autodoc>
+ <autodoc>IsStrictlyBetween(self, DateTime t1, DateTime t2) -> bool</autodoc>
<paramlist>
<param name="t1" type="DateTime" default=""/>
<param name="t2" type="DateTime" default=""/>
</paramlist>
</method>
<method name="IsBetween" type="bool" overloaded="no">
- <autodoc>IsBetween(DateTime t1, DateTime t2) -> bool</autodoc>
+ <autodoc>IsBetween(self, DateTime t1, DateTime t2) -> bool</autodoc>
<paramlist>
<param name="t1" type="DateTime" default=""/>
<param name="t2" type="DateTime" default=""/>
</paramlist>
</method>
<method name="IsSameDate" type="bool" overloaded="no">
- <autodoc>IsSameDate(DateTime dt) -> bool</autodoc>
+ <autodoc>IsSameDate(self, DateTime dt) -> bool</autodoc>
<paramlist>
<param name="dt" type="DateTime" default=""/>
</paramlist>
</method>
<method name="IsSameTime" type="bool" overloaded="no">
- <autodoc>IsSameTime(DateTime dt) -> bool</autodoc>
+ <autodoc>IsSameTime(self, DateTime dt) -> bool</autodoc>
<paramlist>
<param name="dt" type="DateTime" default=""/>
</paramlist>
</method>
<method name="IsEqualUpTo" type="bool" overloaded="no">
- <autodoc>IsEqualUpTo(DateTime dt, TimeSpan ts) -> bool</autodoc>
+ <autodoc>IsEqualUpTo(self, DateTime dt, TimeSpan ts) -> bool</autodoc>
<paramlist>
<param name="dt" type="DateTime" default=""/>
<param name="ts" type="wxTimeSpan" default=""/>
</paramlist>
</method>
<method name="AddTS" type="DateTime" overloaded="no">
- <autodoc>AddTS(TimeSpan diff) -> DateTime</autodoc>
+ <autodoc>AddTS(self, TimeSpan diff) -> DateTime</autodoc>
<paramlist>
<param name="diff" type="wxTimeSpan" default=""/>
</paramlist>
</method>
<method name="AddDS" type="DateTime" overloaded="no">
- <autodoc>AddDS(DateSpan diff) -> DateTime</autodoc>
+ <autodoc>AddDS(self, DateSpan diff) -> DateTime</autodoc>
<paramlist>
<param name="diff" type="wxDateSpan" default=""/>
</paramlist>
</method>
<method name="SubtractTS" type="DateTime" overloaded="no">
- <autodoc>SubtractTS(TimeSpan diff) -> DateTime</autodoc>
+ <autodoc>SubtractTS(self, TimeSpan diff) -> DateTime</autodoc>
<paramlist>
<param name="diff" type="wxTimeSpan" default=""/>
</paramlist>
</method>
<method name="SubtractDS" type="DateTime" overloaded="no">
- <autodoc>SubtractDS(DateSpan diff) -> DateTime</autodoc>
+ <autodoc>SubtractDS(self, DateSpan diff) -> DateTime</autodoc>
<paramlist>
<param name="diff" type="wxDateSpan" default=""/>
</paramlist>
</method>
<method name="Subtract" type="wxTimeSpan" overloaded="no">
- <autodoc>Subtract(DateTime dt) -> TimeSpan</autodoc>
+ <autodoc>Subtract(self, DateTime dt) -> TimeSpan</autodoc>
<paramlist>
<param name="dt" type="DateTime" default=""/>
</paramlist>
</paramlist>
</method>
<method name="__iadd__" type="DateTime" overloaded="yes">
- <autodoc>__iadd__(TimeSpan diff) -> DateTime
-__iadd__(DateSpan diff) -> DateTime</autodoc>
+ <autodoc>__iadd__(self, TimeSpan diff) -> DateTime
+__iadd__(self, DateSpan diff) -> DateTime</autodoc>
<paramlist>
<param name="diff" type="wxDateSpan" default=""/>
</paramlist>
</paramlist>
</method>
<method name="__isub__" type="DateTime" overloaded="yes">
- <autodoc>__isub__(TimeSpan diff) -> DateTime
-__isub__(DateSpan diff) -> DateTime</autodoc>
+ <autodoc>__isub__(self, TimeSpan diff) -> DateTime
+__isub__(self, DateSpan diff) -> DateTime</autodoc>
<paramlist>
<param name="diff" type="wxDateSpan" default=""/>
</paramlist>
</paramlist>
</method>
<method name="__add__" type="DateTime" overloaded="yes">
- <autodoc>__add__(TimeSpan other) -> DateTime
-__add__(DateSpan other) -> DateTime</autodoc>
+ <autodoc>__add__(self, TimeSpan other) -> DateTime
+__add__(self, DateSpan other) -> DateTime</autodoc>
<paramlist>
<param name="other" type="wxDateSpan" default=""/>
</paramlist>
</paramlist>
</method>
<method name="__sub__" type="DateTime" overloaded="yes">
- <autodoc>__sub__(DateTime other) -> TimeSpan
-__sub__(TimeSpan other) -> DateTime
-__sub__(DateSpan other) -> DateTime</autodoc>
+ <autodoc>__sub__(self, DateTime other) -> TimeSpan
+__sub__(self, TimeSpan other) -> DateTime
+__sub__(self, DateSpan other) -> DateTime</autodoc>
<paramlist>
<param name="other" type="wxDateSpan" default=""/>
</paramlist>
</method>
<method name="__lt__" type="bool" overloaded="no">
- <autodoc>__lt__(DateTime other) -> bool</autodoc>
+ <autodoc>__lt__(self, DateTime other) -> bool</autodoc>
<paramlist>
<param name="other" type="DateTime" default=""/>
</paramlist>
</method>
<method name="__le__" type="bool" overloaded="no">
- <autodoc>__le__(DateTime other) -> bool</autodoc>
+ <autodoc>__le__(self, DateTime other) -> bool</autodoc>
<paramlist>
<param name="other" type="DateTime" default=""/>
</paramlist>
</method>
<method name="__gt__" type="bool" overloaded="no">
- <autodoc>__gt__(DateTime other) -> bool</autodoc>
+ <autodoc>__gt__(self, DateTime other) -> bool</autodoc>
<paramlist>
<param name="other" type="DateTime" default=""/>
</paramlist>
</method>
<method name="__ge__" type="bool" overloaded="no">
- <autodoc>__ge__(DateTime other) -> bool</autodoc>
+ <autodoc>__ge__(self, DateTime other) -> bool</autodoc>
<paramlist>
<param name="other" type="DateTime" default=""/>
</paramlist>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(DateTime other) -> bool</autodoc>
+ <autodoc>__eq__(self, DateTime other) -> bool</autodoc>
<paramlist>
<param name="other" type="DateTime" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(DateTime other) -> bool</autodoc>
+ <autodoc>__ne__(self, DateTime other) -> bool</autodoc>
<paramlist>
<param name="other" type="DateTime" default=""/>
</paramlist>
</method>
<method name="ParseRfc822Date" type="int" overloaded="no">
- <autodoc>ParseRfc822Date(String date) -> int</autodoc>
+ <autodoc>ParseRfc822Date(self, String date) -> int</autodoc>
<paramlist>
<param name="date" type="String" default=""/>
</paramlist>
</method>
<method name="ParseFormat" type="int" overloaded="no">
- <autodoc>ParseFormat(String date, String format=DateFormatStr, DateTime dateDef=DefaultDateTime) -> int</autodoc>
+ <autodoc>ParseFormat(self, String date, String format=DateFormatStr, DateTime dateDef=DefaultDateTime) -> int</autodoc>
<paramlist>
<param name="date" type="String" default=""/>
<param name="format" type="String" default="wxPyDateFormatStr"/>
</paramlist>
</method>
<method name="ParseDateTime" type="int" overloaded="no">
- <autodoc>ParseDateTime(String datetime) -> int</autodoc>
+ <autodoc>ParseDateTime(self, String datetime) -> int</autodoc>
<paramlist>
<param name="datetime" type="String" default=""/>
</paramlist>
</method>
<method name="ParseDate" type="int" overloaded="no">
- <autodoc>ParseDate(String date) -> int</autodoc>
+ <autodoc>ParseDate(self, String date) -> int</autodoc>
<paramlist>
<param name="date" type="String" default=""/>
</paramlist>
</method>
<method name="ParseTime" type="int" overloaded="no">
- <autodoc>ParseTime(String time) -> int</autodoc>
+ <autodoc>ParseTime(self, String time) -> int</autodoc>
<paramlist>
<param name="time" type="String" default=""/>
</paramlist>
</method>
<method name="Format" type="String" overloaded="no">
- <autodoc>Format(String format=DateFormatStr, wxDateTime::TimeZone tz=LOCAL_TZ) -> String</autodoc>
+ <autodoc>Format(self, String format=DateFormatStr, wxDateTime::TimeZone tz=LOCAL_TZ) -> String</autodoc>
<paramlist>
<param name="format" type="String" default="wxPyDateFormatStr"/>
<param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/>
</paramlist>
</method>
<method name="FormatDate" type="String" overloaded="no">
- <autodoc>FormatDate() -> String</autodoc>
+ <autodoc>FormatDate(self) -> String</autodoc>
</method>
<method name="FormatTime" type="String" overloaded="no">
- <autodoc>FormatTime() -> String</autodoc>
+ <autodoc>FormatTime(self) -> String</autodoc>
</method>
<method name="FormatISODate" type="String" overloaded="no">
- <autodoc>FormatISODate() -> String</autodoc>
+ <autodoc>FormatISODate(self) -> String</autodoc>
</method>
<method name="FormatISOTime" type="String" overloaded="no">
- <autodoc>FormatISOTime() -> String</autodoc>
+ <autodoc>FormatISOTime(self) -> String</autodoc>
</method>
</class>
- <class name="TimeSpan" oldname="wxTimeSpan" module="misc">
+ <class name="TimeSpan" oldname="wxTimeSpan" module="_misc">
<constructor name="TimeSpan" overloaded="no">
- <autodoc>__init__(long hours=0, long minutes=0, long seconds=0, long milliseconds=0) -> TimeSpan</autodoc>
+ <autodoc>__init__(self, long hours=0, long minutes=0, long seconds=0, long milliseconds=0) -> TimeSpan</autodoc>
<paramlist>
<param name="hours" type="long" default="0"/>
<param name="minutes" type="long" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxTimeSpan" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<staticmethod name="Seconds" type="TimeSpan" overloaded="no">
<autodoc>Seconds(long sec) -> TimeSpan</autodoc>
<autodoc>Week() -> TimeSpan</autodoc>
</staticmethod>
<method name="Add" type="TimeSpan" overloaded="no">
- <autodoc>Add(TimeSpan diff) -> TimeSpan</autodoc>
+ <autodoc>Add(self, TimeSpan diff) -> TimeSpan</autodoc>
<paramlist>
<param name="diff" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="Subtract" type="TimeSpan" overloaded="no">
- <autodoc>Subtract(TimeSpan diff) -> TimeSpan</autodoc>
+ <autodoc>Subtract(self, TimeSpan diff) -> TimeSpan</autodoc>
<paramlist>
<param name="diff" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="Multiply" type="TimeSpan" overloaded="no">
- <autodoc>Multiply(int n) -> TimeSpan</autodoc>
+ <autodoc>Multiply(self, int n) -> TimeSpan</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="Neg" type="TimeSpan" overloaded="no">
- <autodoc>Neg() -> TimeSpan</autodoc>
+ <autodoc>Neg(self) -> TimeSpan</autodoc>
</method>
<method name="Abs" type="TimeSpan" overloaded="no">
- <autodoc>Abs() -> TimeSpan</autodoc>
+ <autodoc>Abs(self) -> TimeSpan</autodoc>
</method>
<method name="__iadd__" type="TimeSpan" overloaded="no">
- <autodoc>__iadd__(TimeSpan diff) -> TimeSpan</autodoc>
+ <autodoc>__iadd__(self, TimeSpan diff) -> TimeSpan</autodoc>
<paramlist>
<param name="diff" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="__isub__" type="TimeSpan" overloaded="no">
- <autodoc>__isub__(TimeSpan diff) -> TimeSpan</autodoc>
+ <autodoc>__isub__(self, TimeSpan diff) -> TimeSpan</autodoc>
<paramlist>
<param name="diff" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="__imul__" type="TimeSpan" overloaded="no">
- <autodoc>__imul__(int n) -> TimeSpan</autodoc>
+ <autodoc>__imul__(self, int n) -> TimeSpan</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="__neg__" type="TimeSpan" overloaded="no">
- <autodoc>__neg__() -> TimeSpan</autodoc>
+ <autodoc>__neg__(self) -> TimeSpan</autodoc>
</method>
<method name="__add__" type="TimeSpan" overloaded="no">
- <autodoc>__add__(TimeSpan other) -> TimeSpan</autodoc>
+ <autodoc>__add__(self, TimeSpan other) -> TimeSpan</autodoc>
<paramlist>
<param name="other" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="__sub__" type="TimeSpan" overloaded="no">
- <autodoc>__sub__(TimeSpan other) -> TimeSpan</autodoc>
+ <autodoc>__sub__(self, TimeSpan other) -> TimeSpan</autodoc>
<paramlist>
<param name="other" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="__mul__" type="TimeSpan" overloaded="no">
- <autodoc>__mul__(int n) -> TimeSpan</autodoc>
+ <autodoc>__mul__(self, int n) -> TimeSpan</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="__rmul__" type="TimeSpan" overloaded="no">
- <autodoc>__rmul__(int n) -> TimeSpan</autodoc>
+ <autodoc>__rmul__(self, int n) -> TimeSpan</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="__lt__" type="bool" overloaded="no">
- <autodoc>__lt__(TimeSpan other) -> bool</autodoc>
+ <autodoc>__lt__(self, TimeSpan other) -> bool</autodoc>
<paramlist>
<param name="other" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="__le__" type="bool" overloaded="no">
- <autodoc>__le__(TimeSpan other) -> bool</autodoc>
+ <autodoc>__le__(self, TimeSpan other) -> bool</autodoc>
<paramlist>
<param name="other" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="__gt__" type="bool" overloaded="no">
- <autodoc>__gt__(TimeSpan other) -> bool</autodoc>
+ <autodoc>__gt__(self, TimeSpan other) -> bool</autodoc>
<paramlist>
<param name="other" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="__ge__" type="bool" overloaded="no">
- <autodoc>__ge__(TimeSpan other) -> bool</autodoc>
+ <autodoc>__ge__(self, TimeSpan other) -> bool</autodoc>
<paramlist>
<param name="other" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(TimeSpan other) -> bool</autodoc>
+ <autodoc>__eq__(self, TimeSpan other) -> bool</autodoc>
<paramlist>
<param name="other" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(TimeSpan other) -> bool</autodoc>
+ <autodoc>__ne__(self, TimeSpan other) -> bool</autodoc>
<paramlist>
<param name="other" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="IsNull" type="bool" overloaded="no">
- <autodoc>IsNull() -> bool</autodoc>
+ <autodoc>IsNull(self) -> bool</autodoc>
</method>
<method name="IsPositive" type="bool" overloaded="no">
- <autodoc>IsPositive() -> bool</autodoc>
+ <autodoc>IsPositive(self) -> bool</autodoc>
</method>
<method name="IsNegative" type="bool" overloaded="no">
- <autodoc>IsNegative() -> bool</autodoc>
+ <autodoc>IsNegative(self) -> bool</autodoc>
</method>
<method name="IsEqualTo" type="bool" overloaded="no">
- <autodoc>IsEqualTo(TimeSpan ts) -> bool</autodoc>
+ <autodoc>IsEqualTo(self, TimeSpan ts) -> bool</autodoc>
<paramlist>
<param name="ts" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="IsLongerThan" type="bool" overloaded="no">
- <autodoc>IsLongerThan(TimeSpan ts) -> bool</autodoc>
+ <autodoc>IsLongerThan(self, TimeSpan ts) -> bool</autodoc>
<paramlist>
<param name="ts" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="IsShorterThan" type="bool" overloaded="no">
- <autodoc>IsShorterThan(TimeSpan t) -> bool</autodoc>
+ <autodoc>IsShorterThan(self, TimeSpan t) -> bool</autodoc>
<paramlist>
<param name="t" type="TimeSpan" default=""/>
</paramlist>
</method>
<method name="GetWeeks" type="int" overloaded="no">
- <autodoc>GetWeeks() -> int</autodoc>
+ <autodoc>GetWeeks(self) -> int</autodoc>
</method>
<method name="GetDays" type="int" overloaded="no">
- <autodoc>GetDays() -> int</autodoc>
+ <autodoc>GetDays(self) -> int</autodoc>
</method>
<method name="GetHours" type="int" overloaded="no">
- <autodoc>GetHours() -> int</autodoc>
+ <autodoc>GetHours(self) -> int</autodoc>
</method>
<method name="GetMinutes" type="int" overloaded="no">
- <autodoc>GetMinutes() -> int</autodoc>
+ <autodoc>GetMinutes(self) -> int</autodoc>
</method>
<method name="GetSeconds" type="wxLongLong" overloaded="no">
- <autodoc>GetSeconds() -> wxLongLong</autodoc>
+ <autodoc>GetSeconds(self) -> wxLongLong</autodoc>
</method>
<method name="GetMilliseconds" type="wxLongLong" overloaded="no">
- <autodoc>GetMilliseconds() -> wxLongLong</autodoc>
+ <autodoc>GetMilliseconds(self) -> wxLongLong</autodoc>
</method>
<method name="Format" type="String" overloaded="no">
- <autodoc>Format(String format=TimeSpanFormatStr) -> String</autodoc>
+ <autodoc>Format(self, String format=TimeSpanFormatStr) -> String</autodoc>
<paramlist>
<param name="format" type="String" default="wxPyTimeSpanFormatStr"/>
</paramlist>
</method>
</class>
- <class name="DateSpan" oldname="wxDateSpan" module="misc">
+ <class name="DateSpan" oldname="wxDateSpan" module="_misc">
<constructor name="DateSpan" overloaded="no">
- <autodoc>__init__(int years=0, int months=0, int weeks=0, int days=0) -> DateSpan</autodoc>
+ <autodoc>__init__(self, int years=0, int months=0, int weeks=0, int days=0) -> DateSpan</autodoc>
<paramlist>
<param name="years" type="int" default="0"/>
<param name="months" type="int" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxDateSpan" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<staticmethod name="Days" type="DateSpan" overloaded="no">
<autodoc>Days(int days) -> DateSpan</autodoc>
<autodoc>Year() -> DateSpan</autodoc>
</staticmethod>
<method name="SetYears" type="DateSpan" overloaded="no">
- <autodoc>SetYears(int n) -> DateSpan</autodoc>
+ <autodoc>SetYears(self, int n) -> DateSpan</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetMonths" type="DateSpan" overloaded="no">
- <autodoc>SetMonths(int n) -> DateSpan</autodoc>
+ <autodoc>SetMonths(self, int n) -> DateSpan</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetWeeks" type="DateSpan" overloaded="no">
- <autodoc>SetWeeks(int n) -> DateSpan</autodoc>
+ <autodoc>SetWeeks(self, int n) -> DateSpan</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="SetDays" type="DateSpan" overloaded="no">
- <autodoc>SetDays(int n) -> DateSpan</autodoc>
+ <autodoc>SetDays(self, int n) -> DateSpan</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetYears" type="int" overloaded="no">
- <autodoc>GetYears() -> int</autodoc>
+ <autodoc>GetYears(self) -> int</autodoc>
</method>
<method name="GetMonths" type="int" overloaded="no">
- <autodoc>GetMonths() -> int</autodoc>
+ <autodoc>GetMonths(self) -> int</autodoc>
</method>
<method name="GetWeeks" type="int" overloaded="no">
- <autodoc>GetWeeks() -> int</autodoc>
+ <autodoc>GetWeeks(self) -> int</autodoc>
</method>
<method name="GetDays" type="int" overloaded="no">
- <autodoc>GetDays() -> int</autodoc>
+ <autodoc>GetDays(self) -> int</autodoc>
</method>
<method name="GetTotalDays" type="int" overloaded="no">
- <autodoc>GetTotalDays() -> int</autodoc>
+ <autodoc>GetTotalDays(self) -> int</autodoc>
</method>
<method name="Add" type="DateSpan" overloaded="no">
- <autodoc>Add(DateSpan other) -> DateSpan</autodoc>
+ <autodoc>Add(self, DateSpan other) -> DateSpan</autodoc>
<paramlist>
<param name="other" type="DateSpan" default=""/>
</paramlist>
</method>
<method name="Subtract" type="DateSpan" overloaded="no">
- <autodoc>Subtract(DateSpan other) -> DateSpan</autodoc>
+ <autodoc>Subtract(self, DateSpan other) -> DateSpan</autodoc>
<paramlist>
<param name="other" type="DateSpan" default=""/>
</paramlist>
</method>
<method name="Neg" type="DateSpan" overloaded="no">
- <autodoc>Neg() -> DateSpan</autodoc>
+ <autodoc>Neg(self) -> DateSpan</autodoc>
</method>
<method name="Multiply" type="DateSpan" overloaded="no">
- <autodoc>Multiply(int factor) -> DateSpan</autodoc>
+ <autodoc>Multiply(self, int factor) -> DateSpan</autodoc>
<paramlist>
<param name="factor" type="int" default=""/>
</paramlist>
</method>
<method name="__iadd__" type="DateSpan" overloaded="no">
- <autodoc>__iadd__(DateSpan other) -> DateSpan</autodoc>
+ <autodoc>__iadd__(self, DateSpan other) -> DateSpan</autodoc>
<paramlist>
<param name="other" type="DateSpan" default=""/>
</paramlist>
</method>
<method name="__isub__" type="DateSpan" overloaded="no">
- <autodoc>__isub__(DateSpan other) -> DateSpan</autodoc>
+ <autodoc>__isub__(self, DateSpan other) -> DateSpan</autodoc>
<paramlist>
<param name="other" type="DateSpan" default=""/>
</paramlist>
</method>
<method name="__neg__" type="DateSpan" overloaded="no">
- <autodoc>__neg__() -> DateSpan</autodoc>
+ <autodoc>__neg__(self) -> DateSpan</autodoc>
</method>
<method name="__imul__" type="DateSpan" overloaded="no">
- <autodoc>__imul__(int factor) -> DateSpan</autodoc>
+ <autodoc>__imul__(self, int factor) -> DateSpan</autodoc>
<paramlist>
<param name="factor" type="int" default=""/>
</paramlist>
</method>
<method name="__add__" type="DateSpan" overloaded="no">
- <autodoc>__add__(DateSpan other) -> DateSpan</autodoc>
+ <autodoc>__add__(self, DateSpan other) -> DateSpan</autodoc>
<paramlist>
<param name="other" type="DateSpan" default=""/>
</paramlist>
</method>
<method name="__sub__" type="DateSpan" overloaded="no">
- <autodoc>__sub__(DateSpan other) -> DateSpan</autodoc>
+ <autodoc>__sub__(self, DateSpan other) -> DateSpan</autodoc>
<paramlist>
<param name="other" type="DateSpan" default=""/>
</paramlist>
</method>
<method name="__mul__" type="DateSpan" overloaded="no">
- <autodoc>__mul__(int n) -> DateSpan</autodoc>
+ <autodoc>__mul__(self, int n) -> DateSpan</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="__rmul__" type="DateSpan" overloaded="no">
- <autodoc>__rmul__(int n) -> DateSpan</autodoc>
+ <autodoc>__rmul__(self, int n) -> DateSpan</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(DateSpan other) -> bool</autodoc>
+ <autodoc>__eq__(self, DateSpan other) -> bool</autodoc>
<paramlist>
<param name="other" type="DateSpan" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(DateSpan other) -> bool</autodoc>
+ <autodoc>__ne__(self, DateSpan other) -> bool</autodoc>
<paramlist>
<param name="other" type="DateSpan" default=""/>
</paramlist>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="DataFormat" oldname="wxDataFormat" module="misc">
+ <class name="DataFormat" oldname="wxDataFormat" module="_misc">
<docstring>A wx.DataFormat is an encapsulation of a platform-specific format
-handle which is used by the system for the clipboard and drag and
-drop operations. The applications are usually only interested in,
-for example, pasting data from the clipboard only if the data is
-in a format the program understands. A data format is is used to
-uniquely identify this format.
-
-On the system level, a data format is usually just a number
-(CLIPFORMAT under Windows or Atom under X11, for example).</docstring>
+handle which is used by the system for the clipboard and drag and drop
+operations. The applications are usually only interested in, for
+example, pasting data from the clipboard only if the data is in a
+format the program understands. A data format is is used to uniquely
+identify this format.</docstring>
<constructor name="DataFormat" overloaded="no">
- <autodoc>__init__(int type) -> DataFormat</autodoc>
- <docstring>Constructs a data format object for one of the standard data
-formats or an empty data object (use SetType or SetId later in
-this case)</docstring>
+ <autodoc>__init__(self, int type) -> DataFormat</autodoc>
+ <docstring>Constructs a data format object for one of the standard data formats
+or an empty data object (use SetType or SetId later in this case)</docstring>
<paramlist>
<param name="type" type="wxDataFormatId" default=""/>
</paramlist>
</constructor>
<constructor name="CustomDataFormat" overloaded="no">
<autodoc>CustomDataFormat(String format) -> DataFormat</autodoc>
- <docstring>Constructs a data format object for a custom format identified by its name.</docstring>
+ <docstring>Constructs a data format object for a custom format identified by its
+name.</docstring>
<paramlist>
<param name="format" type="String" default=""/>
</paramlist>
</constructor>
<destructor name="~wxDataFormat" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="__eq__" type="bool" overloaded="yes">
<paramlist>
</paramlist>
</method>
<method name="__eq__" type="bool" overloaded="yes">
- <autodoc>__eq__(int format) -> bool
-__eq__(DataFormat format) -> bool</autodoc>
+ <autodoc>__eq__(self, int format) -> bool
+__eq__(self, DataFormat format) -> bool</autodoc>
<paramlist>
<param name="format" type="DataFormat" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="yes">
- <autodoc>__ne__(int format) -> bool
-__ne__(DataFormat format) -> bool</autodoc>
+ <autodoc>__ne__(self, int format) -> bool
+__ne__(self, DataFormat format) -> bool</autodoc>
<paramlist>
<param name="format" type="DataFormat" default=""/>
</paramlist>
</method>
<method name="SetType" type="" overloaded="no">
- <autodoc>SetType(int format)</autodoc>
- <docstring>Sets the format to the given value, which should be one of wx.DF_XXX constants.</docstring>
+ <autodoc>SetType(self, int format)</autodoc>
+ <docstring>Sets the format to the given value, which should be one of wx.DF_XXX
+constants.</docstring>
<paramlist>
<param name="format" type="wxDataFormatId" default=""/>
</paramlist>
</method>
<method name="GetType" type="wxDataFormatId" overloaded="no">
- <autodoc>GetType() -> int</autodoc>
+ <autodoc>GetType(self) -> int</autodoc>
<docstring>Returns the platform-specific number identifying the format.</docstring>
</method>
<method name="GetId" type="String" overloaded="no">
- <autodoc>GetId() -> String</autodoc>
- <docstring>Returns the name of a custom format (this function will fail for a standard format).</docstring>
+ <autodoc>GetId(self) -> String</autodoc>
+ <docstring>Returns the name of a custom format (this function will fail for a
+standard format).</docstring>
</method>
<method name="SetId" type="" overloaded="no">
- <autodoc>SetId(String format)</autodoc>
+ <autodoc>SetId(self, String format)</autodoc>
<docstring>Sets the format to be the custom format identified by the given name.</docstring>
<paramlist>
<param name="format" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="DataObject" oldname="wxDataObject" module="misc">
+ <class name="DataObject" oldname="wxDataObject" module="_misc">
+ <docstring>A wx.DataObject represents data that can be copied to or from the
+clipboard, or dragged and dropped. The important thing about
+wx.DataObject is that this is a 'smart' piece of data unlike usual
+'dumb' data containers such as memory buffers or files. Being 'smart'
+here means that the data object itself should know what data formats
+it supports and how to render itself in each of supported formats.
+
+**NOTE**: This class is an abstract base class and can not be used
+directly from Python. If you need a custom type of data object then
+you should instead derive from `wx.PyDataObjectSimple` or use
+`wx.CustomDataObject`.
+</docstring>
<destructor name="~wxDataObject" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetPreferredFormat" type="DataFormat" overloaded="no">
- <autodoc>GetPreferredFormat(int dir=Get) -> DataFormat</autodoc>
+ <autodoc>GetPreferredFormat(self, int dir=Get) -> DataFormat</autodoc>
+ <docstring>Returns the preferred format for either rendering the data (if dir is
+Get, its default value) or for setting it. Usually this will be the
+native format of the wx.DataObject.</docstring>
<paramlist>
<param name="dir" type="wxDataObject::Direction" default="wxDataObject::Get"/>
</paramlist>
</method>
<method name="GetFormatCount" type="size_t" overloaded="no">
- <autodoc>GetFormatCount(int dir=Get) -> size_t</autodoc>
+ <autodoc>GetFormatCount(self, int dir=Get) -> size_t</autodoc>
+ <docstring>Returns the number of available formats for rendering or setting the
+data.</docstring>
<paramlist>
<param name="dir" type="wxDataObject::Direction" default="wxDataObject::Get"/>
</paramlist>
</method>
<method name="IsSupported" type="bool" overloaded="no">
- <autodoc>IsSupported(DataFormat format, int dir=Get) -> bool</autodoc>
+ <autodoc>IsSupported(self, DataFormat format, int dir=Get) -> bool</autodoc>
+ <docstring>Returns True if this format is supported.</docstring>
<paramlist>
<param name="format" type="DataFormat" default=""/>
<param name="dir" type="wxDataObject::Direction" default="wxDataObject::Get"/>
</paramlist>
</method>
<method name="GetDataSize" type="size_t" overloaded="no">
- <autodoc>GetDataSize(DataFormat format) -> size_t</autodoc>
+ <autodoc>GetDataSize(self, DataFormat format) -> size_t</autodoc>
+ <docstring>Get the (total) size of data for the given format</docstring>
<paramlist>
<param name="format" type="DataFormat" default=""/>
</paramlist>
</method>
- <method name="GetAllFormats" type="" overloaded="no">
- <autodoc>GetAllFormats(DataFormat formats, int dir=Get)</autodoc>
+ <method name="GetAllFormats" type="PyObject" overloaded="no">
+ <autodoc>GetAllFormats(self, int dir=Get) -> [formats]</autodoc>
+ <docstring>Returns a list of all the wx.DataFormats that this dataobject supports
+in the given direction.</docstring>
<paramlist>
- <param name="formats" type="DataFormat" default=""/>
<param name="dir" type="wxDataObject::Direction" default="wxDataObject::Get"/>
</paramlist>
</method>
- <method name="GetDataHere" type="bool" overloaded="no">
- <autodoc>GetDataHere(DataFormat format, void buf) -> bool</autodoc>
+ <method name="GetDataHere" type="PyObject" overloaded="no">
+ <autodoc>GetDataHere(self, DataFormat format) -> String</autodoc>
+ <docstring>Get the data bytes in the specified format, returns None on failure.
+</docstring>
<paramlist>
<param name="format" type="DataFormat" default=""/>
- <param name="buf" type="" default=""/>
</paramlist>
</method>
<method name="SetData" type="bool" overloaded="no">
- <autodoc>SetData(DataFormat format, size_t len, void buf) -> bool</autodoc>
+ <autodoc>SetData(self, DataFormat format, String data) -> bool</autodoc>
+ <docstring>Set the data in the specified format from the bytes in the the data string.
+</docstring>
<paramlist>
<param name="format" type="DataFormat" default=""/>
- <param name="len" type="size_t" default=""/>
- <param name="buf" type="" default=""/>
+ <param name="data" type="PyObject" default=""/>
</paramlist>
</method>
</class>
- <class name="DataObjectSimple" oldname="wxDataObjectSimple" module="misc">
+ <class name="DataObjectSimple" oldname="wxDataObjectSimple" module="_misc">
+ <docstring>wx.DataObjectSimple is a `wx.DataObject` which only supports one
+format. This is the simplest possible `wx.DataObject` implementation.
+
+This is still an "abstract base class" meaning that you can't use it
+directly. You either need to use one of the predefined base classes,
+or derive your own class from `wx.PyDataObjectSimple`.
+</docstring>
<baseclass name="DataObject"/>
<constructor name="DataObjectSimple" overloaded="no">
- <autodoc>__init__(DataFormat format=FormatInvalid) -> DataObjectSimple</autodoc>
+ <autodoc>__init__(self, DataFormat format=FormatInvalid) -> DataObjectSimple</autodoc>
+ <docstring>Constructor accepts the supported format (none by default) which may
+also be set later with `SetFormat`.</docstring>
<paramlist>
<param name="format" type="DataFormat" default="wxFormatInvalid"/>
</paramlist>
</constructor>
<method name="GetFormat" type="DataFormat" overloaded="no">
- <autodoc>GetFormat() -> DataFormat</autodoc>
+ <autodoc>GetFormat(self) -> DataFormat</autodoc>
+ <docstring>Returns the (one and only one) format supported by this object. It is
+assumed that the format is supported in both directions.</docstring>
</method>
<method name="SetFormat" type="" overloaded="no">
- <autodoc>SetFormat(DataFormat format)</autodoc>
+ <autodoc>SetFormat(self, DataFormat format)</autodoc>
+ <docstring>Sets the supported format.</docstring>
<paramlist>
<param name="format" type="DataFormat" default=""/>
</paramlist>
</method>
+ <method name="GetDataSize" type="size_t" overloaded="no">
+ <autodoc>GetDataSize(self) -> size_t</autodoc>
+ <docstring>Get the size of our data.</docstring>
+ </method>
+ <method name="GetDataHere" type="PyObject" overloaded="no">
+ <autodoc>GetDataHere(self) -> String</autodoc>
+ <docstring>Returns the data bytes from the data object as a string, returns None
+on failure. Must be implemented in the derived class if the object
+supports rendering its data.</docstring>
+ </method>
+ <method name="SetData" type="bool" overloaded="no">
+ <autodoc>SetData(self, String data) -> bool</autodoc>
+ <docstring>Copy the data value to the data object. Must be implemented in the
+derived class if the object supports setting its data.
+</docstring>
+ <paramlist>
+ <param name="data" type="PyObject" default=""/>
+ </paramlist>
+ </method>
</class>
- <class name="PyDataObjectSimple" oldname="wxPyDataObjectSimple" module="misc">
+ <class name="PyDataObjectSimple" oldname="wxPyDataObjectSimple" module="_misc">
+ <docstring>wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is
+Python-aware and knows how to reflect calls to its C++ virtual methods
+to methods in the Python derived class. You should derive from this
+class and overload `GetDataSize`, `GetDataHere` and `SetData` when you
+need to create your own simple single-format type of `wx.DataObject`.
+</docstring>
<baseclass name="DataObjectSimple"/>
<constructor name="PyDataObjectSimple" overloaded="no">
- <autodoc>__init__(DataFormat format=FormatInvalid) -> PyDataObjectSimple</autodoc>
+ <autodoc>__init__(self, DataFormat format=FormatInvalid) -> PyDataObjectSimple</autodoc>
+ <docstring>wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is
+Python-aware and knows how to reflect calls to its C++ virtual methods
+to methods in the Python derived class. You should derive from this
+class and overload `GetDataSize`, `GetDataHere` and `SetData` when you
+need to create your own simple single-format type of `wx.DataObject`.
+</docstring>
<paramlist>
<param name="format" type="DataFormat" default="wxFormatInvalid"/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
</class>
- <class name="DataObjectComposite" oldname="wxDataObjectComposite" module="misc">
+ <class name="DataObjectComposite" oldname="wxDataObjectComposite" module="_misc">
+ <docstring>wx.DataObjectComposite is the simplest `wx.DataObject` derivation
+which may be sued to support multiple formats. It contains several
+'wx.DataObjectSimple` objects and supports any format supported by at
+least one of them. Only one of these data objects is *preferred* (the
+first one if not explicitly changed by using the second parameter of
+`Add`) and its format determines the preferred format of the composite
+data object as well.
+
+See `wx.DataObject` documentation for the reasons why you might prefer
+to use wx.DataObject directly instead of wx.DataObjectComposite for
+efficiency reasons.
+</docstring>
<baseclass name="DataObject"/>
<constructor name="DataObjectComposite" overloaded="no">
- <autodoc>__init__() -> DataObjectComposite</autodoc>
+ <autodoc>__init__(self) -> DataObjectComposite</autodoc>
+ <docstring>wx.DataObjectComposite is the simplest `wx.DataObject` derivation
+which may be sued to support multiple formats. It contains several
+'wx.DataObjectSimple` objects and supports any format supported by at
+least one of them. Only one of these data objects is *preferred* (the
+first one if not explicitly changed by using the second parameter of
+`Add`) and its format determines the preferred format of the composite
+data object as well.
+
+See `wx.DataObject` documentation for the reasons why you might prefer
+to use wx.DataObject directly instead of wx.DataObjectComposite for
+efficiency reasons.
+</docstring>
</constructor>
<method name="Add" type="" overloaded="no">
- <autodoc>Add(DataObjectSimple dataObject, int preferred=False)</autodoc>
+ <autodoc>Add(self, DataObjectSimple dataObject, bool preferred=False)</autodoc>
+ <docstring>Adds the dataObject to the list of supported objects and it becomes
+the preferred object if preferred is True.</docstring>
<paramlist>
<param name="dataObject" type="DataObjectSimple" default=""/>
- <param name="preferred" type="int" default="False"/>
+ <param name="preferred" type="bool" default="False"/>
</paramlist>
</method>
</class>
- <class name="TextDataObject" oldname="wxTextDataObject" module="misc">
+ <class name="TextDataObject" oldname="wxTextDataObject" module="_misc">
+ <docstring>wx.TextDataObject is a specialization of `wx.DataObject` for text
+data. It can be used without change to paste data into the `wx.Clipboard`
+or a `wx.DropSource`.
+
+Alternativly, you may wish to derive a new class from the
+`wx.PyTextDataObject` class for providing text on-demand in order to
+minimize memory consumption when offering data in several formats,
+such as plain text and RTF, because by default the text is stored in a
+string in this class, but it might as well be generated on demand when
+requested. For this, `GetTextLength` and `GetText` will have to be
+overridden.</docstring>
<baseclass name="DataObjectSimple"/>
<constructor name="TextDataObject" overloaded="no">
- <autodoc>__init__(String text=EmptyString) -> TextDataObject</autodoc>
+ <autodoc>__init__(self, String text=EmptyString) -> TextDataObject</autodoc>
+ <docstring>Constructor, may be used to initialise the text (otherwise `SetText`
+should be used later).</docstring>
<paramlist>
<param name="text" type="String" default="wxPyEmptyString"/>
</paramlist>
</constructor>
<method name="GetTextLength" type="size_t" overloaded="no">
- <autodoc>GetTextLength() -> size_t</autodoc>
+ <autodoc>GetTextLength(self) -> size_t</autodoc>
+ <docstring>Returns the data size. By default, returns the size of the text data
+set in the constructor or using `SetText`. This can be overridden (via
+`wx.PyTextDataObject`) to provide text size data on-demand. It is
+recommended to return the text length plus 1 for a trailing zero, but
+this is not strictly required.</docstring>
</method>
<method name="GetText" type="String" overloaded="no">
- <autodoc>GetText() -> String</autodoc>
+ <autodoc>GetText(self) -> String</autodoc>
+ <docstring>Returns the text associated with the data object.</docstring>
</method>
<method name="SetText" type="" overloaded="no">
- <autodoc>SetText(String text)</autodoc>
+ <autodoc>SetText(self, String text)</autodoc>
+ <docstring>Sets the text associated with the data object. This method is called
+when the data object receives the data and, by default, copies the
+text into the member variable. If you want to process the text on the
+fly you may wish to override this function (via
+`wx.PyTextDataObject`.)</docstring>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="PyTextDataObject" oldname="wxPyTextDataObject" module="misc">
+ <class name="PyTextDataObject" oldname="wxPyTextDataObject" module="_misc">
+ <docstring>wx.PyTextDataObject is a version of `wx.TextDataObject` that is
+Python-aware and knows how to reflect calls to its C++ virtual methods
+to methods in the Python derived class. You should derive from this
+class and overload `GetTextLength`, `GetText`, and `SetText` when you
+want to be able to provide text on demand instead of preloading it
+into the data object.</docstring>
<baseclass name="TextDataObject"/>
<constructor name="PyTextDataObject" overloaded="no">
- <autodoc>__init__(String text=EmptyString) -> PyTextDataObject</autodoc>
+ <autodoc>__init__(self, String text=EmptyString) -> PyTextDataObject</autodoc>
+ <docstring>wx.PyTextDataObject is a version of `wx.TextDataObject` that is
+Python-aware and knows how to reflect calls to its C++ virtual methods
+to methods in the Python derived class. You should derive from this
+class and overload `GetTextLength`, `GetText`, and `SetText` when you
+want to be able to provide text on demand instead of preloading it
+into the data object.</docstring>
<paramlist>
<param name="text" type="String" default="wxPyEmptyString"/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
</class>
- <class name="BitmapDataObject" oldname="wxBitmapDataObject" module="misc">
+ <class name="BitmapDataObject" oldname="wxBitmapDataObject" module="_misc">
+ <docstring>wx.BitmapDataObject is a specialization of wxDataObject for bitmap
+data. It can be used without change to paste data into the `wx.Clipboard`
+or a `wx.DropSource`.
+</docstring>
<baseclass name="DataObjectSimple"/>
<constructor name="BitmapDataObject" overloaded="no">
- <autodoc>__init__(Bitmap bitmap=wxNullBitmap) -> BitmapDataObject</autodoc>
+ <autodoc>__init__(self, Bitmap bitmap=wxNullBitmap) -> BitmapDataObject</autodoc>
+ <docstring>Constructor, optionally passing a bitmap (otherwise use `SetBitmap`
+later).</docstring>
<paramlist>
<param name="bitmap" type="Bitmap" default="wxNullBitmap"/>
</paramlist>
</constructor>
<method name="GetBitmap" type="Bitmap" overloaded="no">
- <autodoc>GetBitmap() -> Bitmap</autodoc>
+ <autodoc>GetBitmap(self) -> Bitmap</autodoc>
+ <docstring>Returns the bitmap associated with the data object. You may wish to
+override this method (by deriving from `wx.PyBitmapDataObject`) when
+offering data on-demand, but this is not required by wxWidgets'
+internals. Use this method to get data in bitmap form from the
+`wx.Clipboard`.</docstring>
</method>
<method name="SetBitmap" type="" overloaded="no">
- <autodoc>SetBitmap(Bitmap bitmap)</autodoc>
+ <autodoc>SetBitmap(self, Bitmap bitmap)</autodoc>
+ <docstring>Sets the bitmap associated with the data object. This method is called
+when the data object receives data. Usually there will be no reason to
+override this function.</docstring>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
</paramlist>
</method>
</class>
- <class name="PyBitmapDataObject" oldname="wxPyBitmapDataObject" module="misc">
+ <class name="PyBitmapDataObject" oldname="wxPyBitmapDataObject" module="_misc">
+ <docstring>wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is
+Python-aware and knows how to reflect calls to its C++ virtual methods
+to methods in the Python derived class. To be able to provide bitmap
+data on demand derive from this class and overload `GetBitmap`.</docstring>
<baseclass name="BitmapDataObject"/>
<constructor name="PyBitmapDataObject" overloaded="no">
- <autodoc>__init__(Bitmap bitmap=wxNullBitmap) -> PyBitmapDataObject</autodoc>
+ <autodoc>__init__(self, Bitmap bitmap=wxNullBitmap) -> PyBitmapDataObject</autodoc>
+ <docstring>wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is
+Python-aware and knows how to reflect calls to its C++ virtual methods
+to methods in the Python derived class. To be able to provide bitmap
+data on demand derive from this class and overload `GetBitmap`.</docstring>
<paramlist>
<param name="bitmap" type="Bitmap" default="wxNullBitmap"/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
</class>
- <class name="FileDataObject" oldname="wxFileDataObject" module="misc">
+ <class name="FileDataObject" oldname="wxFileDataObject" module="_misc">
+ <docstring>wx.FileDataObject is a specialization of `wx.DataObjectSimple` for
+file names. The program works with it just as if it were a list of
+absolute file names, but internally it uses the same format as
+Explorer and other compatible programs under Windows or GNOME/KDE
+filemanager under Unix which makes it possible to receive files from
+them using this class.
+
+:Warning: Under all non-Windows platforms this class is currently
+ "input-only", i.e. you can receive the files from another
+ application, but copying (or dragging) file(s) from a wxWidgets
+ application is not currently supported.
+</docstring>
<baseclass name="DataObjectSimple"/>
<constructor name="FileDataObject" overloaded="no">
- <autodoc>__init__() -> FileDataObject</autodoc>
+ <autodoc>__init__(self) -> FileDataObject</autodoc>
</constructor>
<method name="GetFilenames" type="wxArrayString" overloaded="no">
- <autodoc>GetFilenames() -> wxArrayString</autodoc>
+ <autodoc>GetFilenames(self) -> [names]</autodoc>
</method>
<method name="AddFile" type="" overloaded="no">
- <autodoc>AddFile(String filename)</autodoc>
+ <autodoc>AddFile(self, String filename)</autodoc>
+ <docstring>Adds a file to the list of files represented by this data object.</docstring>
<paramlist>
<param name="filename" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="CustomDataObject" oldname="wxCustomDataObject" module="misc">
+ <class name="CustomDataObject" oldname="wxCustomDataObject" module="_misc">
+ <docstring>wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for
+some application-specific data in arbitrary format. Python strings
+are used for getting and setting data, but any picklable object can
+easily be transfered via strings. A copy of the data is stored in the
+data object.</docstring>
<baseclass name="DataObjectSimple"/>
<constructor name="CustomDataObject" overloaded="no">
- <autodoc>__init__(DataFormat format=FormatInvalid) -> CustomDataObject</autodoc>
+ <autodoc>__init__(self, DataFormat format=FormatInvalid) -> CustomDataObject</autodoc>
+ <docstring>wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for
+some application-specific data in arbitrary format. Python strings
+are used for getting and setting data, but any picklable object can
+easily be transfered via strings. A copy of the data is stored in the
+data object.</docstring>
<paramlist>
<param name="format" type="DataFormat" default="wxFormatInvalid"/>
</paramlist>
</constructor>
- <method name="TakeData" type="" overloaded="no">
- <autodoc>TakeData(PyObject data)</autodoc>
- <paramlist>
- <param name="data" type="PyObject" default=""/>
- </paramlist>
- </method>
<method name="SetData" type="bool" overloaded="no">
- <autodoc>SetData(PyObject data) -> bool</autodoc>
+ <autodoc>SetData(self, String data) -> bool</autodoc>
+ <docstring>Copy the data value to the data object.</docstring>
<paramlist>
<param name="data" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetSize" type="size_t" overloaded="no">
- <autodoc>GetSize() -> size_t</autodoc>
+ <autodoc>GetSize(self) -> size_t</autodoc>
+ <docstring>Get the size of the data.</docstring>
</method>
<method name="GetData" type="PyObject" overloaded="no">
- <autodoc>GetData() -> PyObject</autodoc>
+ <autodoc>GetData(self) -> String</autodoc>
+ <docstring>Returns the data bytes from the data object as a string.</docstring>
</method>
</class>
- <class name="URLDataObject" oldname="wxURLDataObject" module="misc">
+ <class name="URLDataObject" oldname="wxURLDataObject" module="_misc">
+ <docstring>This data object holds a URL in a format that is compatible with some
+browsers such that it is able to be dragged to or from them.</docstring>
<baseclass name="DataObjectComposite"/>
<constructor name="URLDataObject" overloaded="no">
- <autodoc>__init__() -> URLDataObject</autodoc>
+ <autodoc>__init__(self) -> URLDataObject</autodoc>
+ <docstring>This data object holds a URL in a format that is compatible with some
+browsers such that it is able to be dragged to or from them.</docstring>
</constructor>
<method name="GetURL" type="String" overloaded="no">
- <autodoc>GetURL() -> String</autodoc>
+ <autodoc>GetURL(self) -> String</autodoc>
+ <docstring>Returns a string containing the current URL.</docstring>
</method>
<method name="SetURL" type="" overloaded="no">
- <autodoc>SetURL(String url)</autodoc>
+ <autodoc>SetURL(self, String url)</autodoc>
+ <docstring>Set the URL.</docstring>
<paramlist>
<param name="url" type="String" default=""/>
</paramlist>
</method>
</class>
- <class name="MetafileDataObject" oldname="wxMetafileDataObject" module="misc">
+ <class name="MetafileDataObject" oldname="wxMetafileDataObject" module="_misc">
<baseclass name="DataObjectSimple"/>
<constructor name="MetafileDataObject" overloaded="no">
- <autodoc>__init__() -> MetafileDataObject</autodoc>
+ <autodoc>__init__(self) -> MetafileDataObject</autodoc>
</constructor>
</class>
<pythoncode>
<param name="res" type="wxDragResult" default=""/>
</paramlist>
</method>
- <class name="DropSource" oldname="wxPyDropSource" module="misc">
+ <class name="DropSource" oldname="wxPyDropSource" module="_misc">
<constructor name="wxPyDropSource" overloaded="no">
- <autodoc>__init__(Window win, Icon copy=wxNullIcon, Icon move=wxNullIcon,
+ <autodoc>__init__(self, Window win, Icon copy=wxNullIcon, Icon move=wxNullIcon,
Icon none=wxNullIcon) -> DropSource</autodoc>
<paramlist>
<param name="win" type="Window" default=""/>
</paramlist>
</constructor>
<destructor name="~wxPyDropSource" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class, int incref)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, int incref)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetData" type="" overloaded="no">
- <autodoc>SetData(DataObject data)</autodoc>
+ <autodoc>SetData(self, DataObject data)</autodoc>
<paramlist>
<param name="data" type="DataObject" default=""/>
</paramlist>
</method>
<method name="GetDataObject" type="DataObject" overloaded="no">
- <autodoc>GetDataObject() -> DataObject</autodoc>
+ <autodoc>GetDataObject(self) -> DataObject</autodoc>
</method>
<method name="SetCursor" type="" overloaded="no">
- <autodoc>SetCursor(int res, Cursor cursor)</autodoc>
+ <autodoc>SetCursor(self, int res, Cursor cursor)</autodoc>
<paramlist>
<param name="res" type="wxDragResult" default=""/>
<param name="cursor" type="Cursor" default=""/>
</paramlist>
</method>
<method name="DoDragDrop" type="wxDragResult" overloaded="no">
- <autodoc>DoDragDrop(int flags=Drag_CopyOnly) -> int</autodoc>
+ <autodoc>DoDragDrop(self, int flags=Drag_CopyOnly) -> int</autodoc>
<paramlist>
<param name="flags" type="int" default="wxDrag_CopyOnly"/>
</paramlist>
</method>
<method name="base_GiveFeedback" type="bool" overloaded="no">
- <autodoc>base_GiveFeedback(int effect) -> bool</autodoc>
+ <autodoc>base_GiveFeedback(self, int effect) -> bool</autodoc>
<paramlist>
<param name="effect" type="wxDragResult" default=""/>
</paramlist>
</method>
</class>
- <class name="DropTarget" oldname="wxPyDropTarget" module="misc">
+ <class name="DropTarget" oldname="wxPyDropTarget" module="_misc">
<constructor name="DropTarget" overloaded="no">
- <autodoc>__init__(DataObject dataObject=None) -> DropTarget</autodoc>
+ <autodoc>__init__(self, DataObject dataObject=None) -> DropTarget</autodoc>
<paramlist>
<param name="dataObject" type="DataObject" default="NULL"/>
</paramlist>
</constructor>
<destructor name="~wxPyDropTarget" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetDataObject" type="DataObject" overloaded="no">
- <autodoc>GetDataObject() -> DataObject</autodoc>
+ <autodoc>GetDataObject(self) -> DataObject</autodoc>
</method>
<method name="SetDataObject" type="" overloaded="no">
- <autodoc>SetDataObject(DataObject dataObject)</autodoc>
+ <autodoc>SetDataObject(self, DataObject dataObject)</autodoc>
<paramlist>
<param name="dataObject" type="DataObject" default=""/>
</paramlist>
</method>
<method name="base_OnEnter" type="wxDragResult" overloaded="no">
- <autodoc>base_OnEnter(int x, int y, int def) -> int</autodoc>
+ <autodoc>base_OnEnter(self, int x, int y, int def) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_OnDragOver" type="wxDragResult" overloaded="no">
- <autodoc>base_OnDragOver(int x, int y, int def) -> int</autodoc>
+ <autodoc>base_OnDragOver(self, int x, int y, int def) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_OnLeave" type="" overloaded="no">
- <autodoc>base_OnLeave()</autodoc>
+ <autodoc>base_OnLeave(self)</autodoc>
</method>
<method name="base_OnDrop" type="bool" overloaded="no">
- <autodoc>base_OnDrop(int x, int y) -> bool</autodoc>
+ <autodoc>base_OnDrop(self, int x, int y) -> bool</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="GetData" type="bool" overloaded="no">
- <autodoc>GetData() -> bool</autodoc>
+ <autodoc>GetData(self) -> bool</autodoc>
</method>
</class>
<pythoncode> PyDropTarget = DropTarget </pythoncode>
- <class name="TextDropTarget" oldname="wxPyTextDropTarget" module="misc">
+ <class name="TextDropTarget" oldname="wxPyTextDropTarget" module="_misc">
<baseclass name="DropTarget"/>
<constructor name="wxPyTextDropTarget" overloaded="no">
- <autodoc>__init__() -> TextDropTarget</autodoc>
+ <autodoc>__init__(self) -> TextDropTarget</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="base_OnEnter" type="wxDragResult" overloaded="no">
- <autodoc>base_OnEnter(int x, int y, int def) -> int</autodoc>
+ <autodoc>base_OnEnter(self, int x, int y, int def) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_OnDragOver" type="wxDragResult" overloaded="no">
- <autodoc>base_OnDragOver(int x, int y, int def) -> int</autodoc>
+ <autodoc>base_OnDragOver(self, int x, int y, int def) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_OnLeave" type="" overloaded="no">
- <autodoc>base_OnLeave()</autodoc>
+ <autodoc>base_OnLeave(self)</autodoc>
</method>
<method name="base_OnDrop" type="bool" overloaded="no">
- <autodoc>base_OnDrop(int x, int y) -> bool</autodoc>
+ <autodoc>base_OnDrop(self, int x, int y) -> bool</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_OnData" type="wxDragResult" overloaded="no">
- <autodoc>base_OnData(int x, int y, int def) -> int</autodoc>
+ <autodoc>base_OnData(self, int x, int y, int def) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
</class>
- <class name="FileDropTarget" oldname="wxPyFileDropTarget" module="misc">
+ <class name="FileDropTarget" oldname="wxPyFileDropTarget" module="_misc">
<baseclass name="DropTarget"/>
<constructor name="wxPyFileDropTarget" overloaded="no">
- <autodoc>__init__() -> FileDropTarget</autodoc>
+ <autodoc>__init__(self) -> FileDropTarget</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="base_OnEnter" type="wxDragResult" overloaded="no">
- <autodoc>base_OnEnter(int x, int y, int def) -> int</autodoc>
+ <autodoc>base_OnEnter(self, int x, int y, int def) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_OnDragOver" type="wxDragResult" overloaded="no">
- <autodoc>base_OnDragOver(int x, int y, int def) -> int</autodoc>
+ <autodoc>base_OnDragOver(self, int x, int y, int def) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_OnLeave" type="" overloaded="no">
- <autodoc>base_OnLeave()</autodoc>
+ <autodoc>base_OnLeave(self)</autodoc>
</method>
<method name="base_OnDrop" type="bool" overloaded="no">
- <autodoc>base_OnDrop(int x, int y) -> bool</autodoc>
+ <autodoc>base_OnDrop(self, int x, int y) -> bool</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_OnData" type="wxDragResult" overloaded="no">
- <autodoc>base_OnData(int x, int y, int def) -> int</autodoc>
+ <autodoc>base_OnData(self, int x, int y, int def) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="Clipboard" oldname="wxClipboard" module="misc">
- <docstring>wx.Clipboard represents the system clipboard and provides methods to copy data
-to or paste data from it. Normally, you should only use wx.TheClipboard which
-is a reference to a global wx.Clipboard instance.
-
-Call wx.TheClipboard.Open to get ownership of the clipboard. If this operation
-returns True, you now own the clipboard. Call wx.TheClipboard.SetData to put
-data on the clipboard, or wx.TheClipboard.GetData to retrieve data from the
-clipboard. Call wx.TheClipboard.Close to close the clipboard and relinquish
-ownership. You should keep the clipboard open only momentarily.
+ <class name="Clipboard" oldname="wxClipboard" module="_misc">
+ <docstring>wx.Clipboard represents the system clipboard and provides methods to
+copy data to it or paste data from it. Normally, you should only use
+``wx.TheClipboard`` which is a reference to a global wx.Clipboard
+instance.
+
+Call ``wx.TheClipboard``'s `Open` method to get ownership of the
+clipboard. If this operation returns True, you now own the
+clipboard. Call `SetData` to put data on the clipboard, or `GetData`
+to retrieve data from the clipboard. Call `Close` to close the
+clipboard and relinquish ownership. You should keep the clipboard open
+only momentarily.
+
+:see: `wx.DataObject`
</docstring>
<baseclass name="Object"/>
<constructor name="Clipboard" overloaded="no">
- <autodoc>__init__() -> Clipboard</autodoc>
+ <autodoc>__init__(self) -> Clipboard</autodoc>
</constructor>
<destructor name="~wxClipboard" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Open" type="bool" overloaded="no">
- <autodoc>Open() -> bool</autodoc>
- <docstring>Call this function to open the clipboard before calling SetData
-and GetData. Call Close when you have finished with the clipboard.
-You should keep the clipboard open for only a very short time.
-Returns true on success. </docstring>
+ <autodoc>Open(self) -> bool</autodoc>
+ <docstring>Call this function to open the clipboard before calling SetData and
+GetData. Call Close when you have finished with the clipboard. You
+should keep the clipboard open for only a very short time. Returns
+True on success.</docstring>
</method>
<method name="Close" type="" overloaded="no">
- <autodoc>Close()</autodoc>
+ <autodoc>Close(self)</autodoc>
<docstring>Closes the clipboard.</docstring>
</method>
<method name="IsOpened" type="bool" overloaded="no">
- <autodoc>IsOpened() -> bool</autodoc>
+ <autodoc>IsOpened(self) -> bool</autodoc>
<docstring>Query whether the clipboard is opened</docstring>
</method>
<method name="AddData" type="bool" overloaded="no">
- <autodoc>AddData(DataObject data) -> bool</autodoc>
- <docstring>Call this function to add the data object to the clipboard. You
-may call this function repeatedly after having cleared the clipboard.
+ <autodoc>AddData(self, DataObject data) -> bool</autodoc>
+ <docstring>Call this function to add the data object to the clipboard. You may
+call this function repeatedly after having cleared the clipboard.
After this function has been called, the clipboard owns the data, so
-do not delete the data explicitly.</docstring>
+do not delete the data explicitly.
+
+:see: `wx.DataObject`</docstring>
<paramlist>
<param name="data" type="DataObject" default=""/>
</paramlist>
</method>
<method name="SetData" type="bool" overloaded="no">
- <autodoc>SetData(DataObject data) -> bool</autodoc>
- <docstring>Set the clipboard data, this is the same as Clear followed by AddData.</docstring>
+ <autodoc>SetData(self, DataObject data) -> bool</autodoc>
+ <docstring>Set the clipboard data, this is the same as `Clear` followed by
+`AddData`.
+
+:see: `wx.DataObject`</docstring>
<paramlist>
<param name="data" type="DataObject" default=""/>
</paramlist>
</method>
<method name="IsSupported" type="bool" overloaded="no">
- <autodoc>IsSupported(DataFormat format) -> bool</autodoc>
+ <autodoc>IsSupported(self, DataFormat format) -> bool</autodoc>
<docstring>Returns True if the given format is available in the data object(s) on
the clipboard.</docstring>
<paramlist>
</paramlist>
</method>
<method name="GetData" type="bool" overloaded="no">
- <autodoc>GetData(DataObject data) -> bool</autodoc>
- <docstring>Call this function to fill data with data on the clipboard, if available
-in the required format. Returns true on success.</docstring>
+ <autodoc>GetData(self, DataObject data) -> bool</autodoc>
+ <docstring>Call this function to fill data with data on the clipboard, if
+available in the required format. Returns true on success.</docstring>
<paramlist>
<param name="data" type="DataObject" default=""/>
</paramlist>
</method>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear()</autodoc>
- <docstring>Clears data from the clipboard object and also the system's clipboard
+ <autodoc>Clear(self)</autodoc>
+ <docstring>Clears data from the clipboard object and also the system's clipboard
if possible.</docstring>
</method>
<method name="Flush" type="bool" overloaded="no">
- <autodoc>Flush() -> bool</autodoc>
+ <autodoc>Flush(self) -> bool</autodoc>
<docstring>Flushes the clipboard: this means that the data which is currently on
-clipboard will stay available even after the application exits (possibly
-eating memory), otherwise the clipboard will be emptied on exit.
-Returns False if the operation is unsuccesful for any reason.</docstring>
+clipboard will stay available even after the application exits,
+possibly eating memory, otherwise the clipboard will be emptied on
+exit. Returns False if the operation is unsuccesful for any reason.</docstring>
</method>
<method name="UsePrimarySelection" type="" overloaded="no">
- <autodoc>UsePrimarySelection(bool primary=True)</autodoc>
- <docstring>On platforms supporting it (the X11 based platforms), selects the so
-called PRIMARY SELECTION as the clipboard as opposed to the normal
-clipboard, if primary is True.</docstring>
+ <autodoc>UsePrimarySelection(self, bool primary=True)</autodoc>
+ <docstring>On platforms supporting it (the X11 based platforms), selects the
+so called PRIMARY SELECTION as the clipboard as opposed to the
+normal clipboard, if primary is True.</docstring>
<paramlist>
<param name="primary" type="bool" default="True"/>
</paramlist>
</method>
</class>
- <class name="ClipboardLocker" oldname="wxClipboardLocker" module="misc">
- <docstring>A helpful class for opening the clipboard and automatically closing it when
-the locker is destroyed.</docstring>
+ <class name="ClipboardLocker" oldname="wxClipboardLocker" module="_misc">
+ <docstring>A helpful class for opening the clipboard and automatically
+closing it when the locker is destroyed.</docstring>
<constructor name="ClipboardLocker" overloaded="no">
- <autodoc>__init__(Clipboard clipboard=None) -> ClipboardLocker</autodoc>
- <docstring>A helpful class for opening the clipboard and automatically closing it when
-the locker is destroyed.</docstring>
+ <autodoc>__init__(self, Clipboard clipboard=None) -> ClipboardLocker</autodoc>
+ <docstring>A helpful class for opening the clipboard and automatically
+closing it when the locker is destroyed.</docstring>
<paramlist>
<param name="clipboard" type="Clipboard" default="NULL"/>
</paramlist>
</constructor>
<destructor name="~wxClipboardLocker" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="__nonzero__" type="bool" overloaded="no">
- <autodoc>__nonzero__() -> bool</autodoc>
+ <autodoc>__nonzero__(self) -> bool</autodoc>
<docstring>A ClipboardLocker instance evaluates to True if the clipboard was
successfully opened.</docstring>
</method>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
- <class name="VideoMode" oldname="wxVideoMode" module="misc">
+ <class name="VideoMode" oldname="wxVideoMode" module="_misc">
<docstring>A simple struct containing video mode parameters for a display</docstring>
<constructor name="VideoMode" overloaded="no">
- <autodoc>__init__(int width=0, int height=0, int depth=0, int freq=0) -> VideoMode</autodoc>
+ <autodoc>__init__(self, int width=0, int height=0, int depth=0, int freq=0) -> VideoMode</autodoc>
<docstring>A simple struct containing video mode parameters for a display</docstring>
<paramlist>
<param name="width" type="int" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxVideoMode" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Matches" type="bool" overloaded="no">
- <autodoc>Matches(VideoMode other) -> bool</autodoc>
- <docstring>Returns true if this mode matches the other one in the sense that
-all non zero fields of the other mode have the same value in this
+ <autodoc>Matches(self, VideoMode other) -> bool</autodoc>
+ <docstring>Returns true if this mode matches the other one in the sense that all
+non zero fields of the other mode have the same value in this
one (except for refresh which is allowed to have a greater value)</docstring>
<paramlist>
<param name="other" type="VideoMode" default=""/>
</paramlist>
</method>
<method name="GetWidth" type="int" overloaded="no">
- <autodoc>GetWidth() -> int</autodoc>
- <docstring>Returns the screen width in pixels (e.g. 640*480), 0 means
-unspecified</docstring>
+ <autodoc>GetWidth(self) -> int</autodoc>
+ <docstring>Returns the screen width in pixels (e.g. 640*480), 0 means unspecified</docstring>
</method>
<method name="GetHeight" type="int" overloaded="no">
- <autodoc>GetHeight() -> int</autodoc>
+ <autodoc>GetHeight(self) -> int</autodoc>
<docstring>Returns the screen width in pixels (e.g. 640*480), 0 means
unspecified</docstring>
</method>
<method name="GetDepth" type="int" overloaded="no">
- <autodoc>GetDepth() -> int</autodoc>
- <docstring>Returns the screen's bits per pixel (e.g. 32), 1 is monochrome
-and 0 means unspecified/known</docstring>
+ <autodoc>GetDepth(self) -> int</autodoc>
+ <docstring>Returns the screen's bits per pixel (e.g. 32), 1 is monochrome and 0
+means unspecified/known</docstring>
</method>
<method name="IsOk" type="bool" overloaded="no">
- <autodoc>IsOk() -> bool</autodoc>
+ <autodoc>IsOk(self) -> bool</autodoc>
<docstring>returns true if the object has been initialized</docstring>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(VideoMode other) -> bool</autodoc>
+ <autodoc>__eq__(self, VideoMode other) -> bool</autodoc>
<paramlist>
<param name="other" type="VideoMode" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(VideoMode other) -> bool</autodoc>
+ <autodoc>__ne__(self, VideoMode other) -> bool</autodoc>
<paramlist>
<param name="other" type="VideoMode" default=""/>
</paramlist>
<property name="bpp" type="int" readonly="no"/>
<property name="refresh" type="int" readonly="no"/>
</class>
- <class name="Display" oldname="wxDisplay" module="misc">
+ <class name="Display" oldname="wxDisplay" module="_misc">
<docstring>Represents a display/monitor attached to the system</docstring>
<constructor name="Display" overloaded="no">
- <autodoc>__init__(size_t index=0) -> Display</autodoc>
- <docstring>Set up a Display instance with the specified display. The
-displays are numbered from 0 to GetCount() - 1, 0 is always the
-primary display and the only one which is always supported</docstring>
+ <autodoc>__init__(self, size_t index=0) -> Display</autodoc>
+ <docstring>Set up a Display instance with the specified display. The displays
+are numbered from 0 to GetCount() - 1, 0 is always the primary display
+and the only one which is always supported</docstring>
<paramlist>
<param name="index" type="size_t" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxDisplay" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<staticmethod name="GetCount" type="size_t" overloaded="no">
<autodoc>GetCount() -> size_t</autodoc>
</staticmethod>
<staticmethod name="GetFromPoint" type="int" overloaded="no">
<autodoc>GetFromPoint(Point pt) -> int</autodoc>
- <docstring>Find the display where the given point lies, return wx.NOT_FOUND
-if it doesn't belong to any display</docstring>
+ <docstring>Find the display where the given point lies, return wx.NOT_FOUND if it
+doesn't belong to any display</docstring>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</staticmethod>
<staticmethod name="GetFromWindow" type="int" overloaded="no">
<autodoc>GetFromWindow(Window window) -> int</autodoc>
- <docstring>Find the display where the given window lies, return wx.NOT_FOUND
-if it is not shown at all.</docstring>
+ <docstring>Find the display where the given window lies, return wx.NOT_FOUND if
+it is not shown at all.</docstring>
<paramlist>
<param name="window" type="Window" default=""/>
</paramlist>
</staticmethod>
<method name="IsOk" type="bool" overloaded="no">
- <autodoc>IsOk() -> bool</autodoc>
+ <autodoc>IsOk(self) -> bool</autodoc>
<docstring>Return true if the object was initialized successfully</docstring>
</method>
<method name="GetGeometry" type="Rect" overloaded="no">
- <autodoc>GetGeometry() -> Rect</autodoc>
- <docstring>Returns the bounding rectangle of the display whose index was
-passed to the constructor.</docstring>
+ <autodoc>GetGeometry(self) -> Rect</autodoc>
+ <docstring>Returns the bounding rectangle of the display whose index was passed
+to the constructor.</docstring>
</method>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
+ <autodoc>GetName(self) -> String</autodoc>
<docstring>Returns the display's name. A name is not available on all platforms.</docstring>
</method>
<method name="IsPrimary" type="bool" overloaded="no">
- <autodoc>IsPrimary() -> bool</autodoc>
+ <autodoc>IsPrimary(self) -> bool</autodoc>
<docstring>Returns true if the display is the primary display. The primary
display is the one whose index is 0.</docstring>
</method>
<method name="GetModes" type="PyObject" overloaded="no">
<autodoc>GetModes(VideoMode mode=DefaultVideoMode) -> [videoMode...]</autodoc>
- <docstring>Enumerate all video modes supported by this display matching the
-given one (in the sense of VideoMode.Match()).
+ <docstring>Enumerate all video modes supported by this display matching the given
+one (in the sense of VideoMode.Match()).
-As any mode matches the default value of the argument and there
-is always at least one video mode supported by display, the
-returned array is only empty for the default value of the
-argument if this function is not supported at all on this
-platform.</docstring>
+As any mode matches the default value of the argument and there is
+always at least one video mode supported by display, the returned
+array is only empty for the default value of the argument if this
+function is not supported at all on this platform.</docstring>
<paramlist>
<param name="mode" type="VideoMode" default="wxDefaultVideoMode"/>
</paramlist>
</method>
<method name="GetCurrentMode" type="VideoMode" overloaded="no">
- <autodoc>GetCurrentMode() -> VideoMode</autodoc>
+ <autodoc>GetCurrentMode(self) -> VideoMode</autodoc>
<docstring>Get the current video mode.</docstring>
</method>
<method name="ChangeMode" type="bool" overloaded="no">
- <autodoc>ChangeMode(VideoMode mode=DefaultVideoMode) -> bool</autodoc>
+ <autodoc>ChangeMode(self, VideoMode mode=DefaultVideoMode) -> bool</autodoc>
<docstring>Change current mode, return true if succeeded, false otherwise</docstring>
<paramlist>
<param name="mode" type="VideoMode" default="wxDefaultVideoMode"/>
</paramlist>
</method>
<method name="ResetMode" type="" overloaded="no">
- <autodoc>ResetMode()</autodoc>
+ <autodoc>ResetMode(self)</autodoc>
<docstring>Restore the default video mode (just a more readable synonym)</docstring>
</method>
</class>
</module>
<module name="calendar">
- <import name="misc"/>
- <pythoncode> wx = core </pythoncode>
+ <import name="_misc"/>
+ <pythoncode> wx = _core </pythoncode>
+ <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode>
<class name="CalendarDateAttr" oldname="wxCalendarDateAttr" module="calendar">
- <docstring>A set of customization attributes for a calendar date, which can be used to
-control the look of the Calendar object.</docstring>
+ <docstring>A set of customization attributes for a calendar date, which can be
+used to control the look of the Calendar object.</docstring>
<constructor name="CalendarDateAttr" overloaded="no">
- <autodoc>__init__(Colour colText=wxNullColour, Colour colBack=wxNullColour,
+ <autodoc>__init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour,
Colour colBorder=wxNullColour, Font font=wxNullFont,
int border=CAL_BORDER_NONE) -> CalendarDateAttr</autodoc>
<docstring>Create a CalendarDateAttr.</docstring>
</paramlist>
</constructor>
<method name="SetTextColour" type="" overloaded="no">
- <autodoc>SetTextColour(Colour colText)</autodoc>
+ <autodoc>SetTextColour(self, Colour colText)</autodoc>
<paramlist>
<param name="colText" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetBackgroundColour" type="" overloaded="no">
- <autodoc>SetBackgroundColour(Colour colBack)</autodoc>
+ <autodoc>SetBackgroundColour(self, Colour colBack)</autodoc>
<paramlist>
<param name="colBack" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetBorderColour" type="" overloaded="no">
- <autodoc>SetBorderColour(Colour col)</autodoc>
+ <autodoc>SetBorderColour(self, Colour col)</autodoc>
<paramlist>
<param name="col" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetFont" type="" overloaded="no">
- <autodoc>SetFont(Font font)</autodoc>
+ <autodoc>SetFont(self, Font font)</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="SetBorder" type="" overloaded="no">
- <autodoc>SetBorder(int border)</autodoc>
+ <autodoc>SetBorder(self, int border)</autodoc>
<paramlist>
<param name="border" type="wxCalendarDateBorder" default=""/>
</paramlist>
</method>
<method name="SetHoliday" type="" overloaded="no">
- <autodoc>SetHoliday(bool holiday)</autodoc>
+ <autodoc>SetHoliday(self, bool holiday)</autodoc>
<paramlist>
<param name="holiday" type="bool" default=""/>
</paramlist>
</method>
<method name="HasTextColour" type="bool" overloaded="no">
- <autodoc>HasTextColour() -> bool</autodoc>
+ <autodoc>HasTextColour(self) -> bool</autodoc>
</method>
<method name="HasBackgroundColour" type="bool" overloaded="no">
- <autodoc>HasBackgroundColour() -> bool</autodoc>
+ <autodoc>HasBackgroundColour(self) -> bool</autodoc>
</method>
<method name="HasBorderColour" type="bool" overloaded="no">
- <autodoc>HasBorderColour() -> bool</autodoc>
+ <autodoc>HasBorderColour(self) -> bool</autodoc>
</method>
<method name="HasFont" type="bool" overloaded="no">
- <autodoc>HasFont() -> bool</autodoc>
+ <autodoc>HasFont(self) -> bool</autodoc>
</method>
<method name="HasBorder" type="bool" overloaded="no">
- <autodoc>HasBorder() -> bool</autodoc>
+ <autodoc>HasBorder(self) -> bool</autodoc>
</method>
<method name="IsHoliday" type="bool" overloaded="no">
- <autodoc>IsHoliday() -> bool</autodoc>
+ <autodoc>IsHoliday(self) -> bool</autodoc>
</method>
<method name="GetTextColour" type="Colour" overloaded="no">
- <autodoc>GetTextColour() -> Colour</autodoc>
+ <autodoc>GetTextColour(self) -> Colour</autodoc>
</method>
<method name="GetBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetBackgroundColour() -> Colour</autodoc>
+ <autodoc>GetBackgroundColour(self) -> Colour</autodoc>
</method>
<method name="GetBorderColour" type="Colour" overloaded="no">
- <autodoc>GetBorderColour() -> Colour</autodoc>
+ <autodoc>GetBorderColour(self) -> Colour</autodoc>
</method>
<method name="GetFont" type="Font" overloaded="no">
- <autodoc>GetFont() -> Font</autodoc>
+ <autodoc>GetFont(self) -> Font</autodoc>
</method>
<method name="GetBorder" type="wxCalendarDateBorder" overloaded="no">
- <autodoc>GetBorder() -> int</autodoc>
+ <autodoc>GetBorder(self) -> int</autodoc>
</method>
</class>
<class name="CalendarEvent" oldname="wxCalendarEvent" module="calendar">
<baseclass name="CommandEvent"/>
<constructor name="CalendarEvent" overloaded="no">
- <autodoc>__init__(CalendarCtrl cal, wxEventType type) -> CalendarEvent</autodoc>
+ <autodoc>__init__(self, CalendarCtrl cal, wxEventType type) -> CalendarEvent</autodoc>
<paramlist>
<param name="cal" type="wxCalendarCtrl" default=""/>
<param name="type" type="wxEventType" default=""/>
</paramlist>
</constructor>
<method name="GetDate" type="DateTime" overloaded="no">
- <autodoc>GetDate() -> DateTime</autodoc>
+ <autodoc>GetDate(self) -> DateTime</autodoc>
</method>
<method name="SetDate" type="" overloaded="no">
- <autodoc>SetDate(DateTime date)</autodoc>
+ <autodoc>SetDate(self, DateTime date)</autodoc>
<paramlist>
<param name="date" type="DateTime" default=""/>
</paramlist>
</method>
<method name="SetWeekDay" type="" overloaded="no">
- <autodoc>SetWeekDay(int wd)</autodoc>
+ <autodoc>SetWeekDay(self, int wd)</autodoc>
<paramlist>
<param name="wd" type="wxDateTime::WeekDay" default=""/>
</paramlist>
</method>
<method name="GetWeekDay" type="wxDateTime::WeekDay" overloaded="no">
- <autodoc>GetWeekDay() -> int</autodoc>
+ <autodoc>GetWeekDay(self) -> int</autodoc>
</method>
</class>
<pythoncode>
EVT_CALENDAR_WEEKDAY_CLICKED = wx.PyEventBinder( wxEVT_CALENDAR_WEEKDAY_CLICKED, 1)
</pythoncode>
<class name="CalendarCtrl" oldname="wxCalendarCtrl" module="calendar">
- <docstring>The calendar control allows the user to pick a date interactively.</docstring>
- <refdoc>The CalendarCtrl displays a window containing several parts: the control to
-pick the month and the year at the top (either or both of them may be
-disabled) and a month area below them which shows all the days in the
-month. The user can move the current selection using the keyboard and select
-the date (generating EVT_CALENDAR event) by pressing <Return> or double
-clicking it.
-
-It has advanced possibilities for the customization of its display. All global
-settings (such as colours and fonts used) can, of course, be changed. But
-also, the display style for each day in the month can be set independently
-using CalendarDateAttr class.
-
-An item without custom attributes is drawn with the default colours and font
-and without border, but setting custom attributes with SetAttr allows to
-modify its appearance. Just create a custom attribute object and set it for
-the day you want to be displayed specially A day may be marked as being a
-holiday, (even if it is not recognized as one by wx.DateTime) by using the
-SetHoliday method.
-
-As the attributes are specified for each day, they may change when the month
-is changed, so you will often want to update them in an EVT_CALENDAR_MONTH
-event handler.
-
- Styles
- CAL_SUNDAY_FIRST: Show Sunday as the first day in the week
- CAL_MONDAY_FIRST: Show Monday as the first day in the week
- CAL_SHOW_HOLIDAYS: Highlight holidays in the calendar
- CAL_NO_YEAR_CHANGE: Disable the year changing
- CAL_NO_MONTH_CHANGE: Disable the month (and, implicitly, the year) changing
- CAL_SHOW_SURROUNDING_WEEKS: Show the neighbouring weeks in the previous and next months
- CAL_SEQUENTIAL_MONTH_SELECTION: Use alternative, more compact, style for the month and year selection controls.
-
-The default calendar style is wxCAL_SHOW_HOLIDAYS.
-
- Events
- EVT_CALENDAR: A day was double clicked in the calendar.
- EVT_CALENDAR_SEL_CHANGED: The selected date changed.
- EVT_CALENDAR_DAY: The selected day changed.
- EVT_CALENDAR_MONTH: The selected month changed.
- EVT_CALENDAR_YEAR: The selected year changed.
- EVT_CALENDAR_WEEKDAY_CLICKED: User clicked on the week day header
-
-Note that changing the selected date will result in either of
-EVT_CALENDAR_DAY, MONTH or YEAR events and an EVT_CALENDAR_SEL_CHANGED event.
-
-</refdoc>
+ <docstring>The calendar control allows the user to pick a date interactively.
+
+The CalendarCtrl displays a window containing several parts: the
+control to pick the month and the year at the top (either or both of
+them may be disabled) and a month area below them which shows all the
+days in the month. The user can move the current selection using the
+keyboard and select the date (generating EVT_CALENDAR event) by
+pressing <Return> or double clicking it.
+
+It has advanced possibilities for the customization of its
+display. All global settings (such as colours and fonts used) can, of
+course, be changed. But also, the display style for each day in the
+month can be set independently using CalendarDateAttr class.
+
+An item without custom attributes is drawn with the default colours
+and font and without border, but setting custom attributes with
+SetAttr allows to modify its appearance. Just create a custom
+attribute object and set it for the day you want to be displayed
+specially A day may be marked as being a holiday, (even if it is not
+recognized as one by wx.DateTime) by using the SetHoliday method.
+
+As the attributes are specified for each day, they may change when the
+month is changed, so you will often want to update them in an
+EVT_CALENDAR_MONTH event handler.</docstring>
<baseclass name="Control"/>
<constructor name="CalendarCtrl" overloaded="no">
- <autodoc>__init__(Window parent, int id, DateTime date=DefaultDateTime,
+ <autodoc>__init__(self, Window parent, int id=-1, DateTime date=DefaultDateTime,
Point pos=DefaultPosition, Size size=DefaultSize,
long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS,
String name=CalendarNameStr) -> CalendarCtrl</autodoc>
<docstring>Create and show a calendar control.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="date" type="DateTime" default="wxDefaultDateTime"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<docstring>Precreate a CalendarCtrl for 2-phase creation.</docstring>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, DateTime date=DefaultDateTime,
+ <autodoc>Create(self, Window parent, int id, DateTime date=DefaultDateTime,
Point pos=DefaultPosition, Size size=DefaultSize,
long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS,
String name=CalendarNameStr) -> bool</autodoc>
- <docstring>Acutally create the GUI portion of the CalendarCtrl for 2-phase creation.</docstring>
+ <docstring>Acutally create the GUI portion of the CalendarCtrl for 2-phase
+creation.</docstring>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="SetDate" type="" overloaded="no">
- <autodoc>SetDate(DateTime date)</autodoc>
+ <autodoc>SetDate(self, DateTime date)</autodoc>
<docstring>Sets the current date.</docstring>
<paramlist>
<param name="date" type="DateTime" default=""/>
</paramlist>
</method>
<method name="GetDate" type="DateTime" overloaded="no">
- <autodoc>GetDate() -> DateTime</autodoc>
+ <autodoc>GetDate(self) -> DateTime</autodoc>
<docstring>Gets the currently selected date.</docstring>
</method>
<method name="SetLowerDateLimit" type="bool" overloaded="no">
- <autodoc>SetLowerDateLimit(DateTime date=DefaultDateTime) -> bool</autodoc>
+ <autodoc>SetLowerDateLimit(self, DateTime date=DefaultDateTime) -> bool</autodoc>
<docstring>set the range in which selection can occur</docstring>
<paramlist>
<param name="date" type="DateTime" default="wxDefaultDateTime"/>
</paramlist>
</method>
<method name="SetUpperDateLimit" type="bool" overloaded="no">
- <autodoc>SetUpperDateLimit(DateTime date=DefaultDateTime) -> bool</autodoc>
+ <autodoc>SetUpperDateLimit(self, DateTime date=DefaultDateTime) -> bool</autodoc>
<docstring>set the range in which selection can occur</docstring>
<paramlist>
<param name="date" type="DateTime" default="wxDefaultDateTime"/>
</paramlist>
</method>
<method name="GetLowerDateLimit" type="DateTime" overloaded="no">
- <autodoc>GetLowerDateLimit() -> DateTime</autodoc>
+ <autodoc>GetLowerDateLimit(self) -> DateTime</autodoc>
<docstring>get the range in which selection can occur</docstring>
</method>
<method name="GetUpperDateLimit" type="DateTime" overloaded="no">
- <autodoc>GetUpperDateLimit() -> DateTime</autodoc>
+ <autodoc>GetUpperDateLimit(self) -> DateTime</autodoc>
<docstring>get the range in which selection can occur</docstring>
</method>
<method name="SetDateRange" type="bool" overloaded="no">
- <autodoc>SetDateRange(DateTime lowerdate=DefaultDateTime, DateTime upperdate=DefaultDateTime) -> bool</autodoc>
+ <autodoc>SetDateRange(self, DateTime lowerdate=DefaultDateTime, DateTime upperdate=DefaultDateTime) -> bool</autodoc>
<docstring>set the range in which selection can occur</docstring>
<paramlist>
<param name="lowerdate" type="DateTime" default="wxDefaultDateTime"/>
</paramlist>
</method>
<method name="EnableYearChange" type="" overloaded="no">
- <autodoc>EnableYearChange(bool enable=True)</autodoc>
+ <autodoc>EnableYearChange(self, bool enable=True)</autodoc>
<docstring>This function should be used instead of changing CAL_NO_YEAR_CHANGE
style bit directly. It allows or disallows the user to change the year
interactively.</docstring>
</paramlist>
</method>
<method name="EnableMonthChange" type="" overloaded="no">
- <autodoc>EnableMonthChange(bool enable=True)</autodoc>
- <docstring>This function should be used instead of changing CAL_NO_MONTH_CHANGE style
-bit. It allows or disallows the user to change the month interactively. Note
-that if the month can not be changed, the year can not be changed either.</docstring>
+ <autodoc>EnableMonthChange(self, bool enable=True)</autodoc>
+ <docstring>This function should be used instead of changing CAL_NO_MONTH_CHANGE
+style bit. It allows or disallows the user to change the month
+interactively. Note that if the month can not be changed, the year can
+not be changed either.</docstring>
<paramlist>
<param name="enable" type="bool" default="True"/>
</paramlist>
</method>
<method name="EnableHolidayDisplay" type="" overloaded="no">
- <autodoc>EnableHolidayDisplay(bool display=True)</autodoc>
- <docstring>This function should be used instead of changing CAL_SHOW_HOLIDAYS style
-bit directly. It enables or disables the special highlighting of the holidays.</docstring>
+ <autodoc>EnableHolidayDisplay(self, bool display=True)</autodoc>
+ <docstring>This function should be used instead of changing CAL_SHOW_HOLIDAYS
+style bit directly. It enables or disables the special highlighting of
+the holidays.</docstring>
<paramlist>
<param name="display" type="bool" default="True"/>
</paramlist>
</method>
<method name="SetHeaderColours" type="" overloaded="no">
- <autodoc>SetHeaderColours(Colour colFg, Colour colBg)</autodoc>
- <docstring>header colours are used for painting the weekdays at the top</docstring>
+ <autodoc>SetHeaderColours(self, Colour colFg, Colour colBg)</autodoc>
+ <docstring>Header colours are used for painting the weekdays at the top.</docstring>
<paramlist>
<param name="colFg" type="Colour" default=""/>
<param name="colBg" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetHeaderColourFg" type="Colour" overloaded="no">
- <autodoc>GetHeaderColourFg() -> Colour</autodoc>
- <docstring>header colours are used for painting the weekdays at the top</docstring>
+ <autodoc>GetHeaderColourFg(self) -> Colour</autodoc>
+ <docstring>Header colours are used for painting the weekdays at the top.</docstring>
</method>
<method name="GetHeaderColourBg" type="Colour" overloaded="no">
- <autodoc>GetHeaderColourBg() -> Colour</autodoc>
- <docstring>header colours are used for painting the weekdays at the top</docstring>
+ <autodoc>GetHeaderColourBg(self) -> Colour</autodoc>
+ <docstring>Header colours are used for painting the weekdays at the top.</docstring>
</method>
<method name="SetHighlightColours" type="" overloaded="no">
- <autodoc>SetHighlightColours(Colour colFg, Colour colBg)</autodoc>
- <docstring>highlight colour is used for the currently selected date</docstring>
+ <autodoc>SetHighlightColours(self, Colour colFg, Colour colBg)</autodoc>
+ <docstring>Highlight colour is used for the currently selected date.</docstring>
<paramlist>
<param name="colFg" type="Colour" default=""/>
<param name="colBg" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetHighlightColourFg" type="Colour" overloaded="no">
- <autodoc>GetHighlightColourFg() -> Colour</autodoc>
- <docstring>highlight colour is used for the currently selected date</docstring>
+ <autodoc>GetHighlightColourFg(self) -> Colour</autodoc>
+ <docstring>Highlight colour is used for the currently selected date.</docstring>
</method>
<method name="GetHighlightColourBg" type="Colour" overloaded="no">
- <autodoc>GetHighlightColourBg() -> Colour</autodoc>
- <docstring>highlight colour is used for the currently selected date</docstring>
+ <autodoc>GetHighlightColourBg(self) -> Colour</autodoc>
+ <docstring>Highlight colour is used for the currently selected date.</docstring>
</method>
<method name="SetHolidayColours" type="" overloaded="no">
- <autodoc>SetHolidayColours(Colour colFg, Colour colBg)</autodoc>
- <docstring>holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)</docstring>
+ <autodoc>SetHolidayColours(self, Colour colFg, Colour colBg)</autodoc>
+ <docstring>Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
+used).</docstring>
<paramlist>
<param name="colFg" type="Colour" default=""/>
<param name="colBg" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetHolidayColourFg" type="Colour" overloaded="no">
- <autodoc>GetHolidayColourFg() -> Colour</autodoc>
- <docstring>holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)</docstring>
+ <autodoc>GetHolidayColourFg(self) -> Colour</autodoc>
+ <docstring>Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
+used).</docstring>
</method>
<method name="GetHolidayColourBg" type="Colour" overloaded="no">
- <autodoc>GetHolidayColourBg() -> Colour</autodoc>
- <docstring>holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used)</docstring>
+ <autodoc>GetHolidayColourBg(self) -> Colour</autodoc>
+ <docstring>Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
+used).</docstring>
</method>
<method name="GetAttr" type="CalendarDateAttr" overloaded="no">
- <autodoc>GetAttr(size_t day) -> CalendarDateAttr</autodoc>
- <docstring>Returns the attribute for the given date (should be in the range 1...31).
-The returned value may be None</docstring>
+ <autodoc>GetAttr(self, size_t day) -> CalendarDateAttr</autodoc>
+ <docstring>Returns the attribute for the given date (should be in the range
+1...31). The returned value may be None</docstring>
<paramlist>
<param name="day" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetAttr" type="" overloaded="no">
- <autodoc>SetAttr(size_t day, CalendarDateAttr attr)</autodoc>
- <docstring>Associates the attribute with the specified date (in the range 1...31).
-If the attribute passed is None, the items attribute is cleared.</docstring>
+ <autodoc>SetAttr(self, size_t day, CalendarDateAttr attr)</autodoc>
+ <docstring>Associates the attribute with the specified date (in the range
+1...31). If the attribute passed is None, the items attribute is
+cleared.</docstring>
<paramlist>
<param name="day" type="size_t" default=""/>
<param name="attr" type="CalendarDateAttr" default=""/>
</paramlist>
</method>
<method name="SetHoliday" type="" overloaded="no">
- <autodoc>SetHoliday(size_t day)</autodoc>
+ <autodoc>SetHoliday(self, size_t day)</autodoc>
<docstring>Marks the specified day as being a holiday in the current month.</docstring>
<paramlist>
<param name="day" type="size_t" default=""/>
</paramlist>
</method>
<method name="ResetAttr" type="" overloaded="no">
- <autodoc>ResetAttr(size_t day)</autodoc>
- <docstring>Clears any attributes associated with the given day (in the range 1...31).</docstring>
+ <autodoc>ResetAttr(self, size_t day)</autodoc>
+ <docstring>Clears any attributes associated with the given day (in the range
+1...31).</docstring>
<paramlist>
<param name="day" type="size_t" default=""/>
</paramlist>
</method>
<method name="HitTest" type="PyObject" overloaded="no">
<autodoc>HitTest(Point pos) -> (result, date, weekday)</autodoc>
- <docstring>Returns 3-tuple with information about the given position on the calendar
-control. The first value of the tuple is a result code and determines the
-validity of the remaining two values. The result codes are:
-
- CAL_HITTEST_NOWHERE: hit outside of anything
- CAL_HITTEST_HEADER: hit on the header, weekday is valid
- CAL_HITTEST_DAY: hit on a day in the calendar, date is set.
-</docstring>
+ <docstring>Returns 3-tuple with information about the given position on the
+calendar control. The first value of the tuple is a result code and
+determines the validity of the remaining two values.</docstring>
<paramlist>
<param name="pos" type="Point" default=""/>
</paramlist>
</method>
<method name="GetMonthControl" type="Control" overloaded="no">
- <autodoc>GetMonthControl() -> Control</autodoc>
- <docstring>get the currently shown control for month</docstring>
+ <autodoc>GetMonthControl(self) -> Control</autodoc>
+ <docstring>Get the currently shown control for month.</docstring>
</method>
<method name="GetYearControl" type="Control" overloaded="no">
- <autodoc>GetYearControl() -> Control</autodoc>
- <docstring>get the currently shown control for year</docstring>
+ <autodoc>GetYearControl(self) -> Control</autodoc>
+ <docstring>Get the currently shown control for year.</docstring>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
</module>
<module name="grid">
- <import name="windows"/>
- <pythoncode> wx = core </pythoncode>
+ <import name="_windows"/>
+ <pythoncode> wx = _core </pythoncode>
+ <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode>
<class name="GridCellRenderer" oldname="wxGridCellRenderer" module="grid">
<method name="_setOORInfo" type="" overloaded="no">
- <autodoc>_setOORInfo(PyObject _self)</autodoc>
+ <autodoc>_setOORInfo(self, PyObject _self)</autodoc>
<paramlist>
<param name="_self" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetParameters" type="" overloaded="no">
- <autodoc>SetParameters(String params)</autodoc>
+ <autodoc>SetParameters(self, String params)</autodoc>
<paramlist>
<param name="params" type="String" default=""/>
</paramlist>
</method>
<method name="IncRef" type="" overloaded="no">
- <autodoc>IncRef()</autodoc>
+ <autodoc>IncRef(self)</autodoc>
</method>
<method name="DecRef" type="" overloaded="no">
- <autodoc>DecRef()</autodoc>
+ <autodoc>DecRef(self)</autodoc>
</method>
<method name="Draw" type="" overloaded="no">
- <autodoc>Draw(Grid grid, GridCellAttr attr, DC dc, Rect rect, int row,
+ <autodoc>Draw(self, Grid grid, GridCellAttr attr, DC dc, Rect rect, int row,
int col, bool isSelected)</autodoc>
<paramlist>
<param name="grid" type="wxGrid" default=""/>
</paramlist>
</method>
<method name="GetBestSize" type="Size" overloaded="no">
- <autodoc>GetBestSize(Grid grid, GridCellAttr attr, DC dc, int row, int col) -> Size</autodoc>
+ <autodoc>GetBestSize(self, Grid grid, GridCellAttr attr, DC dc, int row, int col) -> Size</autodoc>
<paramlist>
<param name="grid" type="wxGrid" default=""/>
<param name="attr" type="wxGridCellAttr" default=""/>
</paramlist>
</method>
<method name="Clone" type="GridCellRenderer" overloaded="no">
- <autodoc>Clone() -> GridCellRenderer</autodoc>
+ <autodoc>Clone(self) -> GridCellRenderer</autodoc>
</method>
</class>
<class name="PyGridCellRenderer" oldname="wxPyGridCellRenderer" module="grid">
<baseclass name="GridCellRenderer"/>
<constructor name="PyGridCellRenderer" overloaded="no">
- <autodoc>__init__() -> PyGridCellRenderer</autodoc>
+ <autodoc>__init__(self) -> PyGridCellRenderer</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="base_SetParameters" type="" overloaded="no">
- <autodoc>base_SetParameters(String params)</autodoc>
+ <autodoc>base_SetParameters(self, String params)</autodoc>
<paramlist>
<param name="params" type="String" default=""/>
</paramlist>
<class name="GridCellStringRenderer" oldname="wxGridCellStringRenderer" module="grid">
<baseclass name="GridCellRenderer"/>
<constructor name="GridCellStringRenderer" overloaded="no">
- <autodoc>__init__() -> GridCellStringRenderer</autodoc>
+ <autodoc>__init__(self) -> GridCellStringRenderer</autodoc>
</constructor>
</class>
<class name="GridCellNumberRenderer" oldname="wxGridCellNumberRenderer" module="grid">
<baseclass name="GridCellStringRenderer"/>
<constructor name="GridCellNumberRenderer" overloaded="no">
- <autodoc>__init__() -> GridCellNumberRenderer</autodoc>
+ <autodoc>__init__(self) -> GridCellNumberRenderer</autodoc>
</constructor>
</class>
<class name="GridCellFloatRenderer" oldname="wxGridCellFloatRenderer" module="grid">
<baseclass name="GridCellStringRenderer"/>
<constructor name="GridCellFloatRenderer" overloaded="no">
- <autodoc>__init__(int width=-1, int precision=-1) -> GridCellFloatRenderer</autodoc>
+ <autodoc>__init__(self, int width=-1, int precision=-1) -> GridCellFloatRenderer</autodoc>
<paramlist>
<param name="width" type="int" default="-1"/>
<param name="precision" type="int" default="-1"/>
</paramlist>
</constructor>
<method name="GetWidth" type="int" overloaded="no">
- <autodoc>GetWidth() -> int</autodoc>
+ <autodoc>GetWidth(self) -> int</autodoc>
</method>
<method name="SetWidth" type="" overloaded="no">
- <autodoc>SetWidth(int width)</autodoc>
+ <autodoc>SetWidth(self, int width)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="GetPrecision" type="int" overloaded="no">
- <autodoc>GetPrecision() -> int</autodoc>
+ <autodoc>GetPrecision(self) -> int</autodoc>
</method>
<method name="SetPrecision" type="" overloaded="no">
- <autodoc>SetPrecision(int precision)</autodoc>
+ <autodoc>SetPrecision(self, int precision)</autodoc>
<paramlist>
<param name="precision" type="int" default=""/>
</paramlist>
<class name="GridCellBoolRenderer" oldname="wxGridCellBoolRenderer" module="grid">
<baseclass name="GridCellRenderer"/>
<constructor name="GridCellBoolRenderer" overloaded="no">
- <autodoc>__init__() -> GridCellBoolRenderer</autodoc>
+ <autodoc>__init__(self) -> GridCellBoolRenderer</autodoc>
</constructor>
</class>
<class name="GridCellDateTimeRenderer" oldname="wxGridCellDateTimeRenderer" module="grid">
<baseclass name="GridCellStringRenderer"/>
<constructor name="GridCellDateTimeRenderer" overloaded="no">
- <autodoc>__init__(String outformat=DateTimeFormatStr, String informat=DateTimeFormatStr) -> GridCellDateTimeRenderer</autodoc>
+ <autodoc>__init__(self, String outformat=DateTimeFormatStr, String informat=DateTimeFormatStr) -> GridCellDateTimeRenderer</autodoc>
<paramlist>
<param name="outformat" type="String" default="wxPyDateTimeFormatStr"/>
<param name="informat" type="String" default="wxPyDateTimeFormatStr"/>
<class name="GridCellEnumRenderer" oldname="wxGridCellEnumRenderer" module="grid">
<baseclass name="GridCellStringRenderer"/>
<constructor name="GridCellEnumRenderer" overloaded="no">
- <autodoc>__init__(String choices=EmptyString) -> GridCellEnumRenderer</autodoc>
+ <autodoc>__init__(self, String choices=EmptyString) -> GridCellEnumRenderer</autodoc>
<paramlist>
<param name="choices" type="String" default="wxPyEmptyString"/>
</paramlist>
<class name="GridCellAutoWrapStringRenderer" oldname="wxGridCellAutoWrapStringRenderer" module="grid">
<baseclass name="GridCellStringRenderer"/>
<constructor name="GridCellAutoWrapStringRenderer" overloaded="no">
- <autodoc>__init__() -> GridCellAutoWrapStringRenderer</autodoc>
+ <autodoc>__init__(self) -> GridCellAutoWrapStringRenderer</autodoc>
</constructor>
</class>
<class name="GridCellEditor" oldname="wxGridCellEditor" module="grid">
<method name="_setOORInfo" type="" overloaded="no">
- <autodoc>_setOORInfo(PyObject _self)</autodoc>
+ <autodoc>_setOORInfo(self, PyObject _self)</autodoc>
<paramlist>
<param name="_self" type="PyObject" default=""/>
</paramlist>
</method>
<method name="IsCreated" type="bool" overloaded="no">
- <autodoc>IsCreated() -> bool</autodoc>
+ <autodoc>IsCreated(self) -> bool</autodoc>
</method>
<method name="GetControl" type="Control" overloaded="no">
- <autodoc>GetControl() -> Control</autodoc>
+ <autodoc>GetControl(self) -> Control</autodoc>
</method>
<method name="SetControl" type="" overloaded="no">
- <autodoc>SetControl(Control control)</autodoc>
+ <autodoc>SetControl(self, Control control)</autodoc>
<paramlist>
<param name="control" type="Control" default=""/>
</paramlist>
</method>
<method name="GetCellAttr" type="wxGridCellAttr" overloaded="no">
- <autodoc>GetCellAttr() -> GridCellAttr</autodoc>
+ <autodoc>GetCellAttr(self) -> GridCellAttr</autodoc>
</method>
<method name="SetCellAttr" type="" overloaded="no">
- <autodoc>SetCellAttr(GridCellAttr attr)</autodoc>
+ <autodoc>SetCellAttr(self, GridCellAttr attr)</autodoc>
<paramlist>
<param name="attr" type="wxGridCellAttr" default=""/>
</paramlist>
</method>
<method name="SetParameters" type="" overloaded="no">
- <autodoc>SetParameters(String params)</autodoc>
+ <autodoc>SetParameters(self, String params)</autodoc>
<paramlist>
<param name="params" type="String" default=""/>
</paramlist>
</method>
<method name="IncRef" type="" overloaded="no">
- <autodoc>IncRef()</autodoc>
+ <autodoc>IncRef(self)</autodoc>
</method>
<method name="DecRef" type="" overloaded="no">
- <autodoc>DecRef()</autodoc>
+ <autodoc>DecRef(self)</autodoc>
</method>
<method name="Create" type="" overloaded="no">
- <autodoc>Create(Window parent, int id, EvtHandler evtHandler)</autodoc>
+ <autodoc>Create(self, Window parent, int id, EvtHandler evtHandler)</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="BeginEdit" type="" overloaded="no">
- <autodoc>BeginEdit(int row, int col, Grid grid)</autodoc>
+ <autodoc>BeginEdit(self, int row, int col, Grid grid)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="EndEdit" type="bool" overloaded="no">
- <autodoc>EndEdit(int row, int col, Grid grid) -> bool</autodoc>
+ <autodoc>EndEdit(self, int row, int col, Grid grid) -> bool</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="Reset" type="" overloaded="no">
- <autodoc>Reset()</autodoc>
+ <autodoc>Reset(self)</autodoc>
</method>
<method name="Clone" type="GridCellEditor" overloaded="no">
- <autodoc>Clone() -> GridCellEditor</autodoc>
+ <autodoc>Clone(self) -> GridCellEditor</autodoc>
</method>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(Rect rect)</autodoc>
+ <autodoc>SetSize(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="Show" type="" overloaded="no">
- <autodoc>Show(bool show, GridCellAttr attr=None)</autodoc>
+ <autodoc>Show(self, bool show, GridCellAttr attr=None)</autodoc>
<paramlist>
<param name="show" type="bool" default=""/>
<param name="attr" type="wxGridCellAttr" default="NULL"/>
</paramlist>
</method>
<method name="PaintBackground" type="" overloaded="no">
- <autodoc>PaintBackground(Rect rectCell, GridCellAttr attr)</autodoc>
+ <autodoc>PaintBackground(self, Rect rectCell, GridCellAttr attr)</autodoc>
<paramlist>
<param name="rectCell" type="Rect" default=""/>
<param name="attr" type="wxGridCellAttr" default=""/>
</paramlist>
</method>
<method name="IsAcceptedKey" type="bool" overloaded="no">
- <autodoc>IsAcceptedKey(KeyEvent event) -> bool</autodoc>
+ <autodoc>IsAcceptedKey(self, KeyEvent event) -> bool</autodoc>
<paramlist>
<param name="event" type="KeyEvent" default=""/>
</paramlist>
</method>
<method name="StartingKey" type="" overloaded="no">
- <autodoc>StartingKey(KeyEvent event)</autodoc>
+ <autodoc>StartingKey(self, KeyEvent event)</autodoc>
<paramlist>
<param name="event" type="KeyEvent" default=""/>
</paramlist>
</method>
<method name="StartingClick" type="" overloaded="no">
- <autodoc>StartingClick()</autodoc>
+ <autodoc>StartingClick(self)</autodoc>
</method>
<method name="HandleReturn" type="" overloaded="no">
- <autodoc>HandleReturn(KeyEvent event)</autodoc>
+ <autodoc>HandleReturn(self, KeyEvent event)</autodoc>
<paramlist>
<param name="event" type="KeyEvent" default=""/>
</paramlist>
</method>
<method name="Destroy" type="" overloaded="no">
- <autodoc>Destroy()</autodoc>
+ <autodoc>Destroy(self)</autodoc>
</method>
</class>
<class name="PyGridCellEditor" oldname="wxPyGridCellEditor" module="grid">
<baseclass name="GridCellEditor"/>
<constructor name="PyGridCellEditor" overloaded="no">
- <autodoc>__init__() -> PyGridCellEditor</autodoc>
+ <autodoc>__init__(self) -> PyGridCellEditor</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="base_SetSize" type="" overloaded="no">
- <autodoc>base_SetSize(Rect rect)</autodoc>
+ <autodoc>base_SetSize(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="base_Show" type="" overloaded="no">
- <autodoc>base_Show(bool show, GridCellAttr attr=None)</autodoc>
+ <autodoc>base_Show(self, bool show, GridCellAttr attr=None)</autodoc>
<paramlist>
<param name="show" type="bool" default=""/>
<param name="attr" type="wxGridCellAttr" default="NULL"/>
</paramlist>
</method>
<method name="base_PaintBackground" type="" overloaded="no">
- <autodoc>base_PaintBackground(Rect rectCell, GridCellAttr attr)</autodoc>
+ <autodoc>base_PaintBackground(self, Rect rectCell, GridCellAttr attr)</autodoc>
<paramlist>
<param name="rectCell" type="Rect" default=""/>
<param name="attr" type="wxGridCellAttr" default=""/>
</paramlist>
</method>
<method name="base_IsAcceptedKey" type="bool" overloaded="no">
- <autodoc>base_IsAcceptedKey(KeyEvent event) -> bool</autodoc>
+ <autodoc>base_IsAcceptedKey(self, KeyEvent event) -> bool</autodoc>
<paramlist>
<param name="event" type="KeyEvent" default=""/>
</paramlist>
</method>
<method name="base_StartingKey" type="" overloaded="no">
- <autodoc>base_StartingKey(KeyEvent event)</autodoc>
+ <autodoc>base_StartingKey(self, KeyEvent event)</autodoc>
<paramlist>
<param name="event" type="KeyEvent" default=""/>
</paramlist>
</method>
<method name="base_StartingClick" type="" overloaded="no">
- <autodoc>base_StartingClick()</autodoc>
+ <autodoc>base_StartingClick(self)</autodoc>
</method>
<method name="base_HandleReturn" type="" overloaded="no">
- <autodoc>base_HandleReturn(KeyEvent event)</autodoc>
+ <autodoc>base_HandleReturn(self, KeyEvent event)</autodoc>
<paramlist>
<param name="event" type="KeyEvent" default=""/>
</paramlist>
</method>
<method name="base_Destroy" type="" overloaded="no">
- <autodoc>base_Destroy()</autodoc>
+ <autodoc>base_Destroy(self)</autodoc>
</method>
<method name="base_SetParameters" type="" overloaded="no">
- <autodoc>base_SetParameters(String params)</autodoc>
+ <autodoc>base_SetParameters(self, String params)</autodoc>
<paramlist>
<param name="params" type="String" default=""/>
</paramlist>
<class name="GridCellTextEditor" oldname="wxGridCellTextEditor" module="grid">
<baseclass name="GridCellEditor"/>
<constructor name="GridCellTextEditor" overloaded="no">
- <autodoc>__init__() -> GridCellTextEditor</autodoc>
+ <autodoc>__init__(self) -> GridCellTextEditor</autodoc>
</constructor>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
</method>
</class>
<class name="GridCellNumberEditor" oldname="wxGridCellNumberEditor" module="grid">
<baseclass name="GridCellTextEditor"/>
<constructor name="GridCellNumberEditor" overloaded="no">
- <autodoc>__init__(int min=-1, int max=-1) -> GridCellNumberEditor</autodoc>
+ <autodoc>__init__(self, int min=-1, int max=-1) -> GridCellNumberEditor</autodoc>
<paramlist>
<param name="min" type="int" default="-1"/>
<param name="max" type="int" default="-1"/>
</paramlist>
</constructor>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
</method>
</class>
<class name="GridCellFloatEditor" oldname="wxGridCellFloatEditor" module="grid">
<baseclass name="GridCellTextEditor"/>
<constructor name="GridCellFloatEditor" overloaded="no">
- <autodoc>__init__() -> GridCellFloatEditor</autodoc>
+ <autodoc>__init__(self, int width=-1, int precision=-1) -> GridCellFloatEditor</autodoc>
+ <paramlist>
+ <param name="width" type="int" default="-1"/>
+ <param name="precision" type="int" default="-1"/>
+ </paramlist>
</constructor>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
</method>
</class>
<class name="GridCellBoolEditor" oldname="wxGridCellBoolEditor" module="grid">
<baseclass name="GridCellEditor"/>
<constructor name="GridCellBoolEditor" overloaded="no">
- <autodoc>__init__() -> GridCellBoolEditor</autodoc>
+ <autodoc>__init__(self) -> GridCellBoolEditor</autodoc>
</constructor>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
</method>
</class>
<class name="GridCellChoiceEditor" oldname="wxGridCellChoiceEditor" module="grid">
<baseclass name="GridCellEditor"/>
<constructor name="GridCellChoiceEditor" overloaded="no">
- <autodoc>__init__(int choices=0, String choices_array=None, bool allowOthers=False) -> GridCellChoiceEditor</autodoc>
+ <autodoc>__init__(self, int choices=0, String choices_array=None, bool allowOthers=False) -> GridCellChoiceEditor</autodoc>
<paramlist>
<param name="choices" type="int" default="0"/>
<param name="choices_array" type="String" default="NULL"/>
</paramlist>
</constructor>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
</method>
</class>
<class name="GridCellEnumEditor" oldname="wxGridCellEnumEditor" module="grid">
<baseclass name="GridCellChoiceEditor"/>
<constructor name="GridCellEnumEditor" overloaded="no">
- <autodoc>__init__(String choices=EmptyString) -> GridCellEnumEditor</autodoc>
+ <autodoc>__init__(self, String choices=EmptyString) -> GridCellEnumEditor</autodoc>
<paramlist>
<param name="choices" type="String" default="wxPyEmptyString"/>
</paramlist>
</constructor>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
</method>
</class>
<class name="GridCellAutoWrapStringEditor" oldname="wxGridCellAutoWrapStringEditor" module="grid">
<baseclass name="GridCellTextEditor"/>
<constructor name="GridCellAutoWrapStringEditor" overloaded="no">
- <autodoc>__init__() -> GridCellAutoWrapStringEditor</autodoc>
+ <autodoc>__init__(self) -> GridCellAutoWrapStringEditor</autodoc>
</constructor>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
</method>
</class>
<class name="GridCellAttr" oldname="wxGridCellAttr" module="grid">
<constructor name="GridCellAttr" overloaded="no">
- <autodoc>__init__(GridCellAttr attrDefault=None) -> GridCellAttr</autodoc>
+ <autodoc>__init__(self, GridCellAttr attrDefault=None) -> GridCellAttr</autodoc>
<paramlist>
<param name="attrDefault" type="GridCellAttr" default="NULL"/>
</paramlist>
</constructor>
<method name="_setOORInfo" type="" overloaded="no">
- <autodoc>_setOORInfo(PyObject _self)</autodoc>
+ <autodoc>_setOORInfo(self, PyObject _self)</autodoc>
<paramlist>
<param name="_self" type="PyObject" default=""/>
</paramlist>
</method>
<method name="Clone" type="GridCellAttr" overloaded="no">
- <autodoc>Clone() -> GridCellAttr</autodoc>
+ <autodoc>Clone(self) -> GridCellAttr</autodoc>
</method>
<method name="MergeWith" type="" overloaded="no">
- <autodoc>MergeWith(GridCellAttr mergefrom)</autodoc>
+ <autodoc>MergeWith(self, GridCellAttr mergefrom)</autodoc>
<paramlist>
<param name="mergefrom" type="GridCellAttr" default=""/>
</paramlist>
</method>
<method name="IncRef" type="" overloaded="no">
- <autodoc>IncRef()</autodoc>
+ <autodoc>IncRef(self)</autodoc>
</method>
<method name="DecRef" type="" overloaded="no">
- <autodoc>DecRef()</autodoc>
+ <autodoc>DecRef(self)</autodoc>
</method>
<method name="SetTextColour" type="" overloaded="no">
- <autodoc>SetTextColour(Colour colText)</autodoc>
+ <autodoc>SetTextColour(self, Colour colText)</autodoc>
<paramlist>
<param name="colText" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetBackgroundColour" type="" overloaded="no">
- <autodoc>SetBackgroundColour(Colour colBack)</autodoc>
+ <autodoc>SetBackgroundColour(self, Colour colBack)</autodoc>
<paramlist>
<param name="colBack" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetFont" type="" overloaded="no">
- <autodoc>SetFont(Font font)</autodoc>
+ <autodoc>SetFont(self, Font font)</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="SetAlignment" type="" overloaded="no">
- <autodoc>SetAlignment(int hAlign, int vAlign)</autodoc>
+ <autodoc>SetAlignment(self, int hAlign, int vAlign)</autodoc>
<paramlist>
<param name="hAlign" type="int" default=""/>
<param name="vAlign" type="int" default=""/>
</paramlist>
</method>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(int num_rows, int num_cols)</autodoc>
+ <autodoc>SetSize(self, int num_rows, int num_cols)</autodoc>
<paramlist>
<param name="num_rows" type="int" default=""/>
<param name="num_cols" type="int" default=""/>
</paramlist>
</method>
<method name="SetOverflow" type="" overloaded="no">
- <autodoc>SetOverflow(bool allow=True)</autodoc>
+ <autodoc>SetOverflow(self, bool allow=True)</autodoc>
<paramlist>
<param name="allow" type="bool" default="True"/>
</paramlist>
</method>
<method name="SetReadOnly" type="" overloaded="no">
- <autodoc>SetReadOnly(bool isReadOnly=True)</autodoc>
+ <autodoc>SetReadOnly(self, bool isReadOnly=True)</autodoc>
<paramlist>
<param name="isReadOnly" type="bool" default="True"/>
</paramlist>
</method>
<method name="SetRenderer" type="" overloaded="no">
- <autodoc>SetRenderer(GridCellRenderer renderer)</autodoc>
+ <autodoc>SetRenderer(self, GridCellRenderer renderer)</autodoc>
<paramlist>
<param name="renderer" type="GridCellRenderer" default=""/>
</paramlist>
</method>
<method name="SetEditor" type="" overloaded="no">
- <autodoc>SetEditor(GridCellEditor editor)</autodoc>
+ <autodoc>SetEditor(self, GridCellEditor editor)</autodoc>
<paramlist>
<param name="editor" type="GridCellEditor" default=""/>
</paramlist>
</method>
<method name="SetKind" type="" overloaded="no">
- <autodoc>SetKind(int kind)</autodoc>
+ <autodoc>SetKind(self, int kind)</autodoc>
<paramlist>
<param name="kind" type="wxGridCellAttr::wxAttrKind" default=""/>
</paramlist>
</method>
<method name="HasTextColour" type="bool" overloaded="no">
- <autodoc>HasTextColour() -> bool</autodoc>
+ <autodoc>HasTextColour(self) -> bool</autodoc>
</method>
<method name="HasBackgroundColour" type="bool" overloaded="no">
- <autodoc>HasBackgroundColour() -> bool</autodoc>
+ <autodoc>HasBackgroundColour(self) -> bool</autodoc>
</method>
<method name="HasFont" type="bool" overloaded="no">
- <autodoc>HasFont() -> bool</autodoc>
+ <autodoc>HasFont(self) -> bool</autodoc>
</method>
<method name="HasAlignment" type="bool" overloaded="no">
- <autodoc>HasAlignment() -> bool</autodoc>
+ <autodoc>HasAlignment(self) -> bool</autodoc>
</method>
<method name="HasRenderer" type="bool" overloaded="no">
- <autodoc>HasRenderer() -> bool</autodoc>
+ <autodoc>HasRenderer(self) -> bool</autodoc>
</method>
<method name="HasEditor" type="bool" overloaded="no">
- <autodoc>HasEditor() -> bool</autodoc>
+ <autodoc>HasEditor(self) -> bool</autodoc>
</method>
<method name="HasReadWriteMode" type="bool" overloaded="no">
- <autodoc>HasReadWriteMode() -> bool</autodoc>
+ <autodoc>HasReadWriteMode(self) -> bool</autodoc>
</method>
<method name="HasOverflowMode" type="bool" overloaded="no">
- <autodoc>HasOverflowMode() -> bool</autodoc>
+ <autodoc>HasOverflowMode(self) -> bool</autodoc>
</method>
<method name="GetTextColour" type="Colour" overloaded="no">
- <autodoc>GetTextColour() -> Colour</autodoc>
+ <autodoc>GetTextColour(self) -> Colour</autodoc>
</method>
<method name="GetBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetBackgroundColour() -> Colour</autodoc>
+ <autodoc>GetBackgroundColour(self) -> Colour</autodoc>
</method>
<method name="GetFont" type="Font" overloaded="no">
- <autodoc>GetFont() -> Font</autodoc>
+ <autodoc>GetFont(self) -> Font</autodoc>
</method>
<method name="GetAlignment" type="" overloaded="no">
<autodoc>GetAlignment() -> (hAlign, vAlign)</autodoc>
</paramlist>
</method>
<method name="GetOverflow" type="bool" overloaded="no">
- <autodoc>GetOverflow() -> bool</autodoc>
+ <autodoc>GetOverflow(self) -> bool</autodoc>
</method>
<method name="GetRenderer" type="GridCellRenderer" overloaded="no">
- <autodoc>GetRenderer(Grid grid, int row, int col) -> GridCellRenderer</autodoc>
+ <autodoc>GetRenderer(self, Grid grid, int row, int col) -> GridCellRenderer</autodoc>
<paramlist>
<param name="grid" type="wxGrid" default=""/>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="GetEditor" type="GridCellEditor" overloaded="no">
- <autodoc>GetEditor(Grid grid, int row, int col) -> GridCellEditor</autodoc>
+ <autodoc>GetEditor(self, Grid grid, int row, int col) -> GridCellEditor</autodoc>
<paramlist>
<param name="grid" type="wxGrid" default=""/>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="IsReadOnly" type="bool" overloaded="no">
- <autodoc>IsReadOnly() -> bool</autodoc>
+ <autodoc>IsReadOnly(self) -> bool</autodoc>
</method>
<method name="SetDefAttr" type="" overloaded="no">
- <autodoc>SetDefAttr(GridCellAttr defAttr)</autodoc>
+ <autodoc>SetDefAttr(self, GridCellAttr defAttr)</autodoc>
<paramlist>
<param name="defAttr" type="GridCellAttr" default=""/>
</paramlist>
</class>
<class name="GridCellAttrProvider" oldname="wxGridCellAttrProvider" module="grid">
<constructor name="GridCellAttrProvider" overloaded="no">
- <autodoc>__init__() -> GridCellAttrProvider</autodoc>
+ <autodoc>__init__(self) -> GridCellAttrProvider</autodoc>
</constructor>
<method name="_setOORInfo" type="" overloaded="no">
- <autodoc>_setOORInfo(PyObject _self)</autodoc>
+ <autodoc>_setOORInfo(self, PyObject _self)</autodoc>
<paramlist>
<param name="_self" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetAttr" type="GridCellAttr" overloaded="no">
- <autodoc>GetAttr(int row, int col, int kind) -> GridCellAttr</autodoc>
+ <autodoc>GetAttr(self, int row, int col, int kind) -> GridCellAttr</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetAttr" type="" overloaded="no">
- <autodoc>SetAttr(GridCellAttr attr, int row, int col)</autodoc>
+ <autodoc>SetAttr(self, GridCellAttr attr, int row, int col)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="SetRowAttr" type="" overloaded="no">
- <autodoc>SetRowAttr(GridCellAttr attr, int row)</autodoc>
+ <autodoc>SetRowAttr(self, GridCellAttr attr, int row)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="SetColAttr" type="" overloaded="no">
- <autodoc>SetColAttr(GridCellAttr attr, int col)</autodoc>
+ <autodoc>SetColAttr(self, GridCellAttr attr, int col)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="UpdateAttrRows" type="" overloaded="no">
- <autodoc>UpdateAttrRows(size_t pos, int numRows)</autodoc>
+ <autodoc>UpdateAttrRows(self, size_t pos, int numRows)</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="numRows" type="int" default=""/>
</paramlist>
</method>
<method name="UpdateAttrCols" type="" overloaded="no">
- <autodoc>UpdateAttrCols(size_t pos, int numCols)</autodoc>
+ <autodoc>UpdateAttrCols(self, size_t pos, int numCols)</autodoc>
<paramlist>
<param name="pos" type="size_t" default=""/>
<param name="numCols" type="int" default=""/>
<class name="PyGridCellAttrProvider" oldname="wxPyGridCellAttrProvider" module="grid">
<baseclass name="GridCellAttrProvider"/>
<constructor name="PyGridCellAttrProvider" overloaded="no">
- <autodoc>__init__() -> PyGridCellAttrProvider</autodoc>
+ <autodoc>__init__(self) -> PyGridCellAttrProvider</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="base_GetAttr" type="GridCellAttr" overloaded="no">
- <autodoc>base_GetAttr(int row, int col, int kind) -> GridCellAttr</autodoc>
+ <autodoc>base_GetAttr(self, int row, int col, int kind) -> GridCellAttr</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="base_SetAttr" type="" overloaded="no">
- <autodoc>base_SetAttr(GridCellAttr attr, int row, int col)</autodoc>
+ <autodoc>base_SetAttr(self, GridCellAttr attr, int row, int col)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="base_SetRowAttr" type="" overloaded="no">
- <autodoc>base_SetRowAttr(GridCellAttr attr, int row)</autodoc>
+ <autodoc>base_SetRowAttr(self, GridCellAttr attr, int row)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="base_SetColAttr" type="" overloaded="no">
- <autodoc>base_SetColAttr(GridCellAttr attr, int col)</autodoc>
+ <autodoc>base_SetColAttr(self, GridCellAttr attr, int col)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="col" type="int" default=""/>
<class name="GridTableBase" oldname="wxGridTableBase" module="grid">
<baseclass name="Object"/>
<method name="_setOORInfo" type="" overloaded="no">
- <autodoc>_setOORInfo(PyObject _self)</autodoc>
+ <autodoc>_setOORInfo(self, PyObject _self)</autodoc>
<paramlist>
<param name="_self" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetAttrProvider" type="" overloaded="no">
- <autodoc>SetAttrProvider(GridCellAttrProvider attrProvider)</autodoc>
+ <autodoc>SetAttrProvider(self, GridCellAttrProvider attrProvider)</autodoc>
<paramlist>
<param name="attrProvider" type="GridCellAttrProvider" default=""/>
</paramlist>
</method>
<method name="GetAttrProvider" type="GridCellAttrProvider" overloaded="no">
- <autodoc>GetAttrProvider() -> GridCellAttrProvider</autodoc>
+ <autodoc>GetAttrProvider(self) -> GridCellAttrProvider</autodoc>
</method>
<method name="SetView" type="" overloaded="no">
- <autodoc>SetView(Grid grid)</autodoc>
+ <autodoc>SetView(self, Grid grid)</autodoc>
<paramlist>
<param name="grid" type="wxGrid" default=""/>
</paramlist>
</method>
<method name="GetView" type="wxGrid" overloaded="no">
- <autodoc>GetView() -> Grid</autodoc>
+ <autodoc>GetView(self) -> Grid</autodoc>
</method>
<method name="GetNumberRows" type="int" overloaded="no">
- <autodoc>GetNumberRows() -> int</autodoc>
+ <autodoc>GetNumberRows(self) -> int</autodoc>
</method>
<method name="GetNumberCols" type="int" overloaded="no">
- <autodoc>GetNumberCols() -> int</autodoc>
+ <autodoc>GetNumberCols(self) -> int</autodoc>
</method>
<method name="IsEmptyCell" type="bool" overloaded="no">
- <autodoc>IsEmptyCell(int row, int col) -> bool</autodoc>
+ <autodoc>IsEmptyCell(self, int row, int col) -> bool</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue(int row, int col) -> String</autodoc>
+ <autodoc>GetValue(self, int row, int col) -> String</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(int row, int col, String value)</autodoc>
+ <autodoc>SetValue(self, int row, int col, String value)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetTypeName" type="String" overloaded="no">
- <autodoc>GetTypeName(int row, int col) -> String</autodoc>
+ <autodoc>GetTypeName(self, int row, int col) -> String</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="CanGetValueAs" type="bool" overloaded="no">
- <autodoc>CanGetValueAs(int row, int col, String typeName) -> bool</autodoc>
+ <autodoc>CanGetValueAs(self, int row, int col, String typeName) -> bool</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="CanSetValueAs" type="bool" overloaded="no">
- <autodoc>CanSetValueAs(int row, int col, String typeName) -> bool</autodoc>
+ <autodoc>CanSetValueAs(self, int row, int col, String typeName) -> bool</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetValueAsLong" type="long" overloaded="no">
- <autodoc>GetValueAsLong(int row, int col) -> long</autodoc>
+ <autodoc>GetValueAsLong(self, int row, int col) -> long</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetValueAsDouble" type="double" overloaded="no">
- <autodoc>GetValueAsDouble(int row, int col) -> double</autodoc>
+ <autodoc>GetValueAsDouble(self, int row, int col) -> double</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetValueAsBool" type="bool" overloaded="no">
- <autodoc>GetValueAsBool(int row, int col) -> bool</autodoc>
+ <autodoc>GetValueAsBool(self, int row, int col) -> bool</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetValueAsLong" type="" overloaded="no">
- <autodoc>SetValueAsLong(int row, int col, long value)</autodoc>
+ <autodoc>SetValueAsLong(self, int row, int col, long value)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetValueAsDouble" type="" overloaded="no">
- <autodoc>SetValueAsDouble(int row, int col, double value)</autodoc>
+ <autodoc>SetValueAsDouble(self, int row, int col, double value)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetValueAsBool" type="" overloaded="no">
- <autodoc>SetValueAsBool(int row, int col, bool value)</autodoc>
+ <autodoc>SetValueAsBool(self, int row, int col, bool value)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear()</autodoc>
+ <autodoc>Clear(self)</autodoc>
</method>
<method name="InsertRows" type="bool" overloaded="no">
- <autodoc>InsertRows(size_t pos=0, size_t numRows=1) -> bool</autodoc>
+ <autodoc>InsertRows(self, size_t pos=0, size_t numRows=1) -> bool</autodoc>
<paramlist>
<param name="pos" type="size_t" default="0"/>
<param name="numRows" type="size_t" default="1"/>
</paramlist>
</method>
<method name="AppendRows" type="bool" overloaded="no">
- <autodoc>AppendRows(size_t numRows=1) -> bool</autodoc>
+ <autodoc>AppendRows(self, size_t numRows=1) -> bool</autodoc>
<paramlist>
<param name="numRows" type="size_t" default="1"/>
</paramlist>
</method>
<method name="DeleteRows" type="bool" overloaded="no">
- <autodoc>DeleteRows(size_t pos=0, size_t numRows=1) -> bool</autodoc>
+ <autodoc>DeleteRows(self, size_t pos=0, size_t numRows=1) -> bool</autodoc>
<paramlist>
<param name="pos" type="size_t" default="0"/>
<param name="numRows" type="size_t" default="1"/>
</paramlist>
</method>
<method name="InsertCols" type="bool" overloaded="no">
- <autodoc>InsertCols(size_t pos=0, size_t numCols=1) -> bool</autodoc>
+ <autodoc>InsertCols(self, size_t pos=0, size_t numCols=1) -> bool</autodoc>
<paramlist>
<param name="pos" type="size_t" default="0"/>
<param name="numCols" type="size_t" default="1"/>
</paramlist>
</method>
<method name="AppendCols" type="bool" overloaded="no">
- <autodoc>AppendCols(size_t numCols=1) -> bool</autodoc>
+ <autodoc>AppendCols(self, size_t numCols=1) -> bool</autodoc>
<paramlist>
<param name="numCols" type="size_t" default="1"/>
</paramlist>
</method>
<method name="DeleteCols" type="bool" overloaded="no">
- <autodoc>DeleteCols(size_t pos=0, size_t numCols=1) -> bool</autodoc>
+ <autodoc>DeleteCols(self, size_t pos=0, size_t numCols=1) -> bool</autodoc>
<paramlist>
<param name="pos" type="size_t" default="0"/>
<param name="numCols" type="size_t" default="1"/>
</paramlist>
</method>
<method name="GetRowLabelValue" type="String" overloaded="no">
- <autodoc>GetRowLabelValue(int row) -> String</autodoc>
+ <autodoc>GetRowLabelValue(self, int row) -> String</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="GetColLabelValue" type="String" overloaded="no">
- <autodoc>GetColLabelValue(int col) -> String</autodoc>
+ <autodoc>GetColLabelValue(self, int col) -> String</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetRowLabelValue" type="" overloaded="no">
- <autodoc>SetRowLabelValue(int row, String value)</autodoc>
+ <autodoc>SetRowLabelValue(self, int row, String value)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="value" type="String" default=""/>
</paramlist>
</method>
<method name="SetColLabelValue" type="" overloaded="no">
- <autodoc>SetColLabelValue(int col, String value)</autodoc>
+ <autodoc>SetColLabelValue(self, int col, String value)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="value" type="String" default=""/>
</paramlist>
</method>
<method name="CanHaveAttributes" type="bool" overloaded="no">
- <autodoc>CanHaveAttributes() -> bool</autodoc>
+ <autodoc>CanHaveAttributes(self) -> bool</autodoc>
</method>
<method name="GetAttr" type="GridCellAttr" overloaded="no">
- <autodoc>GetAttr(int row, int col, int kind) -> GridCellAttr</autodoc>
+ <autodoc>GetAttr(self, int row, int col, int kind) -> GridCellAttr</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetAttr" type="" overloaded="no">
- <autodoc>SetAttr(GridCellAttr attr, int row, int col)</autodoc>
+ <autodoc>SetAttr(self, GridCellAttr attr, int row, int col)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="SetRowAttr" type="" overloaded="no">
- <autodoc>SetRowAttr(GridCellAttr attr, int row)</autodoc>
+ <autodoc>SetRowAttr(self, GridCellAttr attr, int row)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="SetColAttr" type="" overloaded="no">
- <autodoc>SetColAttr(GridCellAttr attr, int col)</autodoc>
+ <autodoc>SetColAttr(self, GridCellAttr attr, int col)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="col" type="int" default=""/>
<class name="PyGridTableBase" oldname="wxPyGridTableBase" module="grid">
<baseclass name="GridTableBase"/>
<constructor name="PyGridTableBase" overloaded="no">
- <autodoc>__init__() -> PyGridTableBase</autodoc>
+ <autodoc>__init__(self) -> PyGridTableBase</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="Destroy" type="" overloaded="no">
- <autodoc>Destroy()</autodoc>
+ <autodoc>Destroy(self)</autodoc>
<docstring>Deletes the C++ object this Python object is a proxy for.</docstring>
</method>
<method name="base_GetTypeName" type="String" overloaded="no">
- <autodoc>base_GetTypeName(int row, int col) -> String</autodoc>
+ <autodoc>base_GetTypeName(self, int row, int col) -> String</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="base_CanGetValueAs" type="bool" overloaded="no">
- <autodoc>base_CanGetValueAs(int row, int col, String typeName) -> bool</autodoc>
+ <autodoc>base_CanGetValueAs(self, int row, int col, String typeName) -> bool</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="base_CanSetValueAs" type="bool" overloaded="no">
- <autodoc>base_CanSetValueAs(int row, int col, String typeName) -> bool</autodoc>
+ <autodoc>base_CanSetValueAs(self, int row, int col, String typeName) -> bool</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="base_Clear" type="" overloaded="no">
- <autodoc>base_Clear()</autodoc>
+ <autodoc>base_Clear(self)</autodoc>
</method>
<method name="base_InsertRows" type="bool" overloaded="no">
- <autodoc>base_InsertRows(size_t pos=0, size_t numRows=1) -> bool</autodoc>
+ <autodoc>base_InsertRows(self, size_t pos=0, size_t numRows=1) -> bool</autodoc>
<paramlist>
<param name="pos" type="size_t" default="0"/>
<param name="numRows" type="size_t" default="1"/>
</paramlist>
</method>
<method name="base_AppendRows" type="bool" overloaded="no">
- <autodoc>base_AppendRows(size_t numRows=1) -> bool</autodoc>
+ <autodoc>base_AppendRows(self, size_t numRows=1) -> bool</autodoc>
<paramlist>
<param name="numRows" type="size_t" default="1"/>
</paramlist>
</method>
<method name="base_DeleteRows" type="bool" overloaded="no">
- <autodoc>base_DeleteRows(size_t pos=0, size_t numRows=1) -> bool</autodoc>
+ <autodoc>base_DeleteRows(self, size_t pos=0, size_t numRows=1) -> bool</autodoc>
<paramlist>
<param name="pos" type="size_t" default="0"/>
<param name="numRows" type="size_t" default="1"/>
</paramlist>
</method>
<method name="base_InsertCols" type="bool" overloaded="no">
- <autodoc>base_InsertCols(size_t pos=0, size_t numCols=1) -> bool</autodoc>
+ <autodoc>base_InsertCols(self, size_t pos=0, size_t numCols=1) -> bool</autodoc>
<paramlist>
<param name="pos" type="size_t" default="0"/>
<param name="numCols" type="size_t" default="1"/>
</paramlist>
</method>
<method name="base_AppendCols" type="bool" overloaded="no">
- <autodoc>base_AppendCols(size_t numCols=1) -> bool</autodoc>
+ <autodoc>base_AppendCols(self, size_t numCols=1) -> bool</autodoc>
<paramlist>
<param name="numCols" type="size_t" default="1"/>
</paramlist>
</method>
<method name="base_DeleteCols" type="bool" overloaded="no">
- <autodoc>base_DeleteCols(size_t pos=0, size_t numCols=1) -> bool</autodoc>
+ <autodoc>base_DeleteCols(self, size_t pos=0, size_t numCols=1) -> bool</autodoc>
<paramlist>
<param name="pos" type="size_t" default="0"/>
<param name="numCols" type="size_t" default="1"/>
</paramlist>
</method>
<method name="base_GetRowLabelValue" type="String" overloaded="no">
- <autodoc>base_GetRowLabelValue(int row) -> String</autodoc>
+ <autodoc>base_GetRowLabelValue(self, int row) -> String</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="base_GetColLabelValue" type="String" overloaded="no">
- <autodoc>base_GetColLabelValue(int col) -> String</autodoc>
+ <autodoc>base_GetColLabelValue(self, int col) -> String</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="base_SetRowLabelValue" type="" overloaded="no">
- <autodoc>base_SetRowLabelValue(int row, String value)</autodoc>
+ <autodoc>base_SetRowLabelValue(self, int row, String value)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="value" type="String" default=""/>
</paramlist>
</method>
<method name="base_SetColLabelValue" type="" overloaded="no">
- <autodoc>base_SetColLabelValue(int col, String value)</autodoc>
+ <autodoc>base_SetColLabelValue(self, int col, String value)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="value" type="String" default=""/>
</paramlist>
</method>
<method name="base_CanHaveAttributes" type="bool" overloaded="no">
- <autodoc>base_CanHaveAttributes() -> bool</autodoc>
+ <autodoc>base_CanHaveAttributes(self) -> bool</autodoc>
</method>
<method name="base_GetAttr" type="GridCellAttr" overloaded="no">
- <autodoc>base_GetAttr(int row, int col, int kind) -> GridCellAttr</autodoc>
+ <autodoc>base_GetAttr(self, int row, int col, int kind) -> GridCellAttr</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="base_SetAttr" type="" overloaded="no">
- <autodoc>base_SetAttr(GridCellAttr attr, int row, int col)</autodoc>
+ <autodoc>base_SetAttr(self, GridCellAttr attr, int row, int col)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="base_SetRowAttr" type="" overloaded="no">
- <autodoc>base_SetRowAttr(GridCellAttr attr, int row)</autodoc>
+ <autodoc>base_SetRowAttr(self, GridCellAttr attr, int row)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="base_SetColAttr" type="" overloaded="no">
- <autodoc>base_SetColAttr(GridCellAttr attr, int col)</autodoc>
+ <autodoc>base_SetColAttr(self, GridCellAttr attr, int col)</autodoc>
<paramlist>
<param name="attr" type="GridCellAttr" default=""/>
<param name="col" type="int" default=""/>
<class name="GridStringTable" oldname="wxGridStringTable" module="grid">
<baseclass name="GridTableBase"/>
<constructor name="GridStringTable" overloaded="no">
- <autodoc>__init__(int numRows=0, int numCols=0) -> GridStringTable</autodoc>
+ <autodoc>__init__(self, int numRows=0, int numCols=0) -> GridStringTable</autodoc>
<paramlist>
<param name="numRows" type="int" default="0"/>
<param name="numCols" type="int" default="0"/>
</class>
<class name="GridTableMessage" oldname="wxGridTableMessage" module="grid">
<constructor name="GridTableMessage" overloaded="no">
- <autodoc>__init__(GridTableBase table, int id, int comInt1=-1, int comInt2=-1) -> GridTableMessage</autodoc>
+ <autodoc>__init__(self, GridTableBase table, int id, int comInt1=-1, int comInt2=-1) -> GridTableMessage</autodoc>
<paramlist>
<param name="table" type="GridTableBase" default=""/>
<param name="id" type="int" default=""/>
</paramlist>
</constructor>
<destructor name="~wxGridTableMessage" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetTableObject" type="" overloaded="no">
- <autodoc>SetTableObject(GridTableBase table)</autodoc>
+ <autodoc>SetTableObject(self, GridTableBase table)</autodoc>
<paramlist>
<param name="table" type="GridTableBase" default=""/>
</paramlist>
</method>
<method name="GetTableObject" type="GridTableBase" overloaded="no">
- <autodoc>GetTableObject() -> GridTableBase</autodoc>
+ <autodoc>GetTableObject(self) -> GridTableBase</autodoc>
</method>
<method name="SetId" type="" overloaded="no">
- <autodoc>SetId(int id)</autodoc>
+ <autodoc>SetId(self, int id)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="GetId" type="int" overloaded="no">
- <autodoc>GetId() -> int</autodoc>
+ <autodoc>GetId(self) -> int</autodoc>
</method>
<method name="SetCommandInt" type="" overloaded="no">
- <autodoc>SetCommandInt(int comInt1)</autodoc>
+ <autodoc>SetCommandInt(self, int comInt1)</autodoc>
<paramlist>
<param name="comInt1" type="int" default=""/>
</paramlist>
</method>
<method name="GetCommandInt" type="int" overloaded="no">
- <autodoc>GetCommandInt() -> int</autodoc>
+ <autodoc>GetCommandInt(self) -> int</autodoc>
</method>
<method name="SetCommandInt2" type="" overloaded="no">
- <autodoc>SetCommandInt2(int comInt2)</autodoc>
+ <autodoc>SetCommandInt2(self, int comInt2)</autodoc>
<paramlist>
<param name="comInt2" type="int" default=""/>
</paramlist>
</method>
<method name="GetCommandInt2" type="int" overloaded="no">
- <autodoc>GetCommandInt2() -> int</autodoc>
+ <autodoc>GetCommandInt2(self) -> int</autodoc>
</method>
</class>
<class name="GridCellCoords" oldname="wxGridCellCoords" module="grid">
<constructor name="GridCellCoords" overloaded="no">
- <autodoc>__init__(int r=-1, int c=-1) -> GridCellCoords</autodoc>
+ <autodoc>__init__(self, int r=-1, int c=-1) -> GridCellCoords</autodoc>
<paramlist>
<param name="r" type="int" default="-1"/>
<param name="c" type="int" default="-1"/>
</paramlist>
</constructor>
<destructor name="~wxGridCellCoords" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="GetRow" type="int" overloaded="no">
- <autodoc>GetRow() -> int</autodoc>
+ <autodoc>GetRow(self) -> int</autodoc>
</method>
<method name="SetRow" type="" overloaded="no">
- <autodoc>SetRow(int n)</autodoc>
+ <autodoc>SetRow(self, int n)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetCol" type="int" overloaded="no">
- <autodoc>GetCol() -> int</autodoc>
+ <autodoc>GetCol(self) -> int</autodoc>
</method>
<method name="SetCol" type="" overloaded="no">
- <autodoc>SetCol(int n)</autodoc>
+ <autodoc>SetCol(self, int n)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(int row, int col)</autodoc>
+ <autodoc>Set(self, int row, int col)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="__eq__" type="bool" overloaded="no">
- <autodoc>__eq__(GridCellCoords other) -> bool</autodoc>
+ <autodoc>__eq__(self, GridCellCoords other) -> bool</autodoc>
<paramlist>
<param name="other" type="GridCellCoords" default=""/>
</paramlist>
</method>
<method name="__ne__" type="bool" overloaded="no">
- <autodoc>__ne__(GridCellCoords other) -> bool</autodoc>
+ <autodoc>__ne__(self, GridCellCoords other) -> bool</autodoc>
<paramlist>
<param name="other" type="GridCellCoords" default=""/>
</paramlist>
</method>
- <method name="asTuple" type="PyObject" overloaded="no">
- <autodoc>asTuple() -> PyObject</autodoc>
+ <method name="Get" type="PyObject" overloaded="no">
+ <autodoc>Get(self) -> PyObject</autodoc>
</method>
</class>
<class name="Grid" oldname="wxGrid" module="grid">
<baseclass name="ScrolledWindow"/>
<constructor name="Grid" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=WANTS_CHARS,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=WANTS_CHARS,
String name=PanelNameStr) -> Grid</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxWANTS_CHARS"/>
<param name="name" type="String" default="wxPyPanelNameStr"/>
</paramlist>
</constructor>
+ <constructor name="PreGrid" overloaded="no">
+ <autodoc>PreGrid() -> Grid</autodoc>
+ </constructor>
+ <method name="Create" type="bool" overloaded="no">
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=WANTS_CHARS,
+ String name=PanelNameStr) -> bool</autodoc>
+ <paramlist>
+ <param name="parent" type="Window" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="pos" type="Point" default="wxDefaultPosition"/>
+ <param name="size" type="Size" default="wxDefaultSize"/>
+ <param name="style" type="long" default="wxWANTS_CHARS"/>
+ <param name="name" type="String" default="wxPyPanelNameStr"/>
+ </paramlist>
+ </method>
<method name="CreateGrid" type="bool" overloaded="no">
- <autodoc>CreateGrid(int numRows, int numCols, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool</autodoc>
+ <autodoc>CreateGrid(self, int numRows, int numCols, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool</autodoc>
<paramlist>
<param name="numRows" type="int" default=""/>
<param name="numCols" type="int" default=""/>
</paramlist>
</method>
<method name="SetSelectionMode" type="" overloaded="no">
- <autodoc>SetSelectionMode(WXGRIDSELECTIONMODES selmode)</autodoc>
+ <autodoc>SetSelectionMode(self, WXGRIDSELECTIONMODES selmode)</autodoc>
<paramlist>
<param name="selmode" type="WXGRIDSELECTIONMODES" default=""/>
</paramlist>
</method>
<method name="GetSelectionMode" type="WXGRIDSELECTIONMODES" overloaded="no">
- <autodoc>GetSelectionMode() -> WXGRIDSELECTIONMODES</autodoc>
+ <autodoc>GetSelectionMode(self) -> WXGRIDSELECTIONMODES</autodoc>
</method>
<method name="GetNumberRows" type="int" overloaded="no">
- <autodoc>GetNumberRows() -> int</autodoc>
+ <autodoc>GetNumberRows(self) -> int</autodoc>
</method>
<method name="GetNumberCols" type="int" overloaded="no">
- <autodoc>GetNumberCols() -> int</autodoc>
+ <autodoc>GetNumberCols(self) -> int</autodoc>
</method>
<method name="ProcessTableMessage" type="bool" overloaded="no">
- <autodoc>ProcessTableMessage(GridTableMessage ??) -> bool</autodoc>
+ <autodoc>ProcessTableMessage(self, GridTableMessage ??) -> bool</autodoc>
<paramlist>
<param name="" type="GridTableMessage" default=""/>
</paramlist>
</method>
<method name="GetTable" type="GridTableBase" overloaded="no">
- <autodoc>GetTable() -> GridTableBase</autodoc>
+ <autodoc>GetTable(self) -> GridTableBase</autodoc>
</method>
<method name="SetTable" type="bool" overloaded="no">
- <autodoc>SetTable(GridTableBase table, bool takeOwnership=False, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool</autodoc>
+ <autodoc>SetTable(self, GridTableBase table, bool takeOwnership=False, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool</autodoc>
<paramlist>
<param name="table" type="GridTableBase" default=""/>
<param name="takeOwnership" type="bool" default="False"/>
</paramlist>
</method>
<method name="ClearGrid" type="" overloaded="no">
- <autodoc>ClearGrid()</autodoc>
+ <autodoc>ClearGrid(self)</autodoc>
</method>
<method name="InsertRows" type="bool" overloaded="no">
- <autodoc>InsertRows(int pos=0, int numRows=1, bool updateLabels=True) -> bool</autodoc>
+ <autodoc>InsertRows(self, int pos=0, int numRows=1, bool updateLabels=True) -> bool</autodoc>
<paramlist>
<param name="pos" type="int" default="0"/>
<param name="numRows" type="int" default="1"/>
</paramlist>
</method>
<method name="AppendRows" type="bool" overloaded="no">
- <autodoc>AppendRows(int numRows=1, bool updateLabels=True) -> bool</autodoc>
+ <autodoc>AppendRows(self, int numRows=1, bool updateLabels=True) -> bool</autodoc>
<paramlist>
<param name="numRows" type="int" default="1"/>
<param name="updateLabels" type="bool" default="True"/>
</paramlist>
</method>
<method name="DeleteRows" type="bool" overloaded="no">
- <autodoc>DeleteRows(int pos=0, int numRows=1, bool updateLabels=True) -> bool</autodoc>
+ <autodoc>DeleteRows(self, int pos=0, int numRows=1, bool updateLabels=True) -> bool</autodoc>
<paramlist>
<param name="pos" type="int" default="0"/>
<param name="numRows" type="int" default="1"/>
</paramlist>
</method>
<method name="InsertCols" type="bool" overloaded="no">
- <autodoc>InsertCols(int pos=0, int numCols=1, bool updateLabels=True) -> bool</autodoc>
+ <autodoc>InsertCols(self, int pos=0, int numCols=1, bool updateLabels=True) -> bool</autodoc>
<paramlist>
<param name="pos" type="int" default="0"/>
<param name="numCols" type="int" default="1"/>
</paramlist>
</method>
<method name="AppendCols" type="bool" overloaded="no">
- <autodoc>AppendCols(int numCols=1, bool updateLabels=True) -> bool</autodoc>
+ <autodoc>AppendCols(self, int numCols=1, bool updateLabels=True) -> bool</autodoc>
<paramlist>
<param name="numCols" type="int" default="1"/>
<param name="updateLabels" type="bool" default="True"/>
</paramlist>
</method>
<method name="DeleteCols" type="bool" overloaded="no">
- <autodoc>DeleteCols(int pos=0, int numCols=1, bool updateLabels=True) -> bool</autodoc>
+ <autodoc>DeleteCols(self, int pos=0, int numCols=1, bool updateLabels=True) -> bool</autodoc>
<paramlist>
<param name="pos" type="int" default="0"/>
<param name="numCols" type="int" default="1"/>
</paramlist>
</method>
<method name="DrawCellHighlight" type="" overloaded="no">
- <autodoc>DrawCellHighlight(DC dc, GridCellAttr attr)</autodoc>
+ <autodoc>DrawCellHighlight(self, DC dc, GridCellAttr attr)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="attr" type="GridCellAttr" default=""/>
</paramlist>
</method>
<method name="DrawTextRectangle" type="" overloaded="no">
- <autodoc>DrawTextRectangle(DC dc, String ??, Rect ??, int horizontalAlignment=LEFT,
+ <autodoc>DrawTextRectangle(self, DC dc, String ??, Rect ??, int horizontalAlignment=LEFT,
int verticalAlignment=TOP, int textOrientation=HORIZONTAL)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="BeginBatch" type="" overloaded="no">
- <autodoc>BeginBatch()</autodoc>
+ <autodoc>BeginBatch(self)</autodoc>
</method>
<method name="EndBatch" type="" overloaded="no">
- <autodoc>EndBatch()</autodoc>
+ <autodoc>EndBatch(self)</autodoc>
</method>
<method name="GetBatchCount" type="int" overloaded="no">
- <autodoc>GetBatchCount() -> int</autodoc>
+ <autodoc>GetBatchCount(self) -> int</autodoc>
</method>
<method name="ForceRefresh" type="" overloaded="no">
- <autodoc>ForceRefresh()</autodoc>
+ <autodoc>ForceRefresh(self)</autodoc>
</method>
<method name="IsEditable" type="bool" overloaded="no">
- <autodoc>IsEditable() -> bool</autodoc>
+ <autodoc>IsEditable(self) -> bool</autodoc>
</method>
<method name="EnableEditing" type="" overloaded="no">
- <autodoc>EnableEditing(bool edit)</autodoc>
+ <autodoc>EnableEditing(self, bool edit)</autodoc>
<paramlist>
<param name="edit" type="bool" default=""/>
</paramlist>
</method>
<method name="EnableCellEditControl" type="" overloaded="no">
- <autodoc>EnableCellEditControl(bool enable=True)</autodoc>
+ <autodoc>EnableCellEditControl(self, bool enable=True)</autodoc>
<paramlist>
<param name="enable" type="bool" default="True"/>
</paramlist>
</method>
<method name="DisableCellEditControl" type="" overloaded="no">
- <autodoc>DisableCellEditControl()</autodoc>
+ <autodoc>DisableCellEditControl(self)</autodoc>
</method>
<method name="CanEnableCellControl" type="bool" overloaded="no">
- <autodoc>CanEnableCellControl() -> bool</autodoc>
+ <autodoc>CanEnableCellControl(self) -> bool</autodoc>
</method>
<method name="IsCellEditControlEnabled" type="bool" overloaded="no">
- <autodoc>IsCellEditControlEnabled() -> bool</autodoc>
+ <autodoc>IsCellEditControlEnabled(self) -> bool</autodoc>
</method>
<method name="IsCellEditControlShown" type="bool" overloaded="no">
- <autodoc>IsCellEditControlShown() -> bool</autodoc>
+ <autodoc>IsCellEditControlShown(self) -> bool</autodoc>
</method>
<method name="IsCurrentCellReadOnly" type="bool" overloaded="no">
- <autodoc>IsCurrentCellReadOnly() -> bool</autodoc>
+ <autodoc>IsCurrentCellReadOnly(self) -> bool</autodoc>
</method>
<method name="ShowCellEditControl" type="" overloaded="no">
- <autodoc>ShowCellEditControl()</autodoc>
+ <autodoc>ShowCellEditControl(self)</autodoc>
</method>
<method name="HideCellEditControl" type="" overloaded="no">
- <autodoc>HideCellEditControl()</autodoc>
+ <autodoc>HideCellEditControl(self)</autodoc>
</method>
<method name="SaveEditControlValue" type="" overloaded="no">
- <autodoc>SaveEditControlValue()</autodoc>
+ <autodoc>SaveEditControlValue(self)</autodoc>
</method>
<method name="XYToCell" type="GridCellCoords" overloaded="no">
- <autodoc>XYToCell(int x, int y) -> GridCellCoords</autodoc>
+ <autodoc>XYToCell(self, int x, int y) -> GridCellCoords</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="YToRow" type="int" overloaded="no">
- <autodoc>YToRow(int y) -> int</autodoc>
+ <autodoc>YToRow(self, int y) -> int</autodoc>
<paramlist>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="XToCol" type="int" overloaded="no">
- <autodoc>XToCol(int x) -> int</autodoc>
+ <autodoc>XToCol(self, int x) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="YToEdgeOfRow" type="int" overloaded="no">
- <autodoc>YToEdgeOfRow(int y) -> int</autodoc>
+ <autodoc>YToEdgeOfRow(self, int y) -> int</autodoc>
<paramlist>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="XToEdgeOfCol" type="int" overloaded="no">
- <autodoc>XToEdgeOfCol(int x) -> int</autodoc>
+ <autodoc>XToEdgeOfCol(self, int x) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="CellToRect" type="Rect" overloaded="no">
- <autodoc>CellToRect(int row, int col) -> Rect</autodoc>
+ <autodoc>CellToRect(self, int row, int col) -> Rect</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetGridCursorRow" type="int" overloaded="no">
- <autodoc>GetGridCursorRow() -> int</autodoc>
+ <autodoc>GetGridCursorRow(self) -> int</autodoc>
</method>
<method name="GetGridCursorCol" type="int" overloaded="no">
- <autodoc>GetGridCursorCol() -> int</autodoc>
+ <autodoc>GetGridCursorCol(self) -> int</autodoc>
</method>
<method name="IsVisible" type="bool" overloaded="no">
- <autodoc>IsVisible(int row, int col, bool wholeCellVisible=True) -> bool</autodoc>
+ <autodoc>IsVisible(self, int row, int col, bool wholeCellVisible=True) -> bool</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="MakeCellVisible" type="" overloaded="no">
- <autodoc>MakeCellVisible(int row, int col)</autodoc>
+ <autodoc>MakeCellVisible(self, int row, int col)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetGridCursor" type="" overloaded="no">
- <autodoc>SetGridCursor(int row, int col)</autodoc>
+ <autodoc>SetGridCursor(self, int row, int col)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="MoveCursorUp" type="bool" overloaded="no">
- <autodoc>MoveCursorUp(bool expandSelection) -> bool</autodoc>
+ <autodoc>MoveCursorUp(self, bool expandSelection) -> bool</autodoc>
<paramlist>
<param name="expandSelection" type="bool" default=""/>
</paramlist>
</method>
<method name="MoveCursorDown" type="bool" overloaded="no">
- <autodoc>MoveCursorDown(bool expandSelection) -> bool</autodoc>
+ <autodoc>MoveCursorDown(self, bool expandSelection) -> bool</autodoc>
<paramlist>
<param name="expandSelection" type="bool" default=""/>
</paramlist>
</method>
<method name="MoveCursorLeft" type="bool" overloaded="no">
- <autodoc>MoveCursorLeft(bool expandSelection) -> bool</autodoc>
+ <autodoc>MoveCursorLeft(self, bool expandSelection) -> bool</autodoc>
<paramlist>
<param name="expandSelection" type="bool" default=""/>
</paramlist>
</method>
<method name="MoveCursorRight" type="bool" overloaded="no">
- <autodoc>MoveCursorRight(bool expandSelection) -> bool</autodoc>
+ <autodoc>MoveCursorRight(self, bool expandSelection) -> bool</autodoc>
<paramlist>
<param name="expandSelection" type="bool" default=""/>
</paramlist>
</method>
<method name="MovePageDown" type="bool" overloaded="no">
- <autodoc>MovePageDown() -> bool</autodoc>
+ <autodoc>MovePageDown(self) -> bool</autodoc>
</method>
<method name="MovePageUp" type="bool" overloaded="no">
- <autodoc>MovePageUp() -> bool</autodoc>
+ <autodoc>MovePageUp(self) -> bool</autodoc>
</method>
<method name="MoveCursorUpBlock" type="bool" overloaded="no">
- <autodoc>MoveCursorUpBlock(bool expandSelection) -> bool</autodoc>
+ <autodoc>MoveCursorUpBlock(self, bool expandSelection) -> bool</autodoc>
<paramlist>
<param name="expandSelection" type="bool" default=""/>
</paramlist>
</method>
<method name="MoveCursorDownBlock" type="bool" overloaded="no">
- <autodoc>MoveCursorDownBlock(bool expandSelection) -> bool</autodoc>
+ <autodoc>MoveCursorDownBlock(self, bool expandSelection) -> bool</autodoc>
<paramlist>
<param name="expandSelection" type="bool" default=""/>
</paramlist>
</method>
<method name="MoveCursorLeftBlock" type="bool" overloaded="no">
- <autodoc>MoveCursorLeftBlock(bool expandSelection) -> bool</autodoc>
+ <autodoc>MoveCursorLeftBlock(self, bool expandSelection) -> bool</autodoc>
<paramlist>
<param name="expandSelection" type="bool" default=""/>
</paramlist>
</method>
<method name="MoveCursorRightBlock" type="bool" overloaded="no">
- <autodoc>MoveCursorRightBlock(bool expandSelection) -> bool</autodoc>
+ <autodoc>MoveCursorRightBlock(self, bool expandSelection) -> bool</autodoc>
<paramlist>
<param name="expandSelection" type="bool" default=""/>
</paramlist>
</method>
<method name="GetDefaultRowLabelSize" type="int" overloaded="no">
- <autodoc>GetDefaultRowLabelSize() -> int</autodoc>
+ <autodoc>GetDefaultRowLabelSize(self) -> int</autodoc>
</method>
<method name="GetRowLabelSize" type="int" overloaded="no">
- <autodoc>GetRowLabelSize() -> int</autodoc>
+ <autodoc>GetRowLabelSize(self) -> int</autodoc>
</method>
<method name="GetDefaultColLabelSize" type="int" overloaded="no">
- <autodoc>GetDefaultColLabelSize() -> int</autodoc>
+ <autodoc>GetDefaultColLabelSize(self) -> int</autodoc>
</method>
<method name="GetColLabelSize" type="int" overloaded="no">
- <autodoc>GetColLabelSize() -> int</autodoc>
+ <autodoc>GetColLabelSize(self) -> int</autodoc>
</method>
<method name="GetLabelBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetLabelBackgroundColour() -> Colour</autodoc>
+ <autodoc>GetLabelBackgroundColour(self) -> Colour</autodoc>
</method>
<method name="GetLabelTextColour" type="Colour" overloaded="no">
- <autodoc>GetLabelTextColour() -> Colour</autodoc>
+ <autodoc>GetLabelTextColour(self) -> Colour</autodoc>
</method>
<method name="GetLabelFont" type="Font" overloaded="no">
- <autodoc>GetLabelFont() -> Font</autodoc>
+ <autodoc>GetLabelFont(self) -> Font</autodoc>
</method>
<method name="GetRowLabelAlignment" type="" overloaded="no">
<autodoc>GetRowLabelAlignment() -> (horiz, vert)</autodoc>
</paramlist>
</method>
<method name="GetColLabelTextOrientation" type="int" overloaded="no">
- <autodoc>GetColLabelTextOrientation() -> int</autodoc>
+ <autodoc>GetColLabelTextOrientation(self) -> int</autodoc>
</method>
<method name="GetRowLabelValue" type="String" overloaded="no">
- <autodoc>GetRowLabelValue(int row) -> String</autodoc>
+ <autodoc>GetRowLabelValue(self, int row) -> String</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="GetColLabelValue" type="String" overloaded="no">
- <autodoc>GetColLabelValue(int col) -> String</autodoc>
+ <autodoc>GetColLabelValue(self, int col) -> String</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetGridLineColour" type="Colour" overloaded="no">
- <autodoc>GetGridLineColour() -> Colour</autodoc>
+ <autodoc>GetGridLineColour(self) -> Colour</autodoc>
</method>
<method name="GetCellHighlightColour" type="Colour" overloaded="no">
- <autodoc>GetCellHighlightColour() -> Colour</autodoc>
+ <autodoc>GetCellHighlightColour(self) -> Colour</autodoc>
</method>
<method name="GetCellHighlightPenWidth" type="int" overloaded="no">
- <autodoc>GetCellHighlightPenWidth() -> int</autodoc>
+ <autodoc>GetCellHighlightPenWidth(self) -> int</autodoc>
</method>
<method name="GetCellHighlightROPenWidth" type="int" overloaded="no">
- <autodoc>GetCellHighlightROPenWidth() -> int</autodoc>
+ <autodoc>GetCellHighlightROPenWidth(self) -> int</autodoc>
</method>
<method name="SetRowLabelSize" type="" overloaded="no">
- <autodoc>SetRowLabelSize(int width)</autodoc>
+ <autodoc>SetRowLabelSize(self, int width)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="SetColLabelSize" type="" overloaded="no">
- <autodoc>SetColLabelSize(int height)</autodoc>
+ <autodoc>SetColLabelSize(self, int height)</autodoc>
<paramlist>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="SetLabelBackgroundColour" type="" overloaded="no">
- <autodoc>SetLabelBackgroundColour(Colour ??)</autodoc>
+ <autodoc>SetLabelBackgroundColour(self, Colour ??)</autodoc>
<paramlist>
<param name="" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetLabelTextColour" type="" overloaded="no">
- <autodoc>SetLabelTextColour(Colour ??)</autodoc>
+ <autodoc>SetLabelTextColour(self, Colour ??)</autodoc>
<paramlist>
<param name="" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetLabelFont" type="" overloaded="no">
- <autodoc>SetLabelFont(Font ??)</autodoc>
+ <autodoc>SetLabelFont(self, Font ??)</autodoc>
<paramlist>
<param name="" type="Font" default=""/>
</paramlist>
</method>
<method name="SetRowLabelAlignment" type="" overloaded="no">
- <autodoc>SetRowLabelAlignment(int horiz, int vert)</autodoc>
+ <autodoc>SetRowLabelAlignment(self, int horiz, int vert)</autodoc>
<paramlist>
<param name="horiz" type="int" default=""/>
<param name="vert" type="int" default=""/>
</paramlist>
</method>
<method name="SetColLabelAlignment" type="" overloaded="no">
- <autodoc>SetColLabelAlignment(int horiz, int vert)</autodoc>
+ <autodoc>SetColLabelAlignment(self, int horiz, int vert)</autodoc>
<paramlist>
<param name="horiz" type="int" default=""/>
<param name="vert" type="int" default=""/>
</paramlist>
</method>
<method name="SetColLabelTextOrientation" type="" overloaded="no">
- <autodoc>SetColLabelTextOrientation(int textOrientation)</autodoc>
+ <autodoc>SetColLabelTextOrientation(self, int textOrientation)</autodoc>
<paramlist>
<param name="textOrientation" type="int" default=""/>
</paramlist>
</method>
<method name="SetRowLabelValue" type="" overloaded="no">
- <autodoc>SetRowLabelValue(int row, String ??)</autodoc>
+ <autodoc>SetRowLabelValue(self, int row, String ??)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="" type="String" default=""/>
</paramlist>
</method>
<method name="SetColLabelValue" type="" overloaded="no">
- <autodoc>SetColLabelValue(int col, String ??)</autodoc>
+ <autodoc>SetColLabelValue(self, int col, String ??)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="" type="String" default=""/>
</paramlist>
</method>
<method name="SetGridLineColour" type="" overloaded="no">
- <autodoc>SetGridLineColour(Colour ??)</autodoc>
+ <autodoc>SetGridLineColour(self, Colour ??)</autodoc>
<paramlist>
<param name="" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetCellHighlightColour" type="" overloaded="no">
- <autodoc>SetCellHighlightColour(Colour ??)</autodoc>
+ <autodoc>SetCellHighlightColour(self, Colour ??)</autodoc>
<paramlist>
<param name="" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetCellHighlightPenWidth" type="" overloaded="no">
- <autodoc>SetCellHighlightPenWidth(int width)</autodoc>
+ <autodoc>SetCellHighlightPenWidth(self, int width)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="SetCellHighlightROPenWidth" type="" overloaded="no">
- <autodoc>SetCellHighlightROPenWidth(int width)</autodoc>
+ <autodoc>SetCellHighlightROPenWidth(self, int width)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="EnableDragRowSize" type="" overloaded="no">
- <autodoc>EnableDragRowSize(bool enable=True)</autodoc>
+ <autodoc>EnableDragRowSize(self, bool enable=True)</autodoc>
<paramlist>
<param name="enable" type="bool" default="True"/>
</paramlist>
</method>
<method name="DisableDragRowSize" type="" overloaded="no">
- <autodoc>DisableDragRowSize()</autodoc>
+ <autodoc>DisableDragRowSize(self)</autodoc>
</method>
<method name="CanDragRowSize" type="bool" overloaded="no">
- <autodoc>CanDragRowSize() -> bool</autodoc>
+ <autodoc>CanDragRowSize(self) -> bool</autodoc>
</method>
<method name="EnableDragColSize" type="" overloaded="no">
- <autodoc>EnableDragColSize(bool enable=True)</autodoc>
+ <autodoc>EnableDragColSize(self, bool enable=True)</autodoc>
<paramlist>
<param name="enable" type="bool" default="True"/>
</paramlist>
</method>
<method name="DisableDragColSize" type="" overloaded="no">
- <autodoc>DisableDragColSize()</autodoc>
+ <autodoc>DisableDragColSize(self)</autodoc>
</method>
<method name="CanDragColSize" type="bool" overloaded="no">
- <autodoc>CanDragColSize() -> bool</autodoc>
+ <autodoc>CanDragColSize(self) -> bool</autodoc>
</method>
<method name="EnableDragGridSize" type="" overloaded="no">
- <autodoc>EnableDragGridSize(bool enable=True)</autodoc>
+ <autodoc>EnableDragGridSize(self, bool enable=True)</autodoc>
<paramlist>
<param name="enable" type="bool" default="True"/>
</paramlist>
</method>
<method name="DisableDragGridSize" type="" overloaded="no">
- <autodoc>DisableDragGridSize()</autodoc>
+ <autodoc>DisableDragGridSize(self)</autodoc>
</method>
<method name="CanDragGridSize" type="bool" overloaded="no">
- <autodoc>CanDragGridSize() -> bool</autodoc>
+ <autodoc>CanDragGridSize(self) -> bool</autodoc>
</method>
<method name="SetAttr" type="" overloaded="no">
- <autodoc>SetAttr(int row, int col, GridCellAttr attr)</autodoc>
+ <autodoc>SetAttr(self, int row, int col, GridCellAttr attr)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetRowAttr" type="" overloaded="no">
- <autodoc>SetRowAttr(int row, GridCellAttr attr)</autodoc>
+ <autodoc>SetRowAttr(self, int row, GridCellAttr attr)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="attr" type="GridCellAttr" default=""/>
</paramlist>
</method>
<method name="SetColAttr" type="" overloaded="no">
- <autodoc>SetColAttr(int col, GridCellAttr attr)</autodoc>
+ <autodoc>SetColAttr(self, int col, GridCellAttr attr)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="attr" type="GridCellAttr" default=""/>
</paramlist>
</method>
<method name="SetColFormatBool" type="" overloaded="no">
- <autodoc>SetColFormatBool(int col)</autodoc>
+ <autodoc>SetColFormatBool(self, int col)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetColFormatNumber" type="" overloaded="no">
- <autodoc>SetColFormatNumber(int col)</autodoc>
+ <autodoc>SetColFormatNumber(self, int col)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetColFormatFloat" type="" overloaded="no">
- <autodoc>SetColFormatFloat(int col, int width=-1, int precision=-1)</autodoc>
+ <autodoc>SetColFormatFloat(self, int col, int width=-1, int precision=-1)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="width" type="int" default="-1"/>
</paramlist>
</method>
<method name="SetColFormatCustom" type="" overloaded="no">
- <autodoc>SetColFormatCustom(int col, String typeName)</autodoc>
+ <autodoc>SetColFormatCustom(self, int col, String typeName)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="typeName" type="String" default=""/>
</paramlist>
</method>
<method name="EnableGridLines" type="" overloaded="no">
- <autodoc>EnableGridLines(bool enable=True)</autodoc>
+ <autodoc>EnableGridLines(self, bool enable=True)</autodoc>
<paramlist>
<param name="enable" type="bool" default="True"/>
</paramlist>
</method>
<method name="GridLinesEnabled" type="bool" overloaded="no">
- <autodoc>GridLinesEnabled() -> bool</autodoc>
+ <autodoc>GridLinesEnabled(self) -> bool</autodoc>
</method>
<method name="GetDefaultRowSize" type="int" overloaded="no">
- <autodoc>GetDefaultRowSize() -> int</autodoc>
+ <autodoc>GetDefaultRowSize(self) -> int</autodoc>
</method>
<method name="GetRowSize" type="int" overloaded="no">
- <autodoc>GetRowSize(int row) -> int</autodoc>
+ <autodoc>GetRowSize(self, int row) -> int</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="GetDefaultColSize" type="int" overloaded="no">
- <autodoc>GetDefaultColSize() -> int</autodoc>
+ <autodoc>GetDefaultColSize(self) -> int</autodoc>
</method>
<method name="GetColSize" type="int" overloaded="no">
- <autodoc>GetColSize(int col) -> int</autodoc>
+ <autodoc>GetColSize(self, int col) -> int</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetDefaultCellBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetDefaultCellBackgroundColour() -> Colour</autodoc>
+ <autodoc>GetDefaultCellBackgroundColour(self) -> Colour</autodoc>
</method>
<method name="GetCellBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetCellBackgroundColour(int row, int col) -> Colour</autodoc>
+ <autodoc>GetCellBackgroundColour(self, int row, int col) -> Colour</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetDefaultCellTextColour" type="Colour" overloaded="no">
- <autodoc>GetDefaultCellTextColour() -> Colour</autodoc>
+ <autodoc>GetDefaultCellTextColour(self) -> Colour</autodoc>
</method>
<method name="GetCellTextColour" type="Colour" overloaded="no">
- <autodoc>GetCellTextColour(int row, int col) -> Colour</autodoc>
+ <autodoc>GetCellTextColour(self, int row, int col) -> Colour</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetDefaultCellFont" type="Font" overloaded="no">
- <autodoc>GetDefaultCellFont() -> Font</autodoc>
+ <autodoc>GetDefaultCellFont(self) -> Font</autodoc>
</method>
<method name="GetCellFont" type="Font" overloaded="no">
- <autodoc>GetCellFont(int row, int col) -> Font</autodoc>
+ <autodoc>GetCellFont(self, int row, int col) -> Font</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetDefaultCellOverflow" type="bool" overloaded="no">
- <autodoc>GetDefaultCellOverflow() -> bool</autodoc>
+ <autodoc>GetDefaultCellOverflow(self) -> bool</autodoc>
</method>
<method name="GetCellOverflow" type="bool" overloaded="no">
- <autodoc>GetCellOverflow(int row, int col) -> bool</autodoc>
+ <autodoc>GetCellOverflow(self, int row, int col) -> bool</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetDefaultRowSize" type="" overloaded="no">
- <autodoc>SetDefaultRowSize(int height, bool resizeExistingRows=False)</autodoc>
+ <autodoc>SetDefaultRowSize(self, int height, bool resizeExistingRows=False)</autodoc>
<paramlist>
<param name="height" type="int" default=""/>
<param name="resizeExistingRows" type="bool" default="False"/>
</paramlist>
</method>
<method name="SetRowSize" type="" overloaded="no">
- <autodoc>SetRowSize(int row, int height)</autodoc>
+ <autodoc>SetRowSize(self, int row, int height)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="SetDefaultColSize" type="" overloaded="no">
- <autodoc>SetDefaultColSize(int width, bool resizeExistingCols=False)</autodoc>
+ <autodoc>SetDefaultColSize(self, int width, bool resizeExistingCols=False)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
<param name="resizeExistingCols" type="bool" default="False"/>
</paramlist>
</method>
<method name="SetColSize" type="" overloaded="no">
- <autodoc>SetColSize(int col, int width)</autodoc>
+ <autodoc>SetColSize(self, int col, int width)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="AutoSizeColumn" type="" overloaded="no">
- <autodoc>AutoSizeColumn(int col, bool setAsMin=True)</autodoc>
+ <autodoc>AutoSizeColumn(self, int col, bool setAsMin=True)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="setAsMin" type="bool" default="True"/>
</paramlist>
</method>
<method name="AutoSizeRow" type="" overloaded="no">
- <autodoc>AutoSizeRow(int row, bool setAsMin=True)</autodoc>
+ <autodoc>AutoSizeRow(self, int row, bool setAsMin=True)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="setAsMin" type="bool" default="True"/>
</paramlist>
</method>
<method name="AutoSizeColumns" type="" overloaded="no">
- <autodoc>AutoSizeColumns(bool setAsMin=True)</autodoc>
+ <autodoc>AutoSizeColumns(self, bool setAsMin=True)</autodoc>
<paramlist>
<param name="setAsMin" type="bool" default="True"/>
</paramlist>
</method>
<method name="AutoSizeRows" type="" overloaded="no">
- <autodoc>AutoSizeRows(bool setAsMin=True)</autodoc>
+ <autodoc>AutoSizeRows(self, bool setAsMin=True)</autodoc>
<paramlist>
<param name="setAsMin" type="bool" default="True"/>
</paramlist>
</method>
<method name="AutoSize" type="" overloaded="no">
- <autodoc>AutoSize()</autodoc>
+ <autodoc>AutoSize(self)</autodoc>
</method>
<method name="AutoSizeRowLabelSize" type="" overloaded="no">
- <autodoc>AutoSizeRowLabelSize(int row)</autodoc>
+ <autodoc>AutoSizeRowLabelSize(self, int row)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="AutoSizeColLabelSize" type="" overloaded="no">
- <autodoc>AutoSizeColLabelSize(int col)</autodoc>
+ <autodoc>AutoSizeColLabelSize(self, int col)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetColMinimalWidth" type="" overloaded="no">
- <autodoc>SetColMinimalWidth(int col, int width)</autodoc>
+ <autodoc>SetColMinimalWidth(self, int col, int width)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="SetRowMinimalHeight" type="" overloaded="no">
- <autodoc>SetRowMinimalHeight(int row, int width)</autodoc>
+ <autodoc>SetRowMinimalHeight(self, int row, int width)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="SetColMinimalAcceptableWidth" type="" overloaded="no">
- <autodoc>SetColMinimalAcceptableWidth(int width)</autodoc>
+ <autodoc>SetColMinimalAcceptableWidth(self, int width)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="SetRowMinimalAcceptableHeight" type="" overloaded="no">
- <autodoc>SetRowMinimalAcceptableHeight(int width)</autodoc>
+ <autodoc>SetRowMinimalAcceptableHeight(self, int width)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
</paramlist>
</method>
<method name="GetColMinimalAcceptableWidth" type="int" overloaded="no">
- <autodoc>GetColMinimalAcceptableWidth() -> int</autodoc>
+ <autodoc>GetColMinimalAcceptableWidth(self) -> int</autodoc>
</method>
<method name="GetRowMinimalAcceptableHeight" type="int" overloaded="no">
- <autodoc>GetRowMinimalAcceptableHeight() -> int</autodoc>
+ <autodoc>GetRowMinimalAcceptableHeight(self) -> int</autodoc>
</method>
<method name="SetDefaultCellBackgroundColour" type="" overloaded="no">
- <autodoc>SetDefaultCellBackgroundColour(Colour ??)</autodoc>
+ <autodoc>SetDefaultCellBackgroundColour(self, Colour ??)</autodoc>
<paramlist>
<param name="" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetCellBackgroundColour" type="" overloaded="no">
- <autodoc>SetCellBackgroundColour(int row, int col, Colour ??)</autodoc>
+ <autodoc>SetCellBackgroundColour(self, int row, int col, Colour ??)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetDefaultCellTextColour" type="" overloaded="no">
- <autodoc>SetDefaultCellTextColour(Colour ??)</autodoc>
+ <autodoc>SetDefaultCellTextColour(self, Colour ??)</autodoc>
<paramlist>
<param name="" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetCellTextColour" type="" overloaded="no">
- <autodoc>SetCellTextColour(int row, int col, Colour ??)</autodoc>
+ <autodoc>SetCellTextColour(self, int row, int col, Colour ??)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetDefaultCellFont" type="" overloaded="no">
- <autodoc>SetDefaultCellFont(Font ??)</autodoc>
+ <autodoc>SetDefaultCellFont(self, Font ??)</autodoc>
<paramlist>
<param name="" type="Font" default=""/>
</paramlist>
</method>
<method name="SetCellFont" type="" overloaded="no">
- <autodoc>SetCellFont(int row, int col, Font ??)</autodoc>
+ <autodoc>SetCellFont(self, int row, int col, Font ??)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetDefaultCellAlignment" type="" overloaded="no">
- <autodoc>SetDefaultCellAlignment(int horiz, int vert)</autodoc>
+ <autodoc>SetDefaultCellAlignment(self, int horiz, int vert)</autodoc>
<paramlist>
<param name="horiz" type="int" default=""/>
<param name="vert" type="int" default=""/>
</paramlist>
</method>
<method name="SetCellAlignment" type="" overloaded="no">
- <autodoc>SetCellAlignment(int row, int col, int horiz, int vert)</autodoc>
+ <autodoc>SetCellAlignment(self, int row, int col, int horiz, int vert)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetDefaultCellOverflow" type="" overloaded="no">
- <autodoc>SetDefaultCellOverflow(bool allow)</autodoc>
+ <autodoc>SetDefaultCellOverflow(self, bool allow)</autodoc>
<paramlist>
<param name="allow" type="bool" default=""/>
</paramlist>
</method>
<method name="SetCellOverflow" type="" overloaded="no">
- <autodoc>SetCellOverflow(int row, int col, bool allow)</autodoc>
+ <autodoc>SetCellOverflow(self, int row, int col, bool allow)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetCellSize" type="" overloaded="no">
- <autodoc>SetCellSize(int row, int col, int num_rows, int num_cols)</autodoc>
+ <autodoc>SetCellSize(self, int row, int col, int num_rows, int num_cols)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetDefaultRenderer" type="" overloaded="no">
- <autodoc>SetDefaultRenderer(GridCellRenderer renderer)</autodoc>
+ <autodoc>SetDefaultRenderer(self, GridCellRenderer renderer)</autodoc>
<paramlist>
<param name="renderer" type="GridCellRenderer" default=""/>
</paramlist>
</method>
<method name="SetCellRenderer" type="" overloaded="no">
- <autodoc>SetCellRenderer(int row, int col, GridCellRenderer renderer)</autodoc>
+ <autodoc>SetCellRenderer(self, int row, int col, GridCellRenderer renderer)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetDefaultRenderer" type="GridCellRenderer" overloaded="no">
- <autodoc>GetDefaultRenderer() -> GridCellRenderer</autodoc>
+ <autodoc>GetDefaultRenderer(self) -> GridCellRenderer</autodoc>
</method>
<method name="GetCellRenderer" type="GridCellRenderer" overloaded="no">
- <autodoc>GetCellRenderer(int row, int col) -> GridCellRenderer</autodoc>
+ <autodoc>GetCellRenderer(self, int row, int col) -> GridCellRenderer</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetDefaultEditor" type="" overloaded="no">
- <autodoc>SetDefaultEditor(GridCellEditor editor)</autodoc>
+ <autodoc>SetDefaultEditor(self, GridCellEditor editor)</autodoc>
<paramlist>
<param name="editor" type="GridCellEditor" default=""/>
</paramlist>
</method>
<method name="SetCellEditor" type="" overloaded="no">
- <autodoc>SetCellEditor(int row, int col, GridCellEditor editor)</autodoc>
+ <autodoc>SetCellEditor(self, int row, int col, GridCellEditor editor)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetDefaultEditor" type="GridCellEditor" overloaded="no">
- <autodoc>GetDefaultEditor() -> GridCellEditor</autodoc>
+ <autodoc>GetDefaultEditor(self) -> GridCellEditor</autodoc>
</method>
<method name="GetCellEditor" type="GridCellEditor" overloaded="no">
- <autodoc>GetCellEditor(int row, int col) -> GridCellEditor</autodoc>
+ <autodoc>GetCellEditor(self, int row, int col) -> GridCellEditor</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetCellValue" type="String" overloaded="no">
- <autodoc>GetCellValue(int row, int col) -> String</autodoc>
+ <autodoc>GetCellValue(self, int row, int col) -> String</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetCellValue" type="" overloaded="no">
- <autodoc>SetCellValue(int row, int col, String s)</autodoc>
+ <autodoc>SetCellValue(self, int row, int col, String s)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="IsReadOnly" type="bool" overloaded="no">
- <autodoc>IsReadOnly(int row, int col) -> bool</autodoc>
+ <autodoc>IsReadOnly(self, int row, int col) -> bool</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetReadOnly" type="" overloaded="no">
- <autodoc>SetReadOnly(int row, int col, bool isReadOnly=True)</autodoc>
+ <autodoc>SetReadOnly(self, int row, int col, bool isReadOnly=True)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SelectRow" type="" overloaded="no">
- <autodoc>SelectRow(int row, bool addToSelected=False)</autodoc>
+ <autodoc>SelectRow(self, int row, bool addToSelected=False)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="addToSelected" type="bool" default="False"/>
</paramlist>
</method>
<method name="SelectCol" type="" overloaded="no">
- <autodoc>SelectCol(int col, bool addToSelected=False)</autodoc>
+ <autodoc>SelectCol(self, int col, bool addToSelected=False)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
<param name="addToSelected" type="bool" default="False"/>
</paramlist>
</method>
<method name="SelectBlock" type="" overloaded="no">
- <autodoc>SelectBlock(int topRow, int leftCol, int bottomRow, int rightCol,
+ <autodoc>SelectBlock(self, int topRow, int leftCol, int bottomRow, int rightCol,
bool addToSelected=False)</autodoc>
<paramlist>
<param name="topRow" type="int" default=""/>
</paramlist>
</method>
<method name="SelectAll" type="" overloaded="no">
- <autodoc>SelectAll()</autodoc>
+ <autodoc>SelectAll(self)</autodoc>
</method>
<method name="IsSelection" type="bool" overloaded="no">
- <autodoc>IsSelection() -> bool</autodoc>
+ <autodoc>IsSelection(self) -> bool</autodoc>
</method>
<method name="ClearSelection" type="" overloaded="no">
- <autodoc>ClearSelection()</autodoc>
+ <autodoc>ClearSelection(self)</autodoc>
</method>
<method name="IsInSelection" type="bool" overloaded="no">
- <autodoc>IsInSelection(int row, int col) -> bool</autodoc>
+ <autodoc>IsInSelection(self, int row, int col) -> bool</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetSelectedCells" type="wxGridCellCoordsArray" overloaded="no">
- <autodoc>GetSelectedCells() -> wxGridCellCoordsArray</autodoc>
+ <autodoc>GetSelectedCells(self) -> wxGridCellCoordsArray</autodoc>
</method>
<method name="GetSelectionBlockTopLeft" type="wxGridCellCoordsArray" overloaded="no">
- <autodoc>GetSelectionBlockTopLeft() -> wxGridCellCoordsArray</autodoc>
+ <autodoc>GetSelectionBlockTopLeft(self) -> wxGridCellCoordsArray</autodoc>
</method>
<method name="GetSelectionBlockBottomRight" type="wxGridCellCoordsArray" overloaded="no">
- <autodoc>GetSelectionBlockBottomRight() -> wxGridCellCoordsArray</autodoc>
+ <autodoc>GetSelectionBlockBottomRight(self) -> wxGridCellCoordsArray</autodoc>
</method>
<method name="GetSelectedRows" type="wxArrayInt" overloaded="no">
- <autodoc>GetSelectedRows() -> wxArrayInt</autodoc>
+ <autodoc>GetSelectedRows(self) -> wxArrayInt</autodoc>
</method>
<method name="GetSelectedCols" type="wxArrayInt" overloaded="no">
- <autodoc>GetSelectedCols() -> wxArrayInt</autodoc>
+ <autodoc>GetSelectedCols(self) -> wxArrayInt</autodoc>
</method>
<method name="DeselectRow" type="" overloaded="no">
- <autodoc>DeselectRow(int row)</autodoc>
+ <autodoc>DeselectRow(self, int row)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="DeselectCol" type="" overloaded="no">
- <autodoc>DeselectCol(int col)</autodoc>
+ <autodoc>DeselectCol(self, int col)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="DeselectCell" type="" overloaded="no">
- <autodoc>DeselectCell(int row, int col)</autodoc>
+ <autodoc>DeselectCell(self, int row, int col)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="BlockToDeviceRect" type="Rect" overloaded="no">
- <autodoc>BlockToDeviceRect(GridCellCoords topLeft, GridCellCoords bottomRight) -> Rect</autodoc>
+ <autodoc>BlockToDeviceRect(self, GridCellCoords topLeft, GridCellCoords bottomRight) -> Rect</autodoc>
<paramlist>
<param name="topLeft" type="GridCellCoords" default=""/>
<param name="bottomRight" type="GridCellCoords" default=""/>
</paramlist>
</method>
<method name="GetSelectionBackground" type="Colour" overloaded="no">
- <autodoc>GetSelectionBackground() -> Colour</autodoc>
+ <autodoc>GetSelectionBackground(self) -> Colour</autodoc>
</method>
<method name="GetSelectionForeground" type="Colour" overloaded="no">
- <autodoc>GetSelectionForeground() -> Colour</autodoc>
+ <autodoc>GetSelectionForeground(self) -> Colour</autodoc>
</method>
<method name="SetSelectionBackground" type="" overloaded="no">
- <autodoc>SetSelectionBackground(Colour c)</autodoc>
+ <autodoc>SetSelectionBackground(self, Colour c)</autodoc>
<paramlist>
<param name="c" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetSelectionForeground" type="" overloaded="no">
- <autodoc>SetSelectionForeground(Colour c)</autodoc>
+ <autodoc>SetSelectionForeground(self, Colour c)</autodoc>
<paramlist>
<param name="c" type="Colour" default=""/>
</paramlist>
</method>
<method name="RegisterDataType" type="" overloaded="no">
- <autodoc>RegisterDataType(String typeName, GridCellRenderer renderer, GridCellEditor editor)</autodoc>
+ <autodoc>RegisterDataType(self, String typeName, GridCellRenderer renderer, GridCellEditor editor)</autodoc>
<paramlist>
<param name="typeName" type="String" default=""/>
<param name="renderer" type="GridCellRenderer" default=""/>
</paramlist>
</method>
<method name="GetDefaultEditorForCell" type="GridCellEditor" overloaded="no">
- <autodoc>GetDefaultEditorForCell(int row, int col) -> GridCellEditor</autodoc>
+ <autodoc>GetDefaultEditorForCell(self, int row, int col) -> GridCellEditor</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetDefaultRendererForCell" type="GridCellRenderer" overloaded="no">
- <autodoc>GetDefaultRendererForCell(int row, int col) -> GridCellRenderer</autodoc>
+ <autodoc>GetDefaultRendererForCell(self, int row, int col) -> GridCellRenderer</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="GetDefaultEditorForType" type="GridCellEditor" overloaded="no">
- <autodoc>GetDefaultEditorForType(String typeName) -> GridCellEditor</autodoc>
+ <autodoc>GetDefaultEditorForType(self, String typeName) -> GridCellEditor</autodoc>
<paramlist>
<param name="typeName" type="String" default=""/>
</paramlist>
</method>
<method name="GetDefaultRendererForType" type="GridCellRenderer" overloaded="no">
- <autodoc>GetDefaultRendererForType(String typeName) -> GridCellRenderer</autodoc>
+ <autodoc>GetDefaultRendererForType(self, String typeName) -> GridCellRenderer</autodoc>
<paramlist>
<param name="typeName" type="String" default=""/>
</paramlist>
</method>
<method name="SetMargins" type="" overloaded="no">
- <autodoc>SetMargins(int extraWidth, int extraHeight)</autodoc>
+ <autodoc>SetMargins(self, int extraWidth, int extraHeight)</autodoc>
<paramlist>
<param name="extraWidth" type="int" default=""/>
<param name="extraHeight" type="int" default=""/>
</paramlist>
</method>
<method name="GetGridWindow" type="Window" overloaded="no">
- <autodoc>GetGridWindow() -> Window</autodoc>
+ <autodoc>GetGridWindow(self) -> Window</autodoc>
</method>
<method name="GetGridRowLabelWindow" type="Window" overloaded="no">
- <autodoc>GetGridRowLabelWindow() -> Window</autodoc>
+ <autodoc>GetGridRowLabelWindow(self) -> Window</autodoc>
</method>
<method name="GetGridColLabelWindow" type="Window" overloaded="no">
- <autodoc>GetGridColLabelWindow() -> Window</autodoc>
+ <autodoc>GetGridColLabelWindow(self) -> Window</autodoc>
</method>
<method name="GetGridCornerLabelWindow" type="Window" overloaded="no">
- <autodoc>GetGridCornerLabelWindow() -> Window</autodoc>
+ <autodoc>GetGridCornerLabelWindow(self) -> Window</autodoc>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<class name="GridEvent" oldname="wxGridEvent" module="grid">
<baseclass name="NotifyEvent"/>
<constructor name="GridEvent" overloaded="no">
- <autodoc>__init__(int id, wxEventType type, Grid obj, int row=-1, int col=-1,
+ <autodoc>__init__(self, int id, wxEventType type, Grid obj, int row=-1, int col=-1,
int x=-1, int y=-1, bool sel=True, bool control=False,
bool shift=False, bool alt=False,
bool meta=False) -> GridEvent</autodoc>
</paramlist>
</constructor>
<method name="GetRow" type="int" overloaded="no">
- <autodoc>GetRow() -> int</autodoc>
+ <autodoc>GetRow(self) -> int</autodoc>
</method>
<method name="GetCol" type="int" overloaded="no">
- <autodoc>GetCol() -> int</autodoc>
+ <autodoc>GetCol(self) -> int</autodoc>
</method>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
</method>
<method name="Selecting" type="bool" overloaded="no">
- <autodoc>Selecting() -> bool</autodoc>
+ <autodoc>Selecting(self) -> bool</autodoc>
</method>
<method name="ControlDown" type="bool" overloaded="no">
- <autodoc>ControlDown() -> bool</autodoc>
+ <autodoc>ControlDown(self) -> bool</autodoc>
</method>
<method name="MetaDown" type="bool" overloaded="no">
- <autodoc>MetaDown() -> bool</autodoc>
+ <autodoc>MetaDown(self) -> bool</autodoc>
</method>
<method name="ShiftDown" type="bool" overloaded="no">
- <autodoc>ShiftDown() -> bool</autodoc>
+ <autodoc>ShiftDown(self) -> bool</autodoc>
</method>
<method name="AltDown" type="bool" overloaded="no">
- <autodoc>AltDown() -> bool</autodoc>
+ <autodoc>AltDown(self) -> bool</autodoc>
</method>
</class>
<class name="GridSizeEvent" oldname="wxGridSizeEvent" module="grid">
<baseclass name="NotifyEvent"/>
<constructor name="GridSizeEvent" overloaded="no">
- <autodoc>__init__(int id, wxEventType type, Grid obj, int rowOrCol=-1,
+ <autodoc>__init__(self, int id, wxEventType type, Grid obj, int rowOrCol=-1,
int x=-1, int y=-1, bool control=False, bool shift=False,
bool alt=False, bool meta=False) -> GridSizeEvent</autodoc>
<paramlist>
</paramlist>
</constructor>
<method name="GetRowOrCol" type="int" overloaded="no">
- <autodoc>GetRowOrCol() -> int</autodoc>
+ <autodoc>GetRowOrCol(self) -> int</autodoc>
</method>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition() -> Point</autodoc>
+ <autodoc>GetPosition(self) -> Point</autodoc>
</method>
<method name="ControlDown" type="bool" overloaded="no">
- <autodoc>ControlDown() -> bool</autodoc>
+ <autodoc>ControlDown(self) -> bool</autodoc>
</method>
<method name="MetaDown" type="bool" overloaded="no">
- <autodoc>MetaDown() -> bool</autodoc>
+ <autodoc>MetaDown(self) -> bool</autodoc>
</method>
<method name="ShiftDown" type="bool" overloaded="no">
- <autodoc>ShiftDown() -> bool</autodoc>
+ <autodoc>ShiftDown(self) -> bool</autodoc>
</method>
<method name="AltDown" type="bool" overloaded="no">
- <autodoc>AltDown() -> bool</autodoc>
+ <autodoc>AltDown(self) -> bool</autodoc>
</method>
</class>
<class name="GridRangeSelectEvent" oldname="wxGridRangeSelectEvent" module="grid">
<baseclass name="NotifyEvent"/>
<constructor name="GridRangeSelectEvent" overloaded="no">
- <autodoc>__init__(int id, wxEventType type, Grid obj, GridCellCoords topLeft,
+ <autodoc>__init__(self, int id, wxEventType type, Grid obj, GridCellCoords topLeft,
GridCellCoords bottomRight, bool sel=True,
bool control=False, bool shift=False,
bool alt=False, bool meta=False) -> GridRangeSelectEvent</autodoc>
</paramlist>
</constructor>
<method name="GetTopLeftCoords" type="GridCellCoords" overloaded="no">
- <autodoc>GetTopLeftCoords() -> GridCellCoords</autodoc>
+ <autodoc>GetTopLeftCoords(self) -> GridCellCoords</autodoc>
</method>
<method name="GetBottomRightCoords" type="GridCellCoords" overloaded="no">
- <autodoc>GetBottomRightCoords() -> GridCellCoords</autodoc>
+ <autodoc>GetBottomRightCoords(self) -> GridCellCoords</autodoc>
</method>
<method name="GetTopRow" type="int" overloaded="no">
- <autodoc>GetTopRow() -> int</autodoc>
+ <autodoc>GetTopRow(self) -> int</autodoc>
</method>
<method name="GetBottomRow" type="int" overloaded="no">
- <autodoc>GetBottomRow() -> int</autodoc>
+ <autodoc>GetBottomRow(self) -> int</autodoc>
</method>
<method name="GetLeftCol" type="int" overloaded="no">
- <autodoc>GetLeftCol() -> int</autodoc>
+ <autodoc>GetLeftCol(self) -> int</autodoc>
</method>
<method name="GetRightCol" type="int" overloaded="no">
- <autodoc>GetRightCol() -> int</autodoc>
+ <autodoc>GetRightCol(self) -> int</autodoc>
</method>
<method name="Selecting" type="bool" overloaded="no">
- <autodoc>Selecting() -> bool</autodoc>
+ <autodoc>Selecting(self) -> bool</autodoc>
</method>
<method name="ControlDown" type="bool" overloaded="no">
- <autodoc>ControlDown() -> bool</autodoc>
+ <autodoc>ControlDown(self) -> bool</autodoc>
</method>
<method name="MetaDown" type="bool" overloaded="no">
- <autodoc>MetaDown() -> bool</autodoc>
+ <autodoc>MetaDown(self) -> bool</autodoc>
</method>
<method name="ShiftDown" type="bool" overloaded="no">
- <autodoc>ShiftDown() -> bool</autodoc>
+ <autodoc>ShiftDown(self) -> bool</autodoc>
</method>
<method name="AltDown" type="bool" overloaded="no">
- <autodoc>AltDown() -> bool</autodoc>
+ <autodoc>AltDown(self) -> bool</autodoc>
</method>
</class>
<class name="GridEditorCreatedEvent" oldname="wxGridEditorCreatedEvent" module="grid">
<baseclass name="CommandEvent"/>
<constructor name="GridEditorCreatedEvent" overloaded="no">
- <autodoc>__init__(int id, wxEventType type, Object obj, int row, int col,
+ <autodoc>__init__(self, int id, wxEventType type, Object obj, int row, int col,
Control ctrl) -> GridEditorCreatedEvent</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</constructor>
<method name="GetRow" type="int" overloaded="no">
- <autodoc>GetRow() -> int</autodoc>
+ <autodoc>GetRow(self) -> int</autodoc>
</method>
<method name="GetCol" type="int" overloaded="no">
- <autodoc>GetCol() -> int</autodoc>
+ <autodoc>GetCol(self) -> int</autodoc>
</method>
<method name="GetControl" type="Control" overloaded="no">
- <autodoc>GetControl() -> Control</autodoc>
+ <autodoc>GetControl(self) -> Control</autodoc>
</method>
<method name="SetRow" type="" overloaded="no">
- <autodoc>SetRow(int row)</autodoc>
+ <autodoc>SetRow(self, int row)</autodoc>
<paramlist>
<param name="row" type="int" default=""/>
</paramlist>
</method>
<method name="SetCol" type="" overloaded="no">
- <autodoc>SetCol(int col)</autodoc>
+ <autodoc>SetCol(self, int col)</autodoc>
<paramlist>
<param name="col" type="int" default=""/>
</paramlist>
</method>
<method name="SetControl" type="" overloaded="no">
- <autodoc>SetControl(Control ctrl)</autodoc>
+ <autodoc>SetControl(self, Control ctrl)</autodoc>
<paramlist>
<param name="ctrl" type="Control" default=""/>
</paramlist>
</pythoncode>
</module>
<module name="html">
- <import name="windows"/>
- <pythoncode> wx = core </pythoncode>
+ <import name="_windows"/>
+ <pythoncode> wx = _core </pythoncode>
+ <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
<class name="HtmlLinkInfo" oldname="wxHtmlLinkInfo" module="html">
<baseclass name="Object"/>
<constructor name="HtmlLinkInfo" overloaded="no">
- <autodoc>__init__(String href, String target=EmptyString) -> HtmlLinkInfo</autodoc>
+ <autodoc>__init__(self, String href, String target=EmptyString) -> HtmlLinkInfo</autodoc>
<paramlist>
<param name="href" type="String" default=""/>
<param name="target" type="String" default="wxPyEmptyString"/>
</paramlist>
</constructor>
<method name="GetHref" type="String" overloaded="no">
- <autodoc>GetHref() -> String</autodoc>
+ <autodoc>GetHref(self) -> String</autodoc>
</method>
<method name="GetTarget" type="String" overloaded="no">
- <autodoc>GetTarget() -> String</autodoc>
+ <autodoc>GetTarget(self) -> String</autodoc>
</method>
<method name="GetEvent" type="MouseEvent" overloaded="no">
- <autodoc>GetEvent() -> MouseEvent</autodoc>
+ <autodoc>GetEvent(self) -> MouseEvent</autodoc>
</method>
<method name="GetHtmlCell" type="wxHtmlCell" overloaded="no">
- <autodoc>GetHtmlCell() -> HtmlCell</autodoc>
+ <autodoc>GetHtmlCell(self) -> HtmlCell</autodoc>
</method>
<method name="SetEvent" type="" overloaded="no">
- <autodoc>SetEvent(MouseEvent e)</autodoc>
+ <autodoc>SetEvent(self, MouseEvent e)</autodoc>
<paramlist>
<param name="e" type="MouseEvent" default=""/>
</paramlist>
</method>
<method name="SetHtmlCell" type="" overloaded="no">
- <autodoc>SetHtmlCell(HtmlCell e)</autodoc>
+ <autodoc>SetHtmlCell(self, HtmlCell e)</autodoc>
<paramlist>
<param name="e" type="wxHtmlCell" default=""/>
</paramlist>
<class name="HtmlTag" oldname="wxHtmlTag" module="html">
<baseclass name="Object"/>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
+ <autodoc>GetName(self) -> String</autodoc>
</method>
<method name="HasParam" type="bool" overloaded="no">
- <autodoc>HasParam(String par) -> bool</autodoc>
+ <autodoc>HasParam(self, String par) -> bool</autodoc>
<paramlist>
<param name="par" type="String" default=""/>
</paramlist>
</method>
<method name="GetParam" type="String" overloaded="no">
- <autodoc>GetParam(String par, int with_commas=False) -> String</autodoc>
+ <autodoc>GetParam(self, String par, int with_commas=False) -> String</autodoc>
<paramlist>
<param name="par" type="String" default=""/>
<param name="with_commas" type="int" default="False"/>
</paramlist>
</method>
<method name="GetAllParams" type="String" overloaded="no">
- <autodoc>GetAllParams() -> String</autodoc>
+ <autodoc>GetAllParams(self) -> String</autodoc>
</method>
<method name="HasEnding" type="bool" overloaded="no">
- <autodoc>HasEnding() -> bool</autodoc>
+ <autodoc>HasEnding(self) -> bool</autodoc>
</method>
<method name="GetBeginPos" type="int" overloaded="no">
- <autodoc>GetBeginPos() -> int</autodoc>
+ <autodoc>GetBeginPos(self) -> int</autodoc>
</method>
<method name="GetEndPos1" type="int" overloaded="no">
- <autodoc>GetEndPos1() -> int</autodoc>
+ <autodoc>GetEndPos1(self) -> int</autodoc>
</method>
<method name="GetEndPos2" type="int" overloaded="no">
- <autodoc>GetEndPos2() -> int</autodoc>
+ <autodoc>GetEndPos2(self) -> int</autodoc>
</method>
</class>
<class name="HtmlParser" oldname="wxHtmlParser" module="html">
<baseclass name="Object"/>
<method name="SetFS" type="" overloaded="no">
- <autodoc>SetFS(FileSystem fs)</autodoc>
+ <autodoc>SetFS(self, FileSystem fs)</autodoc>
<paramlist>
<param name="fs" type="FileSystem" default=""/>
</paramlist>
</method>
<method name="GetFS" type="FileSystem" overloaded="no">
- <autodoc>GetFS() -> FileSystem</autodoc>
+ <autodoc>GetFS(self) -> FileSystem</autodoc>
</method>
<method name="Parse" type="Object" overloaded="no">
- <autodoc>Parse(String source) -> Object</autodoc>
+ <autodoc>Parse(self, String source) -> Object</autodoc>
<paramlist>
<param name="source" type="String" default=""/>
</paramlist>
</method>
<method name="InitParser" type="" overloaded="no">
- <autodoc>InitParser(String source)</autodoc>
+ <autodoc>InitParser(self, String source)</autodoc>
<paramlist>
<param name="source" type="String" default=""/>
</paramlist>
</method>
<method name="DoneParser" type="" overloaded="no">
- <autodoc>DoneParser()</autodoc>
+ <autodoc>DoneParser(self)</autodoc>
</method>
<method name="DoParsing" type="" overloaded="no">
- <autodoc>DoParsing(int begin_pos, int end_pos)</autodoc>
+ <autodoc>DoParsing(self, int begin_pos, int end_pos)</autodoc>
<paramlist>
<param name="begin_pos" type="int" default=""/>
<param name="end_pos" type="int" default=""/>
</paramlist>
</method>
<method name="StopParsing" type="" overloaded="no">
- <autodoc>StopParsing()</autodoc>
+ <autodoc>StopParsing(self)</autodoc>
</method>
<method name="AddTagHandler" type="" overloaded="no">
- <autodoc>AddTagHandler(HtmlTagHandler handler)</autodoc>
+ <autodoc>AddTagHandler(self, HtmlTagHandler handler)</autodoc>
<paramlist>
<param name="handler" type="wxHtmlTagHandler" default=""/>
</paramlist>
</method>
<method name="GetSource" type="String" overloaded="no">
- <autodoc>GetSource() -> String</autodoc>
+ <autodoc>GetSource(self) -> String</autodoc>
</method>
<method name="PushTagHandler" type="" overloaded="no">
- <autodoc>PushTagHandler(HtmlTagHandler handler, String tags)</autodoc>
+ <autodoc>PushTagHandler(self, HtmlTagHandler handler, String tags)</autodoc>
<paramlist>
<param name="handler" type="wxHtmlTagHandler" default=""/>
<param name="tags" type="String" default=""/>
</paramlist>
</method>
<method name="PopTagHandler" type="" overloaded="no">
- <autodoc>PopTagHandler()</autodoc>
+ <autodoc>PopTagHandler(self)</autodoc>
</method>
</class>
<class name="HtmlWinParser" oldname="wxHtmlWinParser" module="html">
<baseclass name="HtmlParser"/>
<constructor name="HtmlWinParser" overloaded="no">
- <autodoc>__init__(HtmlWindow wnd=None) -> HtmlWinParser</autodoc>
+ <autodoc>__init__(self, HtmlWindow wnd=None) -> HtmlWinParser</autodoc>
<paramlist>
<param name="wnd" type="wxPyHtmlWindow" default="NULL"/>
</paramlist>
</constructor>
<method name="SetDC" type="" overloaded="no">
- <autodoc>SetDC(DC dc)</autodoc>
+ <autodoc>SetDC(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="GetDC" type="DC" overloaded="no">
- <autodoc>GetDC() -> DC</autodoc>
+ <autodoc>GetDC(self) -> DC</autodoc>
</method>
<method name="GetCharHeight" type="int" overloaded="no">
- <autodoc>GetCharHeight() -> int</autodoc>
+ <autodoc>GetCharHeight(self) -> int</autodoc>
</method>
<method name="GetCharWidth" type="int" overloaded="no">
- <autodoc>GetCharWidth() -> int</autodoc>
+ <autodoc>GetCharWidth(self) -> int</autodoc>
</method>
<method name="GetWindow" type="wxPyHtmlWindow" overloaded="no">
- <autodoc>GetWindow() -> HtmlWindow</autodoc>
+ <autodoc>GetWindow(self) -> HtmlWindow</autodoc>
</method>
<method name="SetFonts" type="" overloaded="no">
- <autodoc>SetFonts(String normal_face, String fixed_face, PyObject sizes=None)</autodoc>
+ <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)</autodoc>
<paramlist>
<param name="normal_face" type="String" default=""/>
<param name="fixed_face" type="String" default=""/>
</paramlist>
</method>
<method name="GetContainer" type="wxHtmlContainerCell" overloaded="no">
- <autodoc>GetContainer() -> HtmlContainerCell</autodoc>
+ <autodoc>GetContainer(self) -> HtmlContainerCell</autodoc>
</method>
<method name="OpenContainer" type="wxHtmlContainerCell" overloaded="no">
- <autodoc>OpenContainer() -> HtmlContainerCell</autodoc>
+ <autodoc>OpenContainer(self) -> HtmlContainerCell</autodoc>
</method>
<method name="SetContainer" type="wxHtmlContainerCell" overloaded="no">
- <autodoc>SetContainer(HtmlContainerCell c) -> HtmlContainerCell</autodoc>
+ <autodoc>SetContainer(self, HtmlContainerCell c) -> HtmlContainerCell</autodoc>
<paramlist>
<param name="c" type="wxHtmlContainerCell" default=""/>
</paramlist>
</method>
<method name="CloseContainer" type="wxHtmlContainerCell" overloaded="no">
- <autodoc>CloseContainer() -> HtmlContainerCell</autodoc>
+ <autodoc>CloseContainer(self) -> HtmlContainerCell</autodoc>
</method>
<method name="GetFontSize" type="int" overloaded="no">
- <autodoc>GetFontSize() -> int</autodoc>
+ <autodoc>GetFontSize(self) -> int</autodoc>
</method>
<method name="SetFontSize" type="" overloaded="no">
- <autodoc>SetFontSize(int s)</autodoc>
+ <autodoc>SetFontSize(self, int s)</autodoc>
<paramlist>
<param name="s" type="int" default=""/>
</paramlist>
</method>
<method name="GetFontBold" type="int" overloaded="no">
- <autodoc>GetFontBold() -> int</autodoc>
+ <autodoc>GetFontBold(self) -> int</autodoc>
</method>
<method name="SetFontBold" type="" overloaded="no">
- <autodoc>SetFontBold(int x)</autodoc>
+ <autodoc>SetFontBold(self, int x)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="GetFontItalic" type="int" overloaded="no">
- <autodoc>GetFontItalic() -> int</autodoc>
+ <autodoc>GetFontItalic(self) -> int</autodoc>
</method>
<method name="SetFontItalic" type="" overloaded="no">
- <autodoc>SetFontItalic(int x)</autodoc>
+ <autodoc>SetFontItalic(self, int x)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="GetFontUnderlined" type="int" overloaded="no">
- <autodoc>GetFontUnderlined() -> int</autodoc>
+ <autodoc>GetFontUnderlined(self) -> int</autodoc>
</method>
<method name="SetFontUnderlined" type="" overloaded="no">
- <autodoc>SetFontUnderlined(int x)</autodoc>
+ <autodoc>SetFontUnderlined(self, int x)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="GetFontFixed" type="int" overloaded="no">
- <autodoc>GetFontFixed() -> int</autodoc>
+ <autodoc>GetFontFixed(self) -> int</autodoc>
</method>
<method name="SetFontFixed" type="" overloaded="no">
- <autodoc>SetFontFixed(int x)</autodoc>
+ <autodoc>SetFontFixed(self, int x)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="GetAlign" type="int" overloaded="no">
- <autodoc>GetAlign() -> int</autodoc>
+ <autodoc>GetAlign(self) -> int</autodoc>
</method>
<method name="SetAlign" type="" overloaded="no">
- <autodoc>SetAlign(int a)</autodoc>
+ <autodoc>SetAlign(self, int a)</autodoc>
<paramlist>
<param name="a" type="int" default=""/>
</paramlist>
</method>
<method name="GetLinkColor" type="Colour" overloaded="no">
- <autodoc>GetLinkColor() -> Colour</autodoc>
+ <autodoc>GetLinkColor(self) -> Colour</autodoc>
</method>
<method name="SetLinkColor" type="" overloaded="no">
- <autodoc>SetLinkColor(Colour clr)</autodoc>
+ <autodoc>SetLinkColor(self, Colour clr)</autodoc>
<paramlist>
<param name="clr" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetActualColor" type="Colour" overloaded="no">
- <autodoc>GetActualColor() -> Colour</autodoc>
+ <autodoc>GetActualColor(self) -> Colour</autodoc>
</method>
<method name="SetActualColor" type="" overloaded="no">
- <autodoc>SetActualColor(Colour clr)</autodoc>
+ <autodoc>SetActualColor(self, Colour clr)</autodoc>
<paramlist>
<param name="clr" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetLink" type="" overloaded="no">
- <autodoc>SetLink(String link)</autodoc>
+ <autodoc>SetLink(self, String link)</autodoc>
<paramlist>
<param name="link" type="String" default=""/>
</paramlist>
</method>
<method name="CreateCurrentFont" type="Font" overloaded="no">
- <autodoc>CreateCurrentFont() -> Font</autodoc>
+ <autodoc>CreateCurrentFont(self) -> Font</autodoc>
</method>
<method name="GetLink" type="HtmlLinkInfo" overloaded="no">
- <autodoc>GetLink() -> HtmlLinkInfo</autodoc>
+ <autodoc>GetLink(self) -> HtmlLinkInfo</autodoc>
</method>
</class>
<class name="HtmlTagHandler" oldname="wxPyHtmlTagHandler" module="html">
<baseclass name="Object"/>
<constructor name="wxPyHtmlTagHandler" overloaded="no">
- <autodoc>__init__() -> HtmlTagHandler</autodoc>
+ <autodoc>__init__(self) -> HtmlTagHandler</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetParser" type="" overloaded="no">
- <autodoc>SetParser(HtmlParser parser)</autodoc>
+ <autodoc>SetParser(self, HtmlParser parser)</autodoc>
<paramlist>
<param name="parser" type="HtmlParser" default=""/>
</paramlist>
</method>
<method name="GetParser" type="HtmlParser" overloaded="no">
- <autodoc>GetParser() -> HtmlParser</autodoc>
+ <autodoc>GetParser(self) -> HtmlParser</autodoc>
</method>
<method name="ParseInner" type="" overloaded="no">
- <autodoc>ParseInner(HtmlTag tag)</autodoc>
+ <autodoc>ParseInner(self, HtmlTag tag)</autodoc>
<paramlist>
<param name="tag" type="HtmlTag" default=""/>
</paramlist>
<class name="HtmlWinTagHandler" oldname="wxPyHtmlWinTagHandler" module="html">
<baseclass name="HtmlTagHandler"/>
<constructor name="wxPyHtmlWinTagHandler" overloaded="no">
- <autodoc>__init__() -> HtmlWinTagHandler</autodoc>
+ <autodoc>__init__(self) -> HtmlWinTagHandler</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetParser" type="" overloaded="no">
- <autodoc>SetParser(HtmlParser parser)</autodoc>
+ <autodoc>SetParser(self, HtmlParser parser)</autodoc>
<paramlist>
<param name="parser" type="HtmlParser" default=""/>
</paramlist>
</method>
<method name="GetParser" type="HtmlWinParser" overloaded="no">
- <autodoc>GetParser() -> HtmlWinParser</autodoc>
+ <autodoc>GetParser(self) -> HtmlWinParser</autodoc>
</method>
<method name="ParseInner" type="" overloaded="no">
- <autodoc>ParseInner(HtmlTag tag)</autodoc>
+ <autodoc>ParseInner(self, HtmlTag tag)</autodoc>
<paramlist>
<param name="tag" type="HtmlTag" default=""/>
</paramlist>
</pythoncode>
<class name="HtmlSelection" oldname="wxHtmlSelection" module="html">
<constructor name="HtmlSelection" overloaded="no">
- <autodoc>__init__() -> HtmlSelection</autodoc>
+ <autodoc>__init__(self) -> HtmlSelection</autodoc>
</constructor>
<destructor name="~wxHtmlSelection" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Set" type="" overloaded="no">
- <autodoc>Set(Point fromPos, HtmlCell fromCell, Point toPos, HtmlCell toCell)</autodoc>
+ <autodoc>Set(self, Point fromPos, HtmlCell fromCell, Point toPos, HtmlCell toCell)</autodoc>
<paramlist>
<param name="fromPos" type="Point" default=""/>
<param name="fromCell" type="wxHtmlCell" default=""/>
</paramlist>
</method>
<method name="SetCells" type="" overloaded="no">
- <autodoc>SetCells(HtmlCell fromCell, HtmlCell toCell)</autodoc>
+ <autodoc>SetCells(self, HtmlCell fromCell, HtmlCell toCell)</autodoc>
<paramlist>
<param name="fromCell" type="wxHtmlCell" default=""/>
<param name="toCell" type="wxHtmlCell" default=""/>
</paramlist>
</method>
<method name="GetFromCell" type="wxHtmlCell" overloaded="no">
- <autodoc>GetFromCell() -> HtmlCell</autodoc>
+ <autodoc>GetFromCell(self) -> HtmlCell</autodoc>
</method>
<method name="GetToCell" type="wxHtmlCell" overloaded="no">
- <autodoc>GetToCell() -> HtmlCell</autodoc>
+ <autodoc>GetToCell(self) -> HtmlCell</autodoc>
</method>
<method name="GetFromPos" type="Point" overloaded="no">
- <autodoc>GetFromPos() -> Point</autodoc>
+ <autodoc>GetFromPos(self) -> Point</autodoc>
</method>
<method name="GetToPos" type="Point" overloaded="no">
- <autodoc>GetToPos() -> Point</autodoc>
+ <autodoc>GetToPos(self) -> Point</autodoc>
</method>
<method name="GetFromPrivPos" type="Point" overloaded="no">
- <autodoc>GetFromPrivPos() -> Point</autodoc>
+ <autodoc>GetFromPrivPos(self) -> Point</autodoc>
</method>
<method name="GetToPrivPos" type="Point" overloaded="no">
- <autodoc>GetToPrivPos() -> Point</autodoc>
+ <autodoc>GetToPrivPos(self) -> Point</autodoc>
</method>
<method name="SetFromPrivPos" type="" overloaded="no">
- <autodoc>SetFromPrivPos(Point pos)</autodoc>
+ <autodoc>SetFromPrivPos(self, Point pos)</autodoc>
<paramlist>
<param name="pos" type="Point" default=""/>
</paramlist>
</method>
<method name="SetToPrivPos" type="" overloaded="no">
- <autodoc>SetToPrivPos(Point pos)</autodoc>
+ <autodoc>SetToPrivPos(self, Point pos)</autodoc>
<paramlist>
<param name="pos" type="Point" default=""/>
</paramlist>
</method>
<method name="ClearPrivPos" type="" overloaded="no">
- <autodoc>ClearPrivPos()</autodoc>
+ <autodoc>ClearPrivPos(self)</autodoc>
</method>
<method name="IsEmpty" type="bool" overloaded="no">
- <autodoc>IsEmpty() -> bool</autodoc>
+ <autodoc>IsEmpty(self) -> bool</autodoc>
</method>
</class>
<class name="HtmlRenderingState" oldname="wxHtmlRenderingState" module="html">
<constructor name="HtmlRenderingState" overloaded="no">
- <autodoc>__init__() -> HtmlRenderingState</autodoc>
+ <autodoc>__init__(self) -> HtmlRenderingState</autodoc>
</constructor>
<destructor name="~wxHtmlRenderingState" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetSelectionState" type="" overloaded="no">
- <autodoc>SetSelectionState(int s)</autodoc>
+ <autodoc>SetSelectionState(self, int s)</autodoc>
<paramlist>
<param name="s" type="wxHtmlSelectionState" default=""/>
</paramlist>
</method>
<method name="GetSelectionState" type="wxHtmlSelectionState" overloaded="no">
- <autodoc>GetSelectionState() -> int</autodoc>
+ <autodoc>GetSelectionState(self) -> int</autodoc>
</method>
<method name="SetFgColour" type="" overloaded="no">
- <autodoc>SetFgColour(Colour c)</autodoc>
+ <autodoc>SetFgColour(self, Colour c)</autodoc>
<paramlist>
<param name="c" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetFgColour" type="Colour" overloaded="no">
- <autodoc>GetFgColour() -> Colour</autodoc>
+ <autodoc>GetFgColour(self) -> Colour</autodoc>
</method>
<method name="SetBgColour" type="" overloaded="no">
- <autodoc>SetBgColour(Colour c)</autodoc>
+ <autodoc>SetBgColour(self, Colour c)</autodoc>
<paramlist>
<param name="c" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetBgColour" type="Colour" overloaded="no">
- <autodoc>GetBgColour() -> Colour</autodoc>
+ <autodoc>GetBgColour(self) -> Colour</autodoc>
</method>
</class>
<class name="HtmlRenderingStyle" oldname="wxHtmlRenderingStyle" module="html">
<method name="GetSelectedTextColour" type="Colour" overloaded="no">
- <autodoc>GetSelectedTextColour(Colour clr) -> Colour</autodoc>
+ <autodoc>GetSelectedTextColour(self, Colour clr) -> Colour</autodoc>
<paramlist>
<param name="clr" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetSelectedTextBgColour" type="Colour" overloaded="no">
- <autodoc>GetSelectedTextBgColour(Colour clr) -> Colour</autodoc>
+ <autodoc>GetSelectedTextBgColour(self, Colour clr) -> Colour</autodoc>
<paramlist>
<param name="clr" type="Colour" default=""/>
</paramlist>
<class name="DefaultHtmlRenderingStyle" oldname="wxDefaultHtmlRenderingStyle" module="html">
<baseclass name="HtmlRenderingStyle"/>
<method name="GetSelectedTextColour" type="Colour" overloaded="no">
- <autodoc>GetSelectedTextColour(Colour clr) -> Colour</autodoc>
+ <autodoc>GetSelectedTextColour(self, Colour clr) -> Colour</autodoc>
<paramlist>
<param name="clr" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetSelectedTextBgColour" type="Colour" overloaded="no">
- <autodoc>GetSelectedTextBgColour(Colour clr) -> Colour</autodoc>
+ <autodoc>GetSelectedTextBgColour(self, Colour clr) -> Colour</autodoc>
<paramlist>
<param name="clr" type="Colour" default=""/>
</paramlist>
</class>
<class name="HtmlRenderingInfo" oldname="wxHtmlRenderingInfo" module="html">
<constructor name="HtmlRenderingInfo" overloaded="no">
- <autodoc>__init__() -> HtmlRenderingInfo</autodoc>
+ <autodoc>__init__(self) -> HtmlRenderingInfo</autodoc>
</constructor>
<destructor name="~wxHtmlRenderingInfo" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(HtmlSelection s)</autodoc>
+ <autodoc>SetSelection(self, HtmlSelection s)</autodoc>
<paramlist>
<param name="s" type="HtmlSelection" default=""/>
</paramlist>
</method>
<method name="GetSelection" type="HtmlSelection" overloaded="no">
- <autodoc>GetSelection() -> HtmlSelection</autodoc>
+ <autodoc>GetSelection(self) -> HtmlSelection</autodoc>
</method>
<method name="SetStyle" type="" overloaded="no">
- <autodoc>SetStyle(HtmlRenderingStyle style)</autodoc>
+ <autodoc>SetStyle(self, HtmlRenderingStyle style)</autodoc>
<paramlist>
<param name="style" type="HtmlRenderingStyle" default=""/>
</paramlist>
</method>
<method name="GetStyle" type="HtmlRenderingStyle" overloaded="no">
- <autodoc>GetStyle() -> HtmlRenderingStyle</autodoc>
+ <autodoc>GetStyle(self) -> HtmlRenderingStyle</autodoc>
</method>
<method name="GetState" type="HtmlRenderingState" overloaded="no">
- <autodoc>GetState() -> HtmlRenderingState</autodoc>
+ <autodoc>GetState(self) -> HtmlRenderingState</autodoc>
</method>
</class>
<pythoncode>
<class name="HtmlCell" oldname="wxHtmlCell" module="html">
<baseclass name="Object"/>
<constructor name="HtmlCell" overloaded="no">
- <autodoc>__init__() -> HtmlCell</autodoc>
+ <autodoc>__init__(self) -> HtmlCell</autodoc>
</constructor>
<method name="GetPosX" type="int" overloaded="no">
- <autodoc>GetPosX() -> int</autodoc>
+ <autodoc>GetPosX(self) -> int</autodoc>
</method>
<method name="GetPosY" type="int" overloaded="no">
- <autodoc>GetPosY() -> int</autodoc>
+ <autodoc>GetPosY(self) -> int</autodoc>
</method>
<method name="GetWidth" type="int" overloaded="no">
- <autodoc>GetWidth() -> int</autodoc>
+ <autodoc>GetWidth(self) -> int</autodoc>
</method>
<method name="GetHeight" type="int" overloaded="no">
- <autodoc>GetHeight() -> int</autodoc>
+ <autodoc>GetHeight(self) -> int</autodoc>
</method>
<method name="GetDescent" type="int" overloaded="no">
- <autodoc>GetDescent() -> int</autodoc>
+ <autodoc>GetDescent(self) -> int</autodoc>
</method>
<method name="GetMaxTotalWidth" type="int" overloaded="no">
- <autodoc>GetMaxTotalWidth() -> int</autodoc>
+ <autodoc>GetMaxTotalWidth(self) -> int</autodoc>
</method>
<method name="GetId" type="String" overloaded="no">
- <autodoc>GetId() -> String</autodoc>
+ <autodoc>GetId(self) -> String</autodoc>
</method>
<method name="SetId" type="" overloaded="no">
- <autodoc>SetId(String id)</autodoc>
+ <autodoc>SetId(self, String id)</autodoc>
<paramlist>
<param name="id" type="String" default=""/>
</paramlist>
</method>
<method name="GetLink" type="HtmlLinkInfo" overloaded="no">
- <autodoc>GetLink(int x=0, int y=0) -> HtmlLinkInfo</autodoc>
+ <autodoc>GetLink(self, int x=0, int y=0) -> HtmlLinkInfo</autodoc>
<paramlist>
<param name="x" type="int" default="0"/>
<param name="y" type="int" default="0"/>
</paramlist>
</method>
<method name="GetNext" type="HtmlCell" overloaded="no">
- <autodoc>GetNext() -> HtmlCell</autodoc>
+ <autodoc>GetNext(self) -> HtmlCell</autodoc>
</method>
<method name="GetParent" type="wxHtmlContainerCell" overloaded="no">
- <autodoc>GetParent() -> HtmlContainerCell</autodoc>
+ <autodoc>GetParent(self) -> HtmlContainerCell</autodoc>
</method>
<method name="GetFirstChild" type="HtmlCell" overloaded="no">
- <autodoc>GetFirstChild() -> HtmlCell</autodoc>
+ <autodoc>GetFirstChild(self) -> HtmlCell</autodoc>
</method>
<method name="GetCursor" type="Cursor" overloaded="no">
- <autodoc>GetCursor() -> Cursor</autodoc>
+ <autodoc>GetCursor(self) -> Cursor</autodoc>
</method>
<method name="IsFormattingCell" type="bool" overloaded="no">
- <autodoc>IsFormattingCell() -> bool</autodoc>
+ <autodoc>IsFormattingCell(self) -> bool</autodoc>
</method>
<method name="SetLink" type="" overloaded="no">
- <autodoc>SetLink(HtmlLinkInfo link)</autodoc>
+ <autodoc>SetLink(self, HtmlLinkInfo link)</autodoc>
<paramlist>
<param name="link" type="HtmlLinkInfo" default=""/>
</paramlist>
</method>
<method name="SetNext" type="" overloaded="no">
- <autodoc>SetNext(HtmlCell cell)</autodoc>
+ <autodoc>SetNext(self, HtmlCell cell)</autodoc>
<paramlist>
<param name="cell" type="HtmlCell" default=""/>
</paramlist>
</method>
<method name="SetParent" type="" overloaded="no">
- <autodoc>SetParent(HtmlContainerCell p)</autodoc>
+ <autodoc>SetParent(self, HtmlContainerCell p)</autodoc>
<paramlist>
<param name="p" type="wxHtmlContainerCell" default=""/>
</paramlist>
</method>
<method name="SetPos" type="" overloaded="no">
- <autodoc>SetPos(int x, int y)</autodoc>
+ <autodoc>SetPos(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="Layout" type="" overloaded="no">
- <autodoc>Layout(int w)</autodoc>
+ <autodoc>Layout(self, int w)</autodoc>
<paramlist>
<param name="w" type="int" default=""/>
</paramlist>
</method>
<method name="Draw" type="" overloaded="no">
- <autodoc>Draw(DC dc, int x, int y, int view_y1, int view_y2, HtmlRenderingInfo info)</autodoc>
+ <autodoc>Draw(self, DC dc, int x, int y, int view_y1, int view_y2, HtmlRenderingInfo info)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="DrawInvisible" type="" overloaded="no">
- <autodoc>DrawInvisible(DC dc, int x, int y, HtmlRenderingInfo info)</autodoc>
+ <autodoc>DrawInvisible(self, DC dc, int x, int y, HtmlRenderingInfo info)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="Find" type="HtmlCell" overloaded="no">
- <autodoc>Find(int condition, void param) -> HtmlCell</autodoc>
+ <autodoc>Find(self, int condition, void param) -> HtmlCell</autodoc>
<paramlist>
<param name="condition" type="int" default=""/>
<param name="param" type="" default=""/>
</paramlist>
</method>
<method name="AdjustPagebreak" type="bool" overloaded="no">
- <autodoc>AdjustPagebreak(int INOUT) -> bool</autodoc>
+ <autodoc>AdjustPagebreak(self, int INOUT) -> bool</autodoc>
<paramlist>
<param name="INOUT" type="int" default=""/>
</paramlist>
</method>
<method name="SetCanLiveOnPagebreak" type="" overloaded="no">
- <autodoc>SetCanLiveOnPagebreak(bool can)</autodoc>
+ <autodoc>SetCanLiveOnPagebreak(self, bool can)</autodoc>
<paramlist>
<param name="can" type="bool" default=""/>
</paramlist>
</method>
<method name="IsLinebreakAllowed" type="bool" overloaded="no">
- <autodoc>IsLinebreakAllowed() -> bool</autodoc>
+ <autodoc>IsLinebreakAllowed(self) -> bool</autodoc>
</method>
<method name="IsTerminalCell" type="bool" overloaded="no">
- <autodoc>IsTerminalCell() -> bool</autodoc>
+ <autodoc>IsTerminalCell(self) -> bool</autodoc>
</method>
<method name="FindCellByPos" type="HtmlCell" overloaded="no">
- <autodoc>FindCellByPos(int x, int y, unsigned int flags=HTML_FIND_EXACT) -> HtmlCell</autodoc>
+ <autodoc>FindCellByPos(self, int x, int y, unsigned int flags=HTML_FIND_EXACT) -> HtmlCell</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="GetAbsPos" type="Point" overloaded="no">
- <autodoc>GetAbsPos() -> Point</autodoc>
+ <autodoc>GetAbsPos(self) -> Point</autodoc>
</method>
<method name="GetFirstTerminal" type="HtmlCell" overloaded="no">
- <autodoc>GetFirstTerminal() -> HtmlCell</autodoc>
+ <autodoc>GetFirstTerminal(self) -> HtmlCell</autodoc>
</method>
<method name="GetLastTerminal" type="HtmlCell" overloaded="no">
- <autodoc>GetLastTerminal() -> HtmlCell</autodoc>
+ <autodoc>GetLastTerminal(self) -> HtmlCell</autodoc>
</method>
<method name="GetDepth" type="unsigned int" overloaded="no">
- <autodoc>GetDepth() -> unsigned int</autodoc>
+ <autodoc>GetDepth(self) -> unsigned int</autodoc>
</method>
<method name="IsBefore" type="bool" overloaded="no">
- <autodoc>IsBefore(HtmlCell cell) -> bool</autodoc>
+ <autodoc>IsBefore(self, HtmlCell cell) -> bool</autodoc>
<paramlist>
<param name="cell" type="HtmlCell" default=""/>
</paramlist>
</method>
<method name="ConvertToText" type="String" overloaded="no">
- <autodoc>ConvertToText(HtmlSelection sel) -> String</autodoc>
+ <autodoc>ConvertToText(self, HtmlSelection sel) -> String</autodoc>
<paramlist>
<param name="sel" type="HtmlSelection" default=""/>
</paramlist>
<class name="HtmlWordCell" oldname="wxHtmlWordCell" module="html">
<baseclass name="HtmlCell"/>
<constructor name="HtmlWordCell" overloaded="no">
- <autodoc>__init__(String word, DC dc) -> HtmlWordCell</autodoc>
+ <autodoc>__init__(self, String word, DC dc) -> HtmlWordCell</autodoc>
<paramlist>
<param name="word" type="String" default=""/>
<param name="dc" type="DC" default=""/>
<class name="HtmlContainerCell" oldname="wxHtmlContainerCell" module="html">
<baseclass name="HtmlCell"/>
<constructor name="HtmlContainerCell" overloaded="no">
- <autodoc>__init__(HtmlContainerCell parent) -> HtmlContainerCell</autodoc>
+ <autodoc>__init__(self, HtmlContainerCell parent) -> HtmlContainerCell</autodoc>
<paramlist>
<param name="parent" type="HtmlContainerCell" default=""/>
</paramlist>
</constructor>
<method name="InsertCell" type="" overloaded="no">
- <autodoc>InsertCell(HtmlCell cell)</autodoc>
+ <autodoc>InsertCell(self, HtmlCell cell)</autodoc>
<paramlist>
<param name="cell" type="HtmlCell" default=""/>
</paramlist>
</method>
<method name="SetAlignHor" type="" overloaded="no">
- <autodoc>SetAlignHor(int al)</autodoc>
+ <autodoc>SetAlignHor(self, int al)</autodoc>
<paramlist>
<param name="al" type="int" default=""/>
</paramlist>
</method>
<method name="GetAlignHor" type="int" overloaded="no">
- <autodoc>GetAlignHor() -> int</autodoc>
+ <autodoc>GetAlignHor(self) -> int</autodoc>
</method>
<method name="SetAlignVer" type="" overloaded="no">
- <autodoc>SetAlignVer(int al)</autodoc>
+ <autodoc>SetAlignVer(self, int al)</autodoc>
<paramlist>
<param name="al" type="int" default=""/>
</paramlist>
</method>
<method name="GetAlignVer" type="int" overloaded="no">
- <autodoc>GetAlignVer() -> int</autodoc>
+ <autodoc>GetAlignVer(self) -> int</autodoc>
</method>
<method name="SetIndent" type="" overloaded="no">
- <autodoc>SetIndent(int i, int what, int units=HTML_UNITS_PIXELS)</autodoc>
+ <autodoc>SetIndent(self, int i, int what, int units=HTML_UNITS_PIXELS)</autodoc>
<paramlist>
<param name="i" type="int" default=""/>
<param name="what" type="int" default=""/>
</paramlist>
</method>
<method name="GetIndent" type="int" overloaded="no">
- <autodoc>GetIndent(int ind) -> int</autodoc>
+ <autodoc>GetIndent(self, int ind) -> int</autodoc>
<paramlist>
<param name="ind" type="int" default=""/>
</paramlist>
</method>
<method name="GetIndentUnits" type="int" overloaded="no">
- <autodoc>GetIndentUnits(int ind) -> int</autodoc>
+ <autodoc>GetIndentUnits(self, int ind) -> int</autodoc>
<paramlist>
<param name="ind" type="int" default=""/>
</paramlist>
</method>
<method name="SetAlign" type="" overloaded="no">
- <autodoc>SetAlign(HtmlTag tag)</autodoc>
+ <autodoc>SetAlign(self, HtmlTag tag)</autodoc>
<paramlist>
<param name="tag" type="HtmlTag" default=""/>
</paramlist>
</method>
<method name="SetWidthFloat" type="" overloaded="no">
- <autodoc>SetWidthFloat(int w, int units)</autodoc>
+ <autodoc>SetWidthFloat(self, int w, int units)</autodoc>
<paramlist>
<param name="w" type="int" default=""/>
<param name="units" type="int" default=""/>
</paramlist>
</method>
<method name="SetWidthFloatFromTag" type="" overloaded="no">
- <autodoc>SetWidthFloatFromTag(HtmlTag tag)</autodoc>
+ <autodoc>SetWidthFloatFromTag(self, HtmlTag tag)</autodoc>
<paramlist>
<param name="tag" type="HtmlTag" default=""/>
</paramlist>
</method>
<method name="SetMinHeight" type="" overloaded="no">
- <autodoc>SetMinHeight(int h, int align=HTML_ALIGN_TOP)</autodoc>
+ <autodoc>SetMinHeight(self, int h, int align=HTML_ALIGN_TOP)</autodoc>
<paramlist>
<param name="h" type="int" default=""/>
<param name="align" type="int" default="wxHTML_ALIGN_TOP"/>
</paramlist>
</method>
<method name="SetBackgroundColour" type="" overloaded="no">
- <autodoc>SetBackgroundColour(Colour clr)</autodoc>
+ <autodoc>SetBackgroundColour(self, Colour clr)</autodoc>
<paramlist>
<param name="clr" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetBackgroundColour() -> Colour</autodoc>
+ <autodoc>GetBackgroundColour(self) -> Colour</autodoc>
</method>
<method name="SetBorder" type="" overloaded="no">
- <autodoc>SetBorder(Colour clr1, Colour clr2)</autodoc>
+ <autodoc>SetBorder(self, Colour clr1, Colour clr2)</autodoc>
<paramlist>
<param name="clr1" type="Colour" default=""/>
<param name="clr2" type="Colour" default=""/>
</paramlist>
</method>
<method name="GetFirstChild" type="HtmlCell" overloaded="no">
- <autodoc>GetFirstChild() -> HtmlCell</autodoc>
+ <autodoc>GetFirstChild(self) -> HtmlCell</autodoc>
</method>
</class>
<class name="HtmlColourCell" oldname="wxHtmlColourCell" module="html">
<baseclass name="HtmlCell"/>
<constructor name="HtmlColourCell" overloaded="no">
- <autodoc>__init__(Colour clr, int flags=HTML_CLR_FOREGROUND) -> HtmlColourCell</autodoc>
+ <autodoc>__init__(self, Colour clr, int flags=HTML_CLR_FOREGROUND) -> HtmlColourCell</autodoc>
<paramlist>
<param name="clr" type="Colour" default=""/>
<param name="flags" type="int" default="wxHTML_CLR_FOREGROUND"/>
<class name="HtmlFontCell" oldname="wxHtmlFontCell" module="html">
<baseclass name="HtmlCell"/>
<constructor name="HtmlFontCell" overloaded="no">
- <autodoc>__init__(Font font) -> HtmlFontCell</autodoc>
+ <autodoc>__init__(self, Font font) -> HtmlFontCell</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
<class name="HtmlWidgetCell" oldname="wxHtmlWidgetCell" module="html">
<baseclass name="HtmlCell"/>
<constructor name="HtmlWidgetCell" overloaded="no">
- <autodoc>__init__(Window wnd, int w=0) -> HtmlWidgetCell</autodoc>
+ <autodoc>__init__(self, Window wnd, int w=0) -> HtmlWidgetCell</autodoc>
<paramlist>
<param name="wnd" type="Window" default=""/>
<param name="w" type="int" default="0"/>
<class name="HtmlFilter" oldname="wxPyHtmlFilter" module="html">
<baseclass name="Object"/>
<constructor name="wxPyHtmlFilter" overloaded="no">
- <autodoc>__init__() -> HtmlFilter</autodoc>
+ <autodoc>__init__(self) -> HtmlFilter</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
<class name="HtmlWindow" oldname="wxPyHtmlWindow" module="html">
<baseclass name="ScrolledWindow"/>
<constructor name="wxPyHtmlWindow" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, int style=HW_DEFAULT_STYLE,
String name=HtmlWindowNameStr) -> HtmlWindow</autodoc>
<paramlist>
<autodoc>PreHtmlWindow() -> HtmlWindow</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, int style=HW_SCROLLBAR_AUTO,
String name=HtmlWindowNameStr) -> bool</autodoc>
<paramlist>
</paramlist>
</method>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetPage" type="bool" overloaded="no">
- <autodoc>SetPage(String source) -> bool</autodoc>
+ <autodoc>SetPage(self, String source) -> bool</autodoc>
<paramlist>
<param name="source" type="String" default=""/>
</paramlist>
</method>
<method name="LoadPage" type="bool" overloaded="no">
- <autodoc>LoadPage(String location) -> bool</autodoc>
+ <autodoc>LoadPage(self, String location) -> bool</autodoc>
<paramlist>
<param name="location" type="String" default=""/>
</paramlist>
</method>
<method name="LoadFile" type="bool" overloaded="no">
- <autodoc>LoadFile(String filename) -> bool</autodoc>
+ <autodoc>LoadFile(self, String filename) -> bool</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
</paramlist>
</method>
<method name="AppendToPage" type="bool" overloaded="no">
- <autodoc>AppendToPage(String source) -> bool</autodoc>
+ <autodoc>AppendToPage(self, String source) -> bool</autodoc>
<paramlist>
<param name="source" type="String" default=""/>
</paramlist>
</method>
<method name="GetOpenedPage" type="String" overloaded="no">
- <autodoc>GetOpenedPage() -> String</autodoc>
+ <autodoc>GetOpenedPage(self) -> String</autodoc>
</method>
<method name="GetOpenedAnchor" type="String" overloaded="no">
- <autodoc>GetOpenedAnchor() -> String</autodoc>
+ <autodoc>GetOpenedAnchor(self) -> String</autodoc>
</method>
<method name="GetOpenedPageTitle" type="String" overloaded="no">
- <autodoc>GetOpenedPageTitle() -> String</autodoc>
+ <autodoc>GetOpenedPageTitle(self) -> String</autodoc>
</method>
<method name="SetRelatedFrame" type="" overloaded="no">
- <autodoc>SetRelatedFrame(Frame frame, String format)</autodoc>
+ <autodoc>SetRelatedFrame(self, Frame frame, String format)</autodoc>
<paramlist>
<param name="frame" type="Frame" default=""/>
<param name="format" type="String" default=""/>
</paramlist>
</method>
<method name="GetRelatedFrame" type="Frame" overloaded="no">
- <autodoc>GetRelatedFrame() -> Frame</autodoc>
+ <autodoc>GetRelatedFrame(self) -> Frame</autodoc>
</method>
<method name="SetRelatedStatusBar" type="" overloaded="no">
- <autodoc>SetRelatedStatusBar(int bar)</autodoc>
+ <autodoc>SetRelatedStatusBar(self, int bar)</autodoc>
<paramlist>
<param name="bar" type="int" default=""/>
</paramlist>
</method>
<method name="SetFonts" type="" overloaded="no">
- <autodoc>SetFonts(String normal_face, String fixed_face, PyObject sizes=None)</autodoc>
+ <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)</autodoc>
<paramlist>
<param name="normal_face" type="String" default=""/>
<param name="fixed_face" type="String" default=""/>
</paramlist>
</method>
<method name="SetTitle" type="" overloaded="no">
- <autodoc>SetTitle(String title)</autodoc>
+ <autodoc>SetTitle(self, String title)</autodoc>
<paramlist>
<param name="title" type="String" default=""/>
</paramlist>
</method>
<method name="SetBorders" type="" overloaded="no">
- <autodoc>SetBorders(int b)</autodoc>
+ <autodoc>SetBorders(self, int b)</autodoc>
<paramlist>
<param name="b" type="int" default=""/>
</paramlist>
</method>
<method name="ReadCustomization" type="" overloaded="no">
- <autodoc>ReadCustomization(ConfigBase cfg, String path=EmptyString)</autodoc>
+ <autodoc>ReadCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc>
<paramlist>
<param name="cfg" type="ConfigBase" default=""/>
<param name="path" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="WriteCustomization" type="" overloaded="no">
- <autodoc>WriteCustomization(ConfigBase cfg, String path=EmptyString)</autodoc>
+ <autodoc>WriteCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc>
<paramlist>
<param name="cfg" type="ConfigBase" default=""/>
<param name="path" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="HistoryBack" type="bool" overloaded="no">
- <autodoc>HistoryBack() -> bool</autodoc>
+ <autodoc>HistoryBack(self) -> bool</autodoc>
</method>
<method name="HistoryForward" type="bool" overloaded="no">
- <autodoc>HistoryForward() -> bool</autodoc>
+ <autodoc>HistoryForward(self) -> bool</autodoc>
</method>
<method name="HistoryCanBack" type="bool" overloaded="no">
- <autodoc>HistoryCanBack() -> bool</autodoc>
+ <autodoc>HistoryCanBack(self) -> bool</autodoc>
</method>
<method name="HistoryCanForward" type="bool" overloaded="no">
- <autodoc>HistoryCanForward() -> bool</autodoc>
+ <autodoc>HistoryCanForward(self) -> bool</autodoc>
</method>
<method name="HistoryClear" type="" overloaded="no">
- <autodoc>HistoryClear()</autodoc>
+ <autodoc>HistoryClear(self)</autodoc>
</method>
<method name="GetInternalRepresentation" type="HtmlContainerCell" overloaded="no">
- <autodoc>GetInternalRepresentation() -> HtmlContainerCell</autodoc>
+ <autodoc>GetInternalRepresentation(self) -> HtmlContainerCell</autodoc>
</method>
<method name="GetParser" type="HtmlWinParser" overloaded="no">
- <autodoc>GetParser() -> HtmlWinParser</autodoc>
+ <autodoc>GetParser(self) -> HtmlWinParser</autodoc>
</method>
<method name="ScrollToAnchor" type="bool" overloaded="no">
- <autodoc>ScrollToAnchor(String anchor) -> bool</autodoc>
+ <autodoc>ScrollToAnchor(self, String anchor) -> bool</autodoc>
<paramlist>
<param name="anchor" type="String" default=""/>
</paramlist>
</method>
<method name="HasAnchor" type="bool" overloaded="no">
- <autodoc>HasAnchor(String anchor) -> bool</autodoc>
+ <autodoc>HasAnchor(self, String anchor) -> bool</autodoc>
<paramlist>
<param name="anchor" type="String" default=""/>
</paramlist>
</paramlist>
</staticmethod>
<method name="SelectWord" type="" overloaded="no">
- <autodoc>SelectWord(Point pos)</autodoc>
+ <autodoc>SelectWord(self, Point pos)</autodoc>
<paramlist>
<param name="pos" type="Point" default=""/>
</paramlist>
</method>
<method name="SelectLine" type="" overloaded="no">
- <autodoc>SelectLine(Point pos)</autodoc>
+ <autodoc>SelectLine(self, Point pos)</autodoc>
<paramlist>
<param name="pos" type="Point" default=""/>
</paramlist>
</method>
<method name="SelectAll" type="" overloaded="no">
- <autodoc>SelectAll()</autodoc>
+ <autodoc>SelectAll(self)</autodoc>
</method>
<method name="base_OnLinkClicked" type="" overloaded="no">
- <autodoc>base_OnLinkClicked(HtmlLinkInfo link)</autodoc>
+ <autodoc>base_OnLinkClicked(self, HtmlLinkInfo link)</autodoc>
<paramlist>
<param name="link" type="HtmlLinkInfo" default=""/>
</paramlist>
</method>
<method name="base_OnSetTitle" type="" overloaded="no">
- <autodoc>base_OnSetTitle(String title)</autodoc>
+ <autodoc>base_OnSetTitle(self, String title)</autodoc>
<paramlist>
<param name="title" type="String" default=""/>
</paramlist>
</method>
<method name="base_OnCellMouseHover" type="" overloaded="no">
- <autodoc>base_OnCellMouseHover(HtmlCell cell, int x, int y)</autodoc>
+ <autodoc>base_OnCellMouseHover(self, HtmlCell cell, int x, int y)</autodoc>
<paramlist>
<param name="cell" type="HtmlCell" default=""/>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="base_OnCellClicked" type="" overloaded="no">
- <autodoc>base_OnCellClicked(HtmlCell cell, int x, int y, MouseEvent event)</autodoc>
+ <autodoc>base_OnCellClicked(self, HtmlCell cell, int x, int y, MouseEvent event)</autodoc>
<paramlist>
<param name="cell" type="HtmlCell" default=""/>
<param name="x" type="int" default=""/>
<param name="event" type="MouseEvent" default=""/>
</paramlist>
</method>
+ <staticmethod name="GetClassDefaultAttributes" type="VisualAttributes" overloaded="no">
+ <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes</autodoc>
+ <docstring>Get the default attributes for this class. This is useful if you want
+to use the same font or colour in your own control as in a standard
+control -- which is a much better idea than hard coding specific
+colours or fonts which might look completely out of place on the
+user's system, especially if it uses themes.
+
+The variant parameter is only relevant under Mac currently and is
+ignore under other platforms. Under Mac, it will change the size of
+the returned font. See `wx.Window.SetWindowVariant` for more about
+this.</docstring>
+ <paramlist>
+ <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/>
+ </paramlist>
+ </staticmethod>
</class>
<pythoncode>
#---------------------------------------------------------------------------
<class name="HtmlDCRenderer" oldname="wxHtmlDCRenderer" module="html">
<baseclass name="Object"/>
<constructor name="HtmlDCRenderer" overloaded="no">
- <autodoc>__init__() -> HtmlDCRenderer</autodoc>
+ <autodoc>__init__(self) -> HtmlDCRenderer</autodoc>
</constructor>
<destructor name="~wxHtmlDCRenderer" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetDC" type="" overloaded="no">
- <autodoc>SetDC(DC dc, int maxwidth)</autodoc>
+ <autodoc>SetDC(self, DC dc, int maxwidth)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="maxwidth" type="int" default=""/>
</paramlist>
</method>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(int width, int height)</autodoc>
+ <autodoc>SetSize(self, int width, int height)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="SetHtmlText" type="" overloaded="no">
- <autodoc>SetHtmlText(String html, String basepath=EmptyString, bool isdir=True)</autodoc>
+ <autodoc>SetHtmlText(self, String html, String basepath=EmptyString, bool isdir=True)</autodoc>
<paramlist>
<param name="html" type="String" default=""/>
<param name="basepath" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="SetFonts" type="" overloaded="no">
- <autodoc>SetFonts(String normal_face, String fixed_face, PyObject sizes=None)</autodoc>
+ <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)</autodoc>
<paramlist>
<param name="normal_face" type="String" default=""/>
<param name="fixed_face" type="String" default=""/>
</paramlist>
</method>
<method name="Render" type="int" overloaded="no">
- <autodoc>Render(int x, int y, int from=0, int dont_render=False, int to=INT_MAX,
+ <autodoc>Render(self, int x, int y, int from=0, int dont_render=False, int to=INT_MAX,
int choices=None, int LCOUNT=0) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
</paramlist>
</method>
<method name="GetTotalHeight" type="int" overloaded="no">
- <autodoc>GetTotalHeight() -> int</autodoc>
+ <autodoc>GetTotalHeight(self) -> int</autodoc>
</method>
</class>
<class name="HtmlPrintout" oldname="wxHtmlPrintout" module="html">
<baseclass name="Printout"/>
<constructor name="HtmlPrintout" overloaded="no">
- <autodoc>__init__(String title=HtmlPrintoutTitleStr) -> HtmlPrintout</autodoc>
+ <autodoc>__init__(self, String title=HtmlPrintoutTitleStr) -> HtmlPrintout</autodoc>
<paramlist>
<param name="title" type="String" default="wxPyHtmlPrintoutTitleStr"/>
</paramlist>
</constructor>
<method name="SetHtmlText" type="" overloaded="no">
- <autodoc>SetHtmlText(String html, String basepath=EmptyString, bool isdir=True)</autodoc>
+ <autodoc>SetHtmlText(self, String html, String basepath=EmptyString, bool isdir=True)</autodoc>
<paramlist>
<param name="html" type="String" default=""/>
<param name="basepath" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="SetHtmlFile" type="" overloaded="no">
- <autodoc>SetHtmlFile(String htmlfile)</autodoc>
+ <autodoc>SetHtmlFile(self, String htmlfile)</autodoc>
<paramlist>
<param name="htmlfile" type="String" default=""/>
</paramlist>
</method>
<method name="SetHeader" type="" overloaded="no">
- <autodoc>SetHeader(String header, int pg=PAGE_ALL)</autodoc>
+ <autodoc>SetHeader(self, String header, int pg=PAGE_ALL)</autodoc>
<paramlist>
<param name="header" type="String" default=""/>
<param name="pg" type="int" default="wxPAGE_ALL"/>
</paramlist>
</method>
<method name="SetFooter" type="" overloaded="no">
- <autodoc>SetFooter(String footer, int pg=PAGE_ALL)</autodoc>
+ <autodoc>SetFooter(self, String footer, int pg=PAGE_ALL)</autodoc>
<paramlist>
<param name="footer" type="String" default=""/>
<param name="pg" type="int" default="wxPAGE_ALL"/>
</paramlist>
</method>
<method name="SetFonts" type="" overloaded="no">
- <autodoc>SetFonts(String normal_face, String fixed_face, PyObject sizes=None)</autodoc>
+ <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)</autodoc>
<paramlist>
<param name="normal_face" type="String" default=""/>
<param name="fixed_face" type="String" default=""/>
</paramlist>
</method>
<method name="SetMargins" type="" overloaded="no">
- <autodoc>SetMargins(float top=25.2, float bottom=25.2, float left=25.2,
+ <autodoc>SetMargins(self, float top=25.2, float bottom=25.2, float left=25.2,
float right=25.2, float spaces=5)</autodoc>
<paramlist>
<param name="top" type="float" default="25.2"/>
<class name="HtmlEasyPrinting" oldname="wxHtmlEasyPrinting" module="html">
<baseclass name="Object"/>
<constructor name="HtmlEasyPrinting" overloaded="no">
- <autodoc>__init__(String name=HtmlPrintingTitleStr, Window parentWindow=None) -> HtmlEasyPrinting</autodoc>
+ <autodoc>__init__(self, String name=HtmlPrintingTitleStr, Window parentWindow=None) -> HtmlEasyPrinting</autodoc>
<paramlist>
<param name="name" type="String" default="wxPyHtmlPrintingTitleStr"/>
<param name="parentWindow" type="Window" default="NULL"/>
</paramlist>
</constructor>
<destructor name="~wxHtmlEasyPrinting" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="PreviewFile" type="" overloaded="no">
- <autodoc>PreviewFile(String htmlfile)</autodoc>
+ <autodoc>PreviewFile(self, String htmlfile)</autodoc>
<paramlist>
<param name="htmlfile" type="String" default=""/>
</paramlist>
</method>
<method name="PreviewText" type="" overloaded="no">
- <autodoc>PreviewText(String htmltext, String basepath=EmptyString)</autodoc>
+ <autodoc>PreviewText(self, String htmltext, String basepath=EmptyString)</autodoc>
<paramlist>
<param name="htmltext" type="String" default=""/>
<param name="basepath" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="PrintFile" type="" overloaded="no">
- <autodoc>PrintFile(String htmlfile)</autodoc>
+ <autodoc>PrintFile(self, String htmlfile)</autodoc>
<paramlist>
<param name="htmlfile" type="String" default=""/>
</paramlist>
</method>
<method name="PrintText" type="" overloaded="no">
- <autodoc>PrintText(String htmltext, String basepath=EmptyString)</autodoc>
+ <autodoc>PrintText(self, String htmltext, String basepath=EmptyString)</autodoc>
<paramlist>
<param name="htmltext" type="String" default=""/>
<param name="basepath" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="PrinterSetup" type="" overloaded="no">
- <autodoc>PrinterSetup()</autodoc>
+ <autodoc>PrinterSetup(self)</autodoc>
</method>
<method name="PageSetup" type="" overloaded="no">
- <autodoc>PageSetup()</autodoc>
+ <autodoc>PageSetup(self)</autodoc>
</method>
<method name="SetHeader" type="" overloaded="no">
- <autodoc>SetHeader(String header, int pg=PAGE_ALL)</autodoc>
+ <autodoc>SetHeader(self, String header, int pg=PAGE_ALL)</autodoc>
<paramlist>
<param name="header" type="String" default=""/>
<param name="pg" type="int" default="wxPAGE_ALL"/>
</paramlist>
</method>
<method name="SetFooter" type="" overloaded="no">
- <autodoc>SetFooter(String footer, int pg=PAGE_ALL)</autodoc>
+ <autodoc>SetFooter(self, String footer, int pg=PAGE_ALL)</autodoc>
<paramlist>
<param name="footer" type="String" default=""/>
<param name="pg" type="int" default="wxPAGE_ALL"/>
</paramlist>
</method>
<method name="SetFonts" type="" overloaded="no">
- <autodoc>SetFonts(String normal_face, String fixed_face, PyObject sizes=None)</autodoc>
+ <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)</autodoc>
<paramlist>
<param name="normal_face" type="String" default=""/>
<param name="fixed_face" type="String" default=""/>
</paramlist>
</method>
<method name="GetPrintData" type="PrintData" overloaded="no">
- <autodoc>GetPrintData() -> PrintData</autodoc>
+ <autodoc>GetPrintData(self) -> PrintData</autodoc>
</method>
<method name="GetPageSetupData" type="PageSetupDialogData" overloaded="no">
- <autodoc>GetPageSetupData() -> PageSetupDialogData</autodoc>
+ <autodoc>GetPageSetupData(self) -> PageSetupDialogData</autodoc>
</method>
</class>
<pythoncode>
</pythoncode>
<class name="HtmlBookRecord" oldname="wxHtmlBookRecord" module="html">
<constructor name="HtmlBookRecord" overloaded="no">
- <autodoc>__init__(String bookfile, String basepath, String title, String start) -> HtmlBookRecord</autodoc>
+ <autodoc>__init__(self, String bookfile, String basepath, String title, String start) -> HtmlBookRecord</autodoc>
<paramlist>
<param name="bookfile" type="String" default=""/>
<param name="basepath" type="String" default=""/>
</paramlist>
</constructor>
<method name="GetBookFile" type="String" overloaded="no">
- <autodoc>GetBookFile() -> String</autodoc>
+ <autodoc>GetBookFile(self) -> String</autodoc>
</method>
<method name="GetTitle" type="String" overloaded="no">
- <autodoc>GetTitle() -> String</autodoc>
+ <autodoc>GetTitle(self) -> String</autodoc>
</method>
<method name="GetStart" type="String" overloaded="no">
- <autodoc>GetStart() -> String</autodoc>
+ <autodoc>GetStart(self) -> String</autodoc>
</method>
<method name="GetBasePath" type="String" overloaded="no">
- <autodoc>GetBasePath() -> String</autodoc>
+ <autodoc>GetBasePath(self) -> String</autodoc>
</method>
<method name="SetContentsRange" type="" overloaded="no">
- <autodoc>SetContentsRange(int start, int end)</autodoc>
+ <autodoc>SetContentsRange(self, int start, int end)</autodoc>
<paramlist>
<param name="start" type="int" default=""/>
<param name="end" type="int" default=""/>
</paramlist>
</method>
<method name="GetContentsStart" type="int" overloaded="no">
- <autodoc>GetContentsStart() -> int</autodoc>
+ <autodoc>GetContentsStart(self) -> int</autodoc>
</method>
<method name="GetContentsEnd" type="int" overloaded="no">
- <autodoc>GetContentsEnd() -> int</autodoc>
+ <autodoc>GetContentsEnd(self) -> int</autodoc>
</method>
<method name="SetTitle" type="" overloaded="no">
- <autodoc>SetTitle(String title)</autodoc>
+ <autodoc>SetTitle(self, String title)</autodoc>
<paramlist>
<param name="title" type="String" default=""/>
</paramlist>
</method>
<method name="SetBasePath" type="" overloaded="no">
- <autodoc>SetBasePath(String path)</autodoc>
+ <autodoc>SetBasePath(self, String path)</autodoc>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="SetStart" type="" overloaded="no">
- <autodoc>SetStart(String start)</autodoc>
+ <autodoc>SetStart(self, String start)</autodoc>
<paramlist>
<param name="start" type="String" default=""/>
</paramlist>
</method>
<method name="GetFullPath" type="String" overloaded="no">
- <autodoc>GetFullPath(String page) -> String</autodoc>
+ <autodoc>GetFullPath(self, String page) -> String</autodoc>
<paramlist>
<param name="page" type="String" default=""/>
</paramlist>
</class>
<class name="HtmlContentsItem" oldname="wxHtmlContentsItem" module="html">
<method name="GetLevel" type="int" overloaded="no">
- <autodoc>GetLevel() -> int</autodoc>
+ <autodoc>GetLevel(self) -> int</autodoc>
</method>
<method name="GetID" type="int" overloaded="no">
- <autodoc>GetID() -> int</autodoc>
+ <autodoc>GetID(self) -> int</autodoc>
</method>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
+ <autodoc>GetName(self) -> String</autodoc>
</method>
<method name="GetPage" type="String" overloaded="no">
- <autodoc>GetPage() -> String</autodoc>
+ <autodoc>GetPage(self) -> String</autodoc>
</method>
<method name="GetBook" type="HtmlBookRecord" overloaded="no">
- <autodoc>GetBook() -> HtmlBookRecord</autodoc>
+ <autodoc>GetBook(self) -> HtmlBookRecord</autodoc>
</method>
</class>
<class name="HtmlSearchStatus" oldname="wxHtmlSearchStatus" module="html">
<method name="Search" type="bool" overloaded="no">
- <autodoc>Search() -> bool</autodoc>
+ <autodoc>Search(self) -> bool</autodoc>
</method>
<method name="IsActive" type="bool" overloaded="no">
- <autodoc>IsActive() -> bool</autodoc>
+ <autodoc>IsActive(self) -> bool</autodoc>
</method>
<method name="GetCurIndex" type="int" overloaded="no">
- <autodoc>GetCurIndex() -> int</autodoc>
+ <autodoc>GetCurIndex(self) -> int</autodoc>
</method>
<method name="GetMaxIndex" type="int" overloaded="no">
- <autodoc>GetMaxIndex() -> int</autodoc>
+ <autodoc>GetMaxIndex(self) -> int</autodoc>
</method>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
+ <autodoc>GetName(self) -> String</autodoc>
</method>
<method name="GetContentsItem" type="HtmlContentsItem" overloaded="no">
- <autodoc>GetContentsItem() -> HtmlContentsItem</autodoc>
+ <autodoc>GetContentsItem(self) -> HtmlContentsItem</autodoc>
</method>
</class>
<class name="HtmlHelpData" oldname="wxHtmlHelpData" module="html">
<constructor name="HtmlHelpData" overloaded="no">
- <autodoc>__init__() -> HtmlHelpData</autodoc>
+ <autodoc>__init__(self) -> HtmlHelpData</autodoc>
</constructor>
<destructor name="~wxHtmlHelpData" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetTempDir" type="" overloaded="no">
- <autodoc>SetTempDir(String path)</autodoc>
+ <autodoc>SetTempDir(self, String path)</autodoc>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="AddBook" type="bool" overloaded="no">
- <autodoc>AddBook(String book) -> bool</autodoc>
+ <autodoc>AddBook(self, String book) -> bool</autodoc>
<paramlist>
<param name="book" type="String" default=""/>
</paramlist>
</method>
<method name="FindPageByName" type="String" overloaded="no">
- <autodoc>FindPageByName(String page) -> String</autodoc>
+ <autodoc>FindPageByName(self, String page) -> String</autodoc>
<paramlist>
<param name="page" type="String" default=""/>
</paramlist>
</method>
<method name="FindPageById" type="String" overloaded="no">
- <autodoc>FindPageById(int id) -> String</autodoc>
+ <autodoc>FindPageById(self, int id) -> String</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="GetBookRecArray" type="wxHtmlBookRecArray" overloaded="no">
- <autodoc>GetBookRecArray() -> wxHtmlBookRecArray</autodoc>
+ <autodoc>GetBookRecArray(self) -> wxHtmlBookRecArray</autodoc>
</method>
<method name="GetContents" type="HtmlContentsItem" overloaded="no">
- <autodoc>GetContents() -> HtmlContentsItem</autodoc>
+ <autodoc>GetContents(self) -> HtmlContentsItem</autodoc>
</method>
<method name="GetContentsCnt" type="int" overloaded="no">
- <autodoc>GetContentsCnt() -> int</autodoc>
+ <autodoc>GetContentsCnt(self) -> int</autodoc>
</method>
<method name="GetIndex" type="HtmlContentsItem" overloaded="no">
- <autodoc>GetIndex() -> HtmlContentsItem</autodoc>
+ <autodoc>GetIndex(self) -> HtmlContentsItem</autodoc>
</method>
<method name="GetIndexCnt" type="int" overloaded="no">
- <autodoc>GetIndexCnt() -> int</autodoc>
+ <autodoc>GetIndexCnt(self) -> int</autodoc>
</method>
</class>
<class name="HtmlHelpFrame" oldname="wxHtmlHelpFrame" module="html">
<baseclass name="Frame"/>
<constructor name="HtmlHelpFrame" overloaded="no">
- <autodoc>__init__(Window parent, int ??, String title=EmptyString, int style=HF_DEFAULTSTYLE,
+ <autodoc>__init__(self, Window parent, int ??, String title=EmptyString, int style=HF_DEFAULTSTYLE,
HtmlHelpData data=None) -> HtmlHelpFrame</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</constructor>
<method name="GetData" type="HtmlHelpData" overloaded="no">
- <autodoc>GetData() -> HtmlHelpData</autodoc>
+ <autodoc>GetData(self) -> HtmlHelpData</autodoc>
</method>
<method name="SetTitleFormat" type="" overloaded="no">
- <autodoc>SetTitleFormat(String format)</autodoc>
+ <autodoc>SetTitleFormat(self, String format)</autodoc>
<paramlist>
<param name="format" type="String" default=""/>
</paramlist>
</method>
<method name="Display" type="" overloaded="no">
- <autodoc>Display(String x)</autodoc>
+ <autodoc>Display(self, String x)</autodoc>
<paramlist>
<param name="x" type="String" default=""/>
</paramlist>
</method>
<method name="DisplayID" type="" overloaded="no">
- <autodoc>DisplayID(int id)</autodoc>
+ <autodoc>DisplayID(self, int id)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="DisplayContents" type="" overloaded="no">
- <autodoc>DisplayContents()</autodoc>
+ <autodoc>DisplayContents(self)</autodoc>
</method>
<method name="DisplayIndex" type="" overloaded="no">
- <autodoc>DisplayIndex()</autodoc>
+ <autodoc>DisplayIndex(self)</autodoc>
</method>
<method name="KeywordSearch" type="bool" overloaded="no">
- <autodoc>KeywordSearch(String keyword) -> bool</autodoc>
+ <autodoc>KeywordSearch(self, String keyword) -> bool</autodoc>
<paramlist>
<param name="keyword" type="String" default=""/>
</paramlist>
</method>
<method name="UseConfig" type="" overloaded="no">
- <autodoc>UseConfig(ConfigBase config, String rootpath=EmptyString)</autodoc>
+ <autodoc>UseConfig(self, ConfigBase config, String rootpath=EmptyString)</autodoc>
<paramlist>
<param name="config" type="ConfigBase" default=""/>
<param name="rootpath" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="ReadCustomization" type="" overloaded="no">
- <autodoc>ReadCustomization(ConfigBase cfg, String path=EmptyString)</autodoc>
+ <autodoc>ReadCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc>
<paramlist>
<param name="cfg" type="ConfigBase" default=""/>
<param name="path" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="WriteCustomization" type="" overloaded="no">
- <autodoc>WriteCustomization(ConfigBase cfg, String path=EmptyString)</autodoc>
+ <autodoc>WriteCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc>
<paramlist>
<param name="cfg" type="ConfigBase" default=""/>
<param name="path" type="String" default="wxPyEmptyString"/>
<class name="HtmlHelpController" oldname="wxHtmlHelpController" module="html">
<baseclass name="EvtHandler"/>
<constructor name="HtmlHelpController" overloaded="no">
- <autodoc>__init__(int style=HF_DEFAULTSTYLE) -> HtmlHelpController</autodoc>
+ <autodoc>__init__(self, int style=HF_DEFAULTSTYLE) -> HtmlHelpController</autodoc>
<paramlist>
<param name="style" type="int" default="wxHF_DEFAULTSTYLE"/>
</paramlist>
</constructor>
<destructor name="~wxHtmlHelpController" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetTitleFormat" type="" overloaded="no">
- <autodoc>SetTitleFormat(String format)</autodoc>
+ <autodoc>SetTitleFormat(self, String format)</autodoc>
<paramlist>
<param name="format" type="String" default=""/>
</paramlist>
</method>
<method name="SetTempDir" type="" overloaded="no">
- <autodoc>SetTempDir(String path)</autodoc>
+ <autodoc>SetTempDir(self, String path)</autodoc>
<paramlist>
<param name="path" type="String" default=""/>
</paramlist>
</method>
<method name="AddBook" type="bool" overloaded="no">
- <autodoc>AddBook(String book, int show_wait_msg=False) -> bool</autodoc>
+ <autodoc>AddBook(self, String book, int show_wait_msg=False) -> bool</autodoc>
<paramlist>
<param name="book" type="String" default=""/>
<param name="show_wait_msg" type="int" default="False"/>
</paramlist>
</method>
<method name="Display" type="" overloaded="no">
- <autodoc>Display(String x)</autodoc>
+ <autodoc>Display(self, String x)</autodoc>
<paramlist>
<param name="x" type="String" default=""/>
</paramlist>
</method>
<method name="DisplayID" type="" overloaded="no">
- <autodoc>DisplayID(int id)</autodoc>
+ <autodoc>DisplayID(self, int id)</autodoc>
<paramlist>
<param name="id" type="int" default=""/>
</paramlist>
</method>
<method name="DisplayContents" type="" overloaded="no">
- <autodoc>DisplayContents()</autodoc>
+ <autodoc>DisplayContents(self)</autodoc>
</method>
<method name="DisplayIndex" type="" overloaded="no">
- <autodoc>DisplayIndex()</autodoc>
+ <autodoc>DisplayIndex(self)</autodoc>
</method>
<method name="KeywordSearch" type="bool" overloaded="no">
- <autodoc>KeywordSearch(String keyword) -> bool</autodoc>
+ <autodoc>KeywordSearch(self, String keyword) -> bool</autodoc>
<paramlist>
<param name="keyword" type="String" default=""/>
</paramlist>
</method>
<method name="UseConfig" type="" overloaded="no">
- <autodoc>UseConfig(ConfigBase config, String rootpath=EmptyString)</autodoc>
+ <autodoc>UseConfig(self, ConfigBase config, String rootpath=EmptyString)</autodoc>
<paramlist>
<param name="config" type="ConfigBase" default=""/>
<param name="rootpath" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="ReadCustomization" type="" overloaded="no">
- <autodoc>ReadCustomization(ConfigBase cfg, String path=EmptyString)</autodoc>
+ <autodoc>ReadCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc>
<paramlist>
<param name="cfg" type="ConfigBase" default=""/>
<param name="path" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="WriteCustomization" type="" overloaded="no">
- <autodoc>WriteCustomization(ConfigBase cfg, String path=EmptyString)</autodoc>
+ <autodoc>WriteCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc>
<paramlist>
<param name="cfg" type="ConfigBase" default=""/>
<param name="path" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="GetFrame" type="HtmlHelpFrame" overloaded="no">
- <autodoc>GetFrame() -> HtmlHelpFrame</autodoc>
+ <autodoc>GetFrame(self) -> HtmlHelpFrame</autodoc>
</method>
</class>
</module>
<module name="wizard">
- <import name="windows"/>
- <pythoncode> wx = core </pythoncode>
+ <import name="_windows"/>
+ <pythoncode> wx = _core </pythoncode>
+ <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode>
<pythoncode>
EVT_WIZARD_PAGE_CHANGED = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGED, 1)
EVT_WIZARD_PAGE_CHANGING = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGING, 1)
<class name="WizardEvent" oldname="wxWizardEvent" module="wizard">
<baseclass name="NotifyEvent"/>
<constructor name="WizardEvent" overloaded="no">
- <autodoc>__init__(wxEventType type=wxEVT_NULL, int id=-1, bool direction=True,
+ <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int id=-1, bool direction=True,
WizardPage page=None) -> WizardEvent</autodoc>
<paramlist>
<param name="type" type="wxEventType" default="wxEVT_NULL"/>
</paramlist>
</constructor>
<method name="GetDirection" type="bool" overloaded="no">
- <autodoc>GetDirection() -> bool</autodoc>
+ <autodoc>GetDirection(self) -> bool</autodoc>
</method>
<method name="GetPage" type="wxWizardPage" overloaded="no">
- <autodoc>GetPage() -> WizardPage</autodoc>
+ <autodoc>GetPage(self) -> WizardPage</autodoc>
</method>
</class>
<class name="WizardPage" oldname="wxWizardPage" module="wizard">
<baseclass name="Panel"/>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool</autodoc>
+ <autodoc>Create(self, Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool</autodoc>
<paramlist>
<param name="parent" type="wxWizard" default=""/>
<param name="bitmap" type="Bitmap" default="wxNullBitmap"/>
</paramlist>
</method>
<method name="GetPrev" type="WizardPage" overloaded="no">
- <autodoc>GetPrev() -> WizardPage</autodoc>
+ <autodoc>GetPrev(self) -> WizardPage</autodoc>
</method>
<method name="GetNext" type="WizardPage" overloaded="no">
- <autodoc>GetNext() -> WizardPage</autodoc>
+ <autodoc>GetNext(self) -> WizardPage</autodoc>
</method>
<method name="GetBitmap" type="Bitmap" overloaded="no">
- <autodoc>GetBitmap() -> Bitmap</autodoc>
+ <autodoc>GetBitmap(self) -> Bitmap</autodoc>
</method>
</class>
<class name="PyWizardPage" oldname="wxPyWizardPage" module="wizard">
<baseclass name="WizardPage"/>
<constructor name="PyWizardPage" overloaded="no">
- <autodoc>__init__(Wizard parent, Bitmap bitmap=&wxNullBitmap, String resource=&wxPyEmptyString) -> PyWizardPage</autodoc>
+ <autodoc>__init__(self, Wizard parent, Bitmap bitmap=&wxNullBitmap, String resource=&wxPyEmptyString) -> PyWizardPage</autodoc>
<paramlist>
<param name="parent" type="wxWizard" default=""/>
<param name="bitmap" type="Bitmap" default="&wxNullBitmap"/>
<autodoc>PrePyWizardPage() -> PyWizardPage</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool</autodoc>
+ <autodoc>Create(self, Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool</autodoc>
<paramlist>
<param name="parent" type="wxWizard" default=""/>
<param name="bitmap" type="Bitmap" default="wxNullBitmap"/>
</paramlist>
</method>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="base_DoMoveWindow" type="" overloaded="no">
- <autodoc>base_DoMoveWindow(int x, int y, int width, int height)</autodoc>
+ <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetSize" type="" overloaded="no">
- <autodoc>base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
+ <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetClientSize" type="" overloaded="no">
- <autodoc>base_DoSetClientSize(int width, int height)</autodoc>
+ <autodoc>base_DoSetClientSize(self, int width, int height)</autodoc>
<paramlist>
<param name="width" type="int" default=""/>
<param name="height" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoSetVirtualSize" type="" overloaded="no">
- <autodoc>base_DoSetVirtualSize(int x, int y)</autodoc>
+ <autodoc>base_DoSetVirtualSize(self, int x, int y)</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="base_DoGetVirtualSize" type="Size" overloaded="no">
- <autodoc>base_DoGetVirtualSize() -> Size</autodoc>
+ <autodoc>base_DoGetVirtualSize(self) -> Size</autodoc>
</method>
<method name="base_DoGetBestSize" type="Size" overloaded="no">
- <autodoc>base_DoGetBestSize() -> Size</autodoc>
+ <autodoc>base_DoGetBestSize(self) -> Size</autodoc>
</method>
<method name="base_InitDialog" type="" overloaded="no">
- <autodoc>base_InitDialog()</autodoc>
+ <autodoc>base_InitDialog(self)</autodoc>
</method>
<method name="base_TransferDataToWindow" type="bool" overloaded="no">
- <autodoc>base_TransferDataToWindow() -> bool</autodoc>
+ <autodoc>base_TransferDataToWindow(self) -> bool</autodoc>
</method>
<method name="base_TransferDataFromWindow" type="bool" overloaded="no">
- <autodoc>base_TransferDataFromWindow() -> bool</autodoc>
+ <autodoc>base_TransferDataFromWindow(self) -> bool</autodoc>
</method>
<method name="base_Validate" type="bool" overloaded="no">
- <autodoc>base_Validate() -> bool</autodoc>
+ <autodoc>base_Validate(self) -> bool</autodoc>
</method>
<method name="base_AcceptsFocus" type="bool" overloaded="no">
- <autodoc>base_AcceptsFocus() -> bool</autodoc>
+ <autodoc>base_AcceptsFocus(self) -> bool</autodoc>
</method>
<method name="base_AcceptsFocusFromKeyboard" type="bool" overloaded="no">
- <autodoc>base_AcceptsFocusFromKeyboard() -> bool</autodoc>
+ <autodoc>base_AcceptsFocusFromKeyboard(self) -> bool</autodoc>
</method>
<method name="base_GetMaxSize" type="Size" overloaded="no">
- <autodoc>base_GetMaxSize() -> Size</autodoc>
+ <autodoc>base_GetMaxSize(self) -> Size</autodoc>
</method>
<method name="base_AddChild" type="" overloaded="no">
- <autodoc>base_AddChild(Window child)</autodoc>
+ <autodoc>base_AddChild(self, Window child)</autodoc>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
<method name="base_RemoveChild" type="" overloaded="no">
- <autodoc>base_RemoveChild(Window child)</autodoc>
+ <autodoc>base_RemoveChild(self, Window child)</autodoc>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
<class name="WizardPageSimple" oldname="wxWizardPageSimple" module="wizard">
<baseclass name="WizardPage"/>
<constructor name="WizardPageSimple" overloaded="no">
- <autodoc>__init__(Wizard parent, WizardPage prev=None, WizardPage next=None,
+ <autodoc>__init__(self, Wizard parent, WizardPage prev=None, WizardPage next=None,
Bitmap bitmap=wxNullBitmap, wxChar resource=None) -> WizardPageSimple</autodoc>
<paramlist>
<param name="parent" type="wxWizard" default=""/>
<autodoc>PreWizardPageSimple() -> WizardPageSimple</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Wizard parent=None, WizardPage prev=None, WizardPage next=None,
+ <autodoc>Create(self, Wizard parent=None, WizardPage prev=None, WizardPage next=None,
Bitmap bitmap=wxNullBitmap, wxChar resource=None) -> bool</autodoc>
<paramlist>
<param name="parent" type="wxWizard" default="NULL"/>
</paramlist>
</method>
<method name="SetPrev" type="" overloaded="no">
- <autodoc>SetPrev(WizardPage prev)</autodoc>
+ <autodoc>SetPrev(self, WizardPage prev)</autodoc>
<paramlist>
<param name="prev" type="WizardPage" default=""/>
</paramlist>
</method>
<method name="SetNext" type="" overloaded="no">
- <autodoc>SetNext(WizardPage next)</autodoc>
+ <autodoc>SetNext(self, WizardPage next)</autodoc>
<paramlist>
<param name="next" type="WizardPage" default=""/>
</paramlist>
<class name="Wizard" oldname="wxWizard" module="wizard">
<baseclass name="Dialog"/>
<constructor name="Wizard" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, String title=EmptyString,
+ <autodoc>__init__(self, Window parent, int id=-1, String title=EmptyString,
Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition,
long style=DEFAULT_DIALOG_STYLE) -> Wizard</autodoc>
<paramlist>
<autodoc>PreWizard() -> Wizard</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, String title=EmptyString,
+ <autodoc>Create(self, Window parent, int id=-1, String title=EmptyString,
Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="Init" type="" overloaded="no">
- <autodoc>Init()</autodoc>
+ <autodoc>Init(self)</autodoc>
</method>
<method name="RunWizard" type="bool" overloaded="no">
- <autodoc>RunWizard(WizardPage firstPage) -> bool</autodoc>
+ <autodoc>RunWizard(self, WizardPage firstPage) -> bool</autodoc>
<paramlist>
<param name="firstPage" type="WizardPage" default=""/>
</paramlist>
</method>
<method name="GetCurrentPage" type="WizardPage" overloaded="no">
- <autodoc>GetCurrentPage() -> WizardPage</autodoc>
+ <autodoc>GetCurrentPage(self) -> WizardPage</autodoc>
</method>
<method name="SetPageSize" type="" overloaded="no">
- <autodoc>SetPageSize(Size size)</autodoc>
+ <autodoc>SetPageSize(self, Size size)</autodoc>
<paramlist>
<param name="size" type="Size" default=""/>
</paramlist>
</method>
<method name="GetPageSize" type="Size" overloaded="no">
- <autodoc>GetPageSize() -> Size</autodoc>
+ <autodoc>GetPageSize(self) -> Size</autodoc>
</method>
<method name="FitToPage" type="" overloaded="no">
- <autodoc>FitToPage(WizardPage firstPage)</autodoc>
+ <autodoc>FitToPage(self, WizardPage firstPage)</autodoc>
<paramlist>
<param name="firstPage" type="WizardPage" default=""/>
</paramlist>
</method>
<method name="GetPageAreaSizer" type="Sizer" overloaded="no">
- <autodoc>GetPageAreaSizer() -> Sizer</autodoc>
+ <autodoc>GetPageAreaSizer(self) -> Sizer</autodoc>
</method>
<method name="SetBorder" type="" overloaded="no">
- <autodoc>SetBorder(int border)</autodoc>
+ <autodoc>SetBorder(self, int border)</autodoc>
<paramlist>
<param name="border" type="int" default=""/>
</paramlist>
</method>
<method name="IsRunning" type="bool" overloaded="no">
- <autodoc>IsRunning() -> bool</autodoc>
+ <autodoc>IsRunning(self) -> bool</autodoc>
</method>
<method name="ShowPage" type="bool" overloaded="no">
- <autodoc>ShowPage(WizardPage page, bool goingForward=True) -> bool</autodoc>
+ <autodoc>ShowPage(self, WizardPage page, bool goingForward=True) -> bool</autodoc>
<paramlist>
<param name="page" type="WizardPage" default=""/>
<param name="goingForward" type="bool" default="True"/>
</paramlist>
</method>
<method name="HasNextPage" type="bool" overloaded="no">
- <autodoc>HasNextPage(WizardPage page) -> bool</autodoc>
+ <autodoc>HasNextPage(self, WizardPage page) -> bool</autodoc>
<paramlist>
<param name="page" type="WizardPage" default=""/>
</paramlist>
</method>
<method name="HasPrevPage" type="bool" overloaded="no">
- <autodoc>HasPrevPage(WizardPage page) -> bool</autodoc>
+ <autodoc>HasPrevPage(self, WizardPage page) -> bool</autodoc>
<paramlist>
<param name="page" type="WizardPage" default=""/>
</paramlist>
</class>
</module>
<module name="glcanvas">
- <import name="core"/>
- <pythoncode> wx = core </pythoncode>
+ <import name="_core"/>
+ <pythoncode> wx = _core </pythoncode>
+ <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode>
<class name="GLContext" oldname="wxGLContext" module="glcanvas">
<baseclass name="Object"/>
<constructor name="GLContext" overloaded="no">
- <autodoc>__init__(bool isRGB, GLCanvas win, wxPalette palette=wxNullPalette,
+ <autodoc>__init__(self, bool isRGB, GLCanvas win, wxPalette palette=wxNullPalette,
GLContext other=None) -> GLContext</autodoc>
<paramlist>
<param name="isRGB" type="bool" default=""/>
</paramlist>
</constructor>
<destructor name="~wxGLContext" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetCurrent" type="" overloaded="no">
- <autodoc>SetCurrent()</autodoc>
+ <autodoc>SetCurrent(self)</autodoc>
</method>
<method name="SetColour" type="" overloaded="no">
- <autodoc>SetColour(String colour)</autodoc>
+ <autodoc>SetColour(self, String colour)</autodoc>
<paramlist>
<param name="colour" type="String" default=""/>
</paramlist>
</method>
<method name="SwapBuffers" type="" overloaded="no">
- <autodoc>SwapBuffers()</autodoc>
+ <autodoc>SwapBuffers(self)</autodoc>
</method>
<method name="SetupPixelFormat" type="" overloaded="no">
- <autodoc>SetupPixelFormat()</autodoc>
+ <autodoc>SetupPixelFormat(self)</autodoc>
</method>
<method name="SetupPalette" type="" overloaded="no">
- <autodoc>SetupPalette(wxPalette palette)</autodoc>
+ <autodoc>SetupPalette(self, wxPalette palette)</autodoc>
<paramlist>
<param name="palette" type="Palette" default=""/>
</paramlist>
</method>
<method name="CreateDefaultPalette" type="Palette" overloaded="no">
- <autodoc>CreateDefaultPalette() -> wxPalette</autodoc>
+ <autodoc>CreateDefaultPalette(self) -> wxPalette</autodoc>
</method>
<method name="GetPalette" type="Palette" overloaded="no">
- <autodoc>GetPalette() -> wxPalette</autodoc>
+ <autodoc>GetPalette(self) -> wxPalette</autodoc>
</method>
<method name="GetWindow" type="Window" overloaded="no">
- <autodoc>GetWindow() -> Window</autodoc>
+ <autodoc>GetWindow(self) -> Window</autodoc>
</method>
</class>
<class name="GLCanvas" oldname="wxGLCanvas" module="glcanvas">
<baseclass name="Window"/>
<constructor name="GLCanvas" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=GLCanvasNameStr,
int attribList=None, wxPalette palette=wxNullPalette) -> GLCanvas</autodoc>
<paramlist>
</paramlist>
</constructor>
<method name="SetCurrent" type="" overloaded="no">
- <autodoc>SetCurrent()</autodoc>
+ <autodoc>SetCurrent(self)</autodoc>
</method>
<method name="SetColour" type="" overloaded="no">
- <autodoc>SetColour(String colour)</autodoc>
+ <autodoc>SetColour(self, String colour)</autodoc>
<paramlist>
<param name="colour" type="String" default=""/>
</paramlist>
</method>
<method name="SwapBuffers" type="" overloaded="no">
- <autodoc>SwapBuffers()</autodoc>
+ <autodoc>SwapBuffers(self)</autodoc>
</method>
<method name="GetContext" type="GLContext" overloaded="no">
- <autodoc>GetContext() -> GLContext</autodoc>
+ <autodoc>GetContext(self) -> GLContext</autodoc>
</method>
</class>
</module>
<module name="ogl">
- <import name="windows"/>
- <pythoncode> wx = core </pythoncode>
+ <import name="_windows"/>
+ <pythoncode> wx = _core </pythoncode>
+ <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode>
+ <pythoncode>
+ import warnings
+ warnings.warn("This module is deprecated. Please use the wx.lib.ogl package instead.",
+ DeprecationWarning, stacklevel=2)
+</pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
<class name="ShapeRegion" oldname="wxShapeRegion" module="ogl">
<baseclass name="Object"/>
<constructor name="ShapeRegion" overloaded="no">
- <autodoc>__init__() -> ShapeRegion</autodoc>
+ <autodoc>__init__(self) -> ShapeRegion</autodoc>
</constructor>
<method name="SetText" type="" overloaded="no">
- <autodoc>SetText(String s)</autodoc>
+ <autodoc>SetText(self, String s)</autodoc>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="SetFont" type="" overloaded="no">
- <autodoc>SetFont(Font f)</autodoc>
+ <autodoc>SetFont(self, Font f)</autodoc>
<paramlist>
<param name="f" type="Font" default=""/>
</paramlist>
</method>
<method name="SetMinSize" type="" overloaded="no">
- <autodoc>SetMinSize(double w, double h)</autodoc>
+ <autodoc>SetMinSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(double w, double h)</autodoc>
+ <autodoc>SetSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="SetPosition" type="" overloaded="no">
- <autodoc>SetPosition(double x, double y)</autodoc>
+ <autodoc>SetPosition(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="SetProportions" type="" overloaded="no">
- <autodoc>SetProportions(double x, double y)</autodoc>
+ <autodoc>SetProportions(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="SetFormatMode" type="" overloaded="no">
- <autodoc>SetFormatMode(int mode)</autodoc>
+ <autodoc>SetFormatMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="SetName" type="" overloaded="no">
- <autodoc>SetName(String s)</autodoc>
+ <autodoc>SetName(self, String s)</autodoc>
<paramlist>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="SetColour" type="" overloaded="no">
- <autodoc>SetColour(String col)</autodoc>
+ <autodoc>SetColour(self, String col)</autodoc>
<paramlist>
<param name="col" type="String" default=""/>
</paramlist>
</method>
<method name="GetText" type="String" overloaded="no">
- <autodoc>GetText() -> String</autodoc>
+ <autodoc>GetText(self) -> String</autodoc>
</method>
<method name="GetFont" type="Font" overloaded="no">
- <autodoc>GetFont() -> Font</autodoc>
+ <autodoc>GetFont(self) -> Font</autodoc>
</method>
<method name="GetMinSize" type="" overloaded="no">
- <autodoc>GetMinSize(double OUTPUT, double OUTPUT)</autodoc>
+ <autodoc>GetMinSize(self, double OUTPUT, double OUTPUT)</autodoc>
<paramlist>
<param name="OUTPUT" type="double" default=""/>
<param name="OUTPUT" type="double" default=""/>
</paramlist>
</method>
<method name="GetProportion" type="" overloaded="no">
- <autodoc>GetProportion(double OUTPUT, double OUTPUT)</autodoc>
+ <autodoc>GetProportion(self, double OUTPUT, double OUTPUT)</autodoc>
<paramlist>
<param name="OUTPUT" type="double" default=""/>
<param name="OUTPUT" type="double" default=""/>
</paramlist>
</method>
<method name="GetSize" type="" overloaded="no">
- <autodoc>GetSize(double OUTPUT, double OUTPUT)</autodoc>
+ <autodoc>GetSize(self, double OUTPUT, double OUTPUT)</autodoc>
<paramlist>
<param name="OUTPUT" type="double" default=""/>
<param name="OUTPUT" type="double" default=""/>
</paramlist>
</method>
<method name="GetPosition" type="" overloaded="no">
- <autodoc>GetPosition(double OUTPUT, double OUTPUT)</autodoc>
+ <autodoc>GetPosition(self, double OUTPUT, double OUTPUT)</autodoc>
<paramlist>
<param name="OUTPUT" type="double" default=""/>
<param name="OUTPUT" type="double" default=""/>
</paramlist>
</method>
<method name="GetFormatMode" type="int" overloaded="no">
- <autodoc>GetFormatMode() -> int</autodoc>
+ <autodoc>GetFormatMode(self) -> int</autodoc>
</method>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
+ <autodoc>GetName(self) -> String</autodoc>
</method>
<method name="GetColour" type="String" overloaded="no">
- <autodoc>GetColour() -> String</autodoc>
+ <autodoc>GetColour(self) -> String</autodoc>
</method>
<method name="GetActualColourObject" type="Colour" overloaded="no">
- <autodoc>GetActualColourObject() -> Colour</autodoc>
+ <autodoc>GetActualColourObject(self) -> Colour</autodoc>
</method>
<method name="GetFormattedText" type="wxList" overloaded="no">
- <autodoc>GetFormattedText() -> wxList</autodoc>
+ <autodoc>GetFormattedText(self) -> wxList</autodoc>
</method>
<method name="GetPenColour" type="String" overloaded="no">
- <autodoc>GetPenColour() -> String</autodoc>
+ <autodoc>GetPenColour(self) -> String</autodoc>
</method>
<method name="GetPenStyle" type="int" overloaded="no">
- <autodoc>GetPenStyle() -> int</autodoc>
+ <autodoc>GetPenStyle(self) -> int</autodoc>
</method>
<method name="SetPenStyle" type="" overloaded="no">
- <autodoc>SetPenStyle(int style)</autodoc>
+ <autodoc>SetPenStyle(self, int style)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
</paramlist>
</method>
<method name="SetPenColour" type="" overloaded="no">
- <autodoc>SetPenColour(String col)</autodoc>
+ <autodoc>SetPenColour(self, String col)</autodoc>
<paramlist>
<param name="col" type="String" default=""/>
</paramlist>
</method>
<method name="GetActualPen" type="Pen" overloaded="no">
- <autodoc>GetActualPen() -> wxPen</autodoc>
+ <autodoc>GetActualPen(self) -> wxPen</autodoc>
</method>
<method name="GetWidth" type="double" overloaded="no">
- <autodoc>GetWidth() -> double</autodoc>
+ <autodoc>GetWidth(self) -> double</autodoc>
</method>
<method name="GetHeight" type="double" overloaded="no">
- <autodoc>GetHeight() -> double</autodoc>
+ <autodoc>GetHeight(self) -> double</autodoc>
</method>
<method name="ClearText" type="" overloaded="no">
- <autodoc>ClearText()</autodoc>
+ <autodoc>ClearText(self)</autodoc>
</method>
</class>
<class name="AttachmentPoint" oldname="wxAttachmentPoint" module="ogl">
<baseclass name="Object"/>
<constructor name="AttachmentPoint" overloaded="no">
- <autodoc>__init__(int id=0, double x=0.0, double y=0.0) -> AttachmentPoint</autodoc>
+ <autodoc>__init__(self, int id=0, double x=0.0, double y=0.0) -> AttachmentPoint</autodoc>
<paramlist>
<param name="id" type="int" default="0"/>
<param name="x" type="double" default="0.0"/>
<class name="PyShapeEvtHandler" oldname="wxPyShapeEvtHandler" module="ogl">
<baseclass name="Object"/>
<constructor name="PyShapeEvtHandler" overloaded="no">
- <autodoc>__init__(PyShapeEvtHandler prev=None, PyShape shape=None) -> PyShapeEvtHandler</autodoc>
+ <autodoc>__init__(self, PyShapeEvtHandler prev=None, PyShape shape=None) -> PyShapeEvtHandler</autodoc>
<paramlist>
<param name="prev" type="PyShapeEvtHandler" default="NULL"/>
<param name="shape" type="wxPyShape" default="NULL"/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="_setOORInfo" type="" overloaded="no">
- <autodoc>_setOORInfo(PyObject _self)</autodoc>
+ <autodoc>_setOORInfo(self, PyObject _self)</autodoc>
<paramlist>
<param name="_self" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetShape" type="" overloaded="no">
- <autodoc>SetShape(PyShape sh)</autodoc>
+ <autodoc>SetShape(self, PyShape sh)</autodoc>
<paramlist>
<param name="sh" type="wxPyShape" default=""/>
</paramlist>
</method>
<method name="GetShape" type="wxPyShape" overloaded="no">
- <autodoc>GetShape() -> PyShape</autodoc>
+ <autodoc>GetShape(self) -> PyShape</autodoc>
</method>
<method name="SetPreviousHandler" type="" overloaded="no">
- <autodoc>SetPreviousHandler(PyShapeEvtHandler handler)</autodoc>
+ <autodoc>SetPreviousHandler(self, PyShapeEvtHandler handler)</autodoc>
<paramlist>
<param name="handler" type="PyShapeEvtHandler" default=""/>
</paramlist>
</method>
<method name="GetPreviousHandler" type="PyShapeEvtHandler" overloaded="no">
- <autodoc>GetPreviousHandler() -> PyShapeEvtHandler</autodoc>
+ <autodoc>GetPreviousHandler(self) -> PyShapeEvtHandler</autodoc>
</method>
<method name="CreateNewCopy" type="PyShapeEvtHandler" overloaded="no">
- <autodoc>CreateNewCopy() -> PyShapeEvtHandler</autodoc>
+ <autodoc>CreateNewCopy(self) -> PyShapeEvtHandler</autodoc>
</method>
<method name="base_OnDelete" type="" overloaded="no">
- <autodoc>base_OnDelete()</autodoc>
+ <autodoc>base_OnDelete(self)</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=False)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=False)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="False"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="wxPyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="wxPyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="wxPyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="PyShape" oldname="wxPyShape" module="ogl">
<baseclass name="PyShapeEvtHandler"/>
<constructor name="PyShape" overloaded="no">
- <autodoc>__init__(PyShapeCanvas can=None) -> PyShape</autodoc>
+ <autodoc>__init__(self, PyShapeCanvas can=None) -> PyShape</autodoc>
<paramlist>
<param name="can" type="wxPyShapeCanvas" default="NULL"/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetBoundingBoxMax" type="" overloaded="no">
- <autodoc>GetBoundingBoxMax(double OUTPUT, double OUTPUT)</autodoc>
+ <autodoc>GetBoundingBoxMax(self, double OUTPUT, double OUTPUT)</autodoc>
<paramlist>
<param name="OUTPUT" type="double" default=""/>
<param name="OUTPUT" type="double" default=""/>
</paramlist>
</method>
<method name="GetBoundingBoxMin" type="" overloaded="no">
- <autodoc>GetBoundingBoxMin(double OUTPUT, double OUTPUT)</autodoc>
+ <autodoc>GetBoundingBoxMin(self, double OUTPUT, double OUTPUT)</autodoc>
<paramlist>
<param name="OUTPUT" type="double" default=""/>
<param name="OUTPUT" type="double" default=""/>
</paramlist>
</method>
<method name="GetPerimeterPoint" type="bool" overloaded="no">
- <autodoc>GetPerimeterPoint(double x1, double y1, double x2, double y2, double OUTPUT,
+ <autodoc>GetPerimeterPoint(self, double x1, double y1, double x2, double y2, double OUTPUT,
double OUTPUT) -> bool</autodoc>
<paramlist>
<param name="x1" type="double" default=""/>
</paramlist>
</method>
<method name="GetCanvas" type="wxPyShapeCanvas" overloaded="no">
- <autodoc>GetCanvas() -> PyShapeCanvas</autodoc>
+ <autodoc>GetCanvas(self) -> PyShapeCanvas</autodoc>
</method>
<method name="SetCanvas" type="" overloaded="no">
- <autodoc>SetCanvas(PyShapeCanvas the_canvas)</autodoc>
+ <autodoc>SetCanvas(self, PyShapeCanvas the_canvas)</autodoc>
<paramlist>
<param name="the_canvas" type="wxPyShapeCanvas" default=""/>
</paramlist>
</method>
<method name="AddToCanvas" type="" overloaded="no">
- <autodoc>AddToCanvas(PyShapeCanvas the_canvas, PyShape addAfter=None)</autodoc>
+ <autodoc>AddToCanvas(self, PyShapeCanvas the_canvas, PyShape addAfter=None)</autodoc>
<paramlist>
<param name="the_canvas" type="wxPyShapeCanvas" default=""/>
<param name="addAfter" type="PyShape" default="NULL"/>
</paramlist>
</method>
<method name="InsertInCanvas" type="" overloaded="no">
- <autodoc>InsertInCanvas(PyShapeCanvas the_canvas)</autodoc>
+ <autodoc>InsertInCanvas(self, PyShapeCanvas the_canvas)</autodoc>
<paramlist>
<param name="the_canvas" type="wxPyShapeCanvas" default=""/>
</paramlist>
</method>
<method name="RemoveFromCanvas" type="" overloaded="no">
- <autodoc>RemoveFromCanvas(PyShapeCanvas the_canvas)</autodoc>
+ <autodoc>RemoveFromCanvas(self, PyShapeCanvas the_canvas)</autodoc>
<paramlist>
<param name="the_canvas" type="wxPyShapeCanvas" default=""/>
</paramlist>
</method>
<method name="GetX" type="double" overloaded="no">
- <autodoc>GetX() -> double</autodoc>
+ <autodoc>GetX(self) -> double</autodoc>
</method>
<method name="GetY" type="double" overloaded="no">
- <autodoc>GetY() -> double</autodoc>
+ <autodoc>GetY(self) -> double</autodoc>
</method>
<method name="SetX" type="" overloaded="no">
- <autodoc>SetX(double x)</autodoc>
+ <autodoc>SetX(self, double x)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="SetY" type="" overloaded="no">
- <autodoc>SetY(double y)</autodoc>
+ <autodoc>SetY(self, double y)</autodoc>
<paramlist>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="GetParent" type="PyShape" overloaded="no">
- <autodoc>GetParent() -> PyShape</autodoc>
+ <autodoc>GetParent(self) -> PyShape</autodoc>
</method>
<method name="SetParent" type="" overloaded="no">
- <autodoc>SetParent(PyShape p)</autodoc>
+ <autodoc>SetParent(self, PyShape p)</autodoc>
<paramlist>
<param name="p" type="PyShape" default=""/>
</paramlist>
</method>
<method name="GetTopAncestor" type="PyShape" overloaded="no">
- <autodoc>GetTopAncestor() -> PyShape</autodoc>
+ <autodoc>GetTopAncestor(self) -> PyShape</autodoc>
</method>
<method name="GetChildren" type="PyObject" overloaded="no">
- <autodoc>GetChildren() -> PyObject</autodoc>
+ <autodoc>GetChildren(self) -> PyObject</autodoc>
</method>
<method name="Unlink" type="" overloaded="no">
- <autodoc>Unlink()</autodoc>
+ <autodoc>Unlink(self)</autodoc>
</method>
<method name="SetDrawHandles" type="" overloaded="no">
- <autodoc>SetDrawHandles(bool drawH)</autodoc>
+ <autodoc>SetDrawHandles(self, bool drawH)</autodoc>
<paramlist>
<param name="drawH" type="bool" default=""/>
</paramlist>
</method>
<method name="GetDrawHandles" type="bool" overloaded="no">
- <autodoc>GetDrawHandles() -> bool</autodoc>
+ <autodoc>GetDrawHandles(self) -> bool</autodoc>
</method>
<method name="MakeControlPoints" type="" overloaded="no">
- <autodoc>MakeControlPoints()</autodoc>
+ <autodoc>MakeControlPoints(self)</autodoc>
</method>
<method name="DeleteControlPoints" type="" overloaded="no">
- <autodoc>DeleteControlPoints(DC dc=None)</autodoc>
+ <autodoc>DeleteControlPoints(self, DC dc=None)</autodoc>
<paramlist>
<param name="dc" type="DC" default="NULL"/>
</paramlist>
</method>
<method name="ResetControlPoints" type="" overloaded="no">
- <autodoc>ResetControlPoints()</autodoc>
+ <autodoc>ResetControlPoints(self)</autodoc>
</method>
<method name="GetEventHandler" type="PyShapeEvtHandler" overloaded="no">
- <autodoc>GetEventHandler() -> PyShapeEvtHandler</autodoc>
+ <autodoc>GetEventHandler(self) -> PyShapeEvtHandler</autodoc>
</method>
<method name="SetEventHandler" type="" overloaded="no">
- <autodoc>SetEventHandler(PyShapeEvtHandler handler)</autodoc>
+ <autodoc>SetEventHandler(self, PyShapeEvtHandler handler)</autodoc>
<paramlist>
<param name="handler" type="PyShapeEvtHandler" default=""/>
</paramlist>
</method>
<method name="MakeMandatoryControlPoints" type="" overloaded="no">
- <autodoc>MakeMandatoryControlPoints()</autodoc>
+ <autodoc>MakeMandatoryControlPoints(self)</autodoc>
</method>
<method name="ResetMandatoryControlPoints" type="" overloaded="no">
- <autodoc>ResetMandatoryControlPoints()</autodoc>
+ <autodoc>ResetMandatoryControlPoints(self)</autodoc>
</method>
<method name="Recompute" type="bool" overloaded="no">
- <autodoc>Recompute() -> bool</autodoc>
+ <autodoc>Recompute(self) -> bool</autodoc>
</method>
<method name="CalculateSize" type="" overloaded="no">
- <autodoc>CalculateSize()</autodoc>
+ <autodoc>CalculateSize(self)</autodoc>
</method>
<method name="Select" type="" overloaded="no">
- <autodoc>Select(bool select=True, DC dc=None)</autodoc>
+ <autodoc>Select(self, bool select=True, DC dc=None)</autodoc>
<paramlist>
<param name="select" type="bool" default="True"/>
<param name="dc" type="DC" default="NULL"/>
</paramlist>
</method>
<method name="SetHighlight" type="" overloaded="no">
- <autodoc>SetHighlight(bool hi=True, bool recurse=False)</autodoc>
+ <autodoc>SetHighlight(self, bool hi=True, bool recurse=False)</autodoc>
<paramlist>
<param name="hi" type="bool" default="True"/>
<param name="recurse" type="bool" default="False"/>
</paramlist>
</method>
<method name="IsHighlighted" type="bool" overloaded="no">
- <autodoc>IsHighlighted() -> bool</autodoc>
+ <autodoc>IsHighlighted(self) -> bool</autodoc>
</method>
<method name="Selected" type="bool" overloaded="no">
- <autodoc>Selected() -> bool</autodoc>
+ <autodoc>Selected(self) -> bool</autodoc>
</method>
<method name="AncestorSelected" type="bool" overloaded="no">
- <autodoc>AncestorSelected() -> bool</autodoc>
+ <autodoc>AncestorSelected(self) -> bool</autodoc>
</method>
<method name="SetSensitivityFilter" type="" overloaded="no">
- <autodoc>SetSensitivityFilter(int sens=OP_ALL, bool recursive=False)</autodoc>
+ <autodoc>SetSensitivityFilter(self, int sens=OP_ALL, bool recursive=False)</autodoc>
<paramlist>
<param name="sens" type="int" default="OP_ALL"/>
<param name="recursive" type="bool" default="False"/>
</paramlist>
</method>
<method name="GetSensitivityFilter" type="int" overloaded="no">
- <autodoc>GetSensitivityFilter() -> int</autodoc>
+ <autodoc>GetSensitivityFilter(self) -> int</autodoc>
</method>
<method name="SetDraggable" type="" overloaded="no">
- <autodoc>SetDraggable(bool drag, bool recursive=False)</autodoc>
+ <autodoc>SetDraggable(self, bool drag, bool recursive=False)</autodoc>
<paramlist>
<param name="drag" type="bool" default=""/>
<param name="recursive" type="bool" default="False"/>
</paramlist>
</method>
<method name="SetFixedSize" type="" overloaded="no">
- <autodoc>SetFixedSize(bool x, bool y)</autodoc>
+ <autodoc>SetFixedSize(self, bool x, bool y)</autodoc>
<paramlist>
<param name="x" type="bool" default=""/>
<param name="y" type="bool" default=""/>
</paramlist>
</method>
<method name="GetFixedSize" type="" overloaded="no">
- <autodoc>GetFixedSize(bool OUTPUT, bool OUTPUT)</autodoc>
+ <autodoc>GetFixedSize(self, bool OUTPUT, bool OUTPUT)</autodoc>
<paramlist>
<param name="OUTPUT" type="bool" default=""/>
<param name="OUTPUT" type="bool" default=""/>
</paramlist>
</method>
<method name="GetFixedWidth" type="bool" overloaded="no">
- <autodoc>GetFixedWidth() -> bool</autodoc>
+ <autodoc>GetFixedWidth(self) -> bool</autodoc>
</method>
<method name="GetFixedHeight" type="bool" overloaded="no">
- <autodoc>GetFixedHeight() -> bool</autodoc>
+ <autodoc>GetFixedHeight(self) -> bool</autodoc>
</method>
<method name="SetSpaceAttachments" type="" overloaded="no">
- <autodoc>SetSpaceAttachments(bool sp)</autodoc>
+ <autodoc>SetSpaceAttachments(self, bool sp)</autodoc>
<paramlist>
<param name="sp" type="bool" default=""/>
</paramlist>
</method>
<method name="GetSpaceAttachments" type="bool" overloaded="no">
- <autodoc>GetSpaceAttachments() -> bool</autodoc>
+ <autodoc>GetSpaceAttachments(self) -> bool</autodoc>
</method>
<method name="SetShadowMode" type="" overloaded="no">
- <autodoc>SetShadowMode(int mode, bool redraw=False)</autodoc>
+ <autodoc>SetShadowMode(self, int mode, bool redraw=False)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
<param name="redraw" type="bool" default="False"/>
</paramlist>
</method>
<method name="GetShadowMode" type="int" overloaded="no">
- <autodoc>GetShadowMode() -> int</autodoc>
+ <autodoc>GetShadowMode(self) -> int</autodoc>
</method>
<method name="HitTest" type="bool" overloaded="no">
- <autodoc>HitTest(double x, double y, int OUTPUT, double OUTPUT) -> bool</autodoc>
+ <autodoc>HitTest(self, double x, double y, int OUTPUT, double OUTPUT) -> bool</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="SetCentreResize" type="" overloaded="no">
- <autodoc>SetCentreResize(bool cr)</autodoc>
+ <autodoc>SetCentreResize(self, bool cr)</autodoc>
<paramlist>
<param name="cr" type="bool" default=""/>
</paramlist>
</method>
<method name="GetCentreResize" type="bool" overloaded="no">
- <autodoc>GetCentreResize() -> bool</autodoc>
+ <autodoc>GetCentreResize(self) -> bool</autodoc>
</method>
<method name="SetMaintainAspectRatio" type="" overloaded="no">
- <autodoc>SetMaintainAspectRatio(bool ar)</autodoc>
+ <autodoc>SetMaintainAspectRatio(self, bool ar)</autodoc>
<paramlist>
<param name="ar" type="bool" default=""/>
</paramlist>
</method>
<method name="GetMaintainAspectRatio" type="bool" overloaded="no">
- <autodoc>GetMaintainAspectRatio() -> bool</autodoc>
+ <autodoc>GetMaintainAspectRatio(self) -> bool</autodoc>
</method>
<method name="GetLines" type="PyObject" overloaded="no">
- <autodoc>GetLines() -> PyObject</autodoc>
+ <autodoc>GetLines(self) -> PyObject</autodoc>
</method>
<method name="SetDisableLabel" type="" overloaded="no">
- <autodoc>SetDisableLabel(bool flag)</autodoc>
+ <autodoc>SetDisableLabel(self, bool flag)</autodoc>
<paramlist>
<param name="flag" type="bool" default=""/>
</paramlist>
</method>
<method name="GetDisableLabel" type="bool" overloaded="no">
- <autodoc>GetDisableLabel() -> bool</autodoc>
+ <autodoc>GetDisableLabel(self) -> bool</autodoc>
</method>
<method name="SetAttachmentMode" type="" overloaded="no">
- <autodoc>SetAttachmentMode(int mode)</autodoc>
+ <autodoc>SetAttachmentMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="GetAttachmentMode" type="int" overloaded="no">
- <autodoc>GetAttachmentMode() -> int</autodoc>
+ <autodoc>GetAttachmentMode(self) -> int</autodoc>
</method>
<method name="SetId" type="" overloaded="no">
- <autodoc>SetId(long i)</autodoc>
+ <autodoc>SetId(self, long i)</autodoc>
<paramlist>
<param name="i" type="long" default=""/>
</paramlist>
</method>
<method name="GetId" type="long" overloaded="no">
- <autodoc>GetId() -> long</autodoc>
+ <autodoc>GetId(self) -> long</autodoc>
</method>
<method name="SetPen" type="" overloaded="no">
- <autodoc>SetPen(wxPen pen)</autodoc>
+ <autodoc>SetPen(self, wxPen pen)</autodoc>
<paramlist>
<param name="pen" type="Pen" default=""/>
</paramlist>
</method>
<method name="SetBrush" type="" overloaded="no">
- <autodoc>SetBrush(wxBrush brush)</autodoc>
+ <autodoc>SetBrush(self, wxBrush brush)</autodoc>
<paramlist>
<param name="brush" type="Brush" default=""/>
</paramlist>
</method>
<method name="Show" type="" overloaded="no">
- <autodoc>Show(bool show)</autodoc>
+ <autodoc>Show(self, bool show)</autodoc>
<paramlist>
<param name="show" type="bool" default=""/>
</paramlist>
</method>
<method name="IsShown" type="bool" overloaded="no">
- <autodoc>IsShown() -> bool</autodoc>
+ <autodoc>IsShown(self) -> bool</autodoc>
</method>
<method name="Move" type="" overloaded="no">
- <autodoc>Move(DC dc, double x1, double y1, bool display=True)</autodoc>
+ <autodoc>Move(self, DC dc, double x1, double y1, bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x1" type="double" default=""/>
</paramlist>
</method>
<method name="Erase" type="" overloaded="no">
- <autodoc>Erase(DC dc)</autodoc>
+ <autodoc>Erase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="EraseContents" type="" overloaded="no">
- <autodoc>EraseContents(DC dc)</autodoc>
+ <autodoc>EraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="Draw" type="" overloaded="no">
- <autodoc>Draw(DC dc)</autodoc>
+ <autodoc>Draw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="Flash" type="" overloaded="no">
- <autodoc>Flash()</autodoc>
+ <autodoc>Flash(self)</autodoc>
</method>
<method name="MoveLinks" type="" overloaded="no">
- <autodoc>MoveLinks(DC dc)</autodoc>
+ <autodoc>MoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="DrawContents" type="" overloaded="no">
- <autodoc>DrawContents(DC dc)</autodoc>
+ <autodoc>DrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(double x, double y, bool recursive=True)</autodoc>
+ <autodoc>SetSize(self, double x, double y, bool recursive=True)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="SetAttachmentSize" type="" overloaded="no">
- <autodoc>SetAttachmentSize(double x, double y)</autodoc>
+ <autodoc>SetAttachmentSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="Attach" type="" overloaded="no">
- <autodoc>Attach(PyShapeCanvas can)</autodoc>
+ <autodoc>Attach(self, PyShapeCanvas can)</autodoc>
<paramlist>
<param name="can" type="wxPyShapeCanvas" default=""/>
</paramlist>
</method>
<method name="Detach" type="" overloaded="no">
- <autodoc>Detach()</autodoc>
+ <autodoc>Detach(self)</autodoc>
</method>
<method name="Constrain" type="bool" overloaded="no">
- <autodoc>Constrain() -> bool</autodoc>
+ <autodoc>Constrain(self) -> bool</autodoc>
</method>
<method name="AddLine" type="" overloaded="no">
- <autodoc>AddLine(PyLineShape line, PyShape other, int attachFrom=0,
+ <autodoc>AddLine(self, PyLineShape line, PyShape other, int attachFrom=0,
int attachTo=0, int positionFrom=-1, int positionTo=-1)</autodoc>
<paramlist>
<param name="line" type="wxPyLineShape" default=""/>
</paramlist>
</method>
<method name="GetLinePosition" type="int" overloaded="no">
- <autodoc>GetLinePosition(PyLineShape line) -> int</autodoc>
+ <autodoc>GetLinePosition(self, PyLineShape line) -> int</autodoc>
<paramlist>
<param name="line" type="wxPyLineShape" default=""/>
</paramlist>
</method>
<method name="AddText" type="" overloaded="no">
- <autodoc>AddText(String string)</autodoc>
+ <autodoc>AddText(self, String string)</autodoc>
<paramlist>
<param name="string" type="String" default=""/>
</paramlist>
</method>
<method name="GetPen" type="Pen" overloaded="no">
- <autodoc>GetPen() -> wxPen</autodoc>
+ <autodoc>GetPen(self) -> wxPen</autodoc>
</method>
<method name="GetBrush" type="Brush" overloaded="no">
- <autodoc>GetBrush() -> wxBrush</autodoc>
+ <autodoc>GetBrush(self) -> wxBrush</autodoc>
</method>
<method name="SetDefaultRegionSize" type="" overloaded="no">
- <autodoc>SetDefaultRegionSize()</autodoc>
+ <autodoc>SetDefaultRegionSize(self)</autodoc>
</method>
<method name="FormatText" type="" overloaded="no">
- <autodoc>FormatText(DC dc, String s, int regionId=0)</autodoc>
+ <autodoc>FormatText(self, DC dc, String s, int regionId=0)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="s" type="String" default=""/>
</paramlist>
</method>
<method name="SetFormatMode" type="" overloaded="no">
- <autodoc>SetFormatMode(int mode, int regionId=0)</autodoc>
+ <autodoc>SetFormatMode(self, int mode, int regionId=0)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
<param name="regionId" type="int" default="0"/>
</paramlist>
</method>
<method name="GetFormatMode" type="int" overloaded="no">
- <autodoc>GetFormatMode(int regionId=0) -> int</autodoc>
+ <autodoc>GetFormatMode(self, int regionId=0) -> int</autodoc>
<paramlist>
<param name="regionId" type="int" default="0"/>
</paramlist>
</method>
<method name="SetFont" type="" overloaded="no">
- <autodoc>SetFont(Font font, int regionId=0)</autodoc>
+ <autodoc>SetFont(self, Font font, int regionId=0)</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
<param name="regionId" type="int" default="0"/>
</paramlist>
</method>
<method name="GetFont" type="Font" overloaded="no">
- <autodoc>GetFont(int regionId=0) -> Font</autodoc>
+ <autodoc>GetFont(self, int regionId=0) -> Font</autodoc>
<paramlist>
<param name="regionId" type="int" default="0"/>
</paramlist>
</method>
<method name="SetTextColour" type="" overloaded="no">
- <autodoc>SetTextColour(String colour, int regionId=0)</autodoc>
+ <autodoc>SetTextColour(self, String colour, int regionId=0)</autodoc>
<paramlist>
<param name="colour" type="String" default=""/>
<param name="regionId" type="int" default="0"/>
</paramlist>
</method>
<method name="GetTextColour" type="String" overloaded="no">
- <autodoc>GetTextColour(int regionId=0) -> String</autodoc>
+ <autodoc>GetTextColour(self, int regionId=0) -> String</autodoc>
<paramlist>
<param name="regionId" type="int" default="0"/>
</paramlist>
</method>
<method name="GetNumberOfTextRegions" type="int" overloaded="no">
- <autodoc>GetNumberOfTextRegions() -> int</autodoc>
+ <autodoc>GetNumberOfTextRegions(self) -> int</autodoc>
</method>
<method name="SetRegionName" type="" overloaded="no">
- <autodoc>SetRegionName(String name, int regionId=0)</autodoc>
+ <autodoc>SetRegionName(self, String name, int regionId=0)</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="regionId" type="int" default="0"/>
</paramlist>
</method>
<method name="GetRegionName" type="String" overloaded="no">
- <autodoc>GetRegionName(int regionId) -> String</autodoc>
+ <autodoc>GetRegionName(self, int regionId) -> String</autodoc>
<paramlist>
<param name="regionId" type="int" default=""/>
</paramlist>
</method>
<method name="GetRegionId" type="int" overloaded="no">
- <autodoc>GetRegionId(String name) -> int</autodoc>
+ <autodoc>GetRegionId(self, String name) -> int</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="NameRegions" type="" overloaded="no">
- <autodoc>NameRegions(String parentName=EmptyString)</autodoc>
+ <autodoc>NameRegions(self, String parentName=EmptyString)</autodoc>
<paramlist>
<param name="parentName" type="String" default="wxPyEmptyString"/>
</paramlist>
</method>
<method name="GetRegions" type="PyObject" overloaded="no">
- <autodoc>GetRegions() -> PyObject</autodoc>
+ <autodoc>GetRegions(self) -> PyObject</autodoc>
</method>
<method name="AddRegion" type="" overloaded="no">
- <autodoc>AddRegion(ShapeRegion region)</autodoc>
+ <autodoc>AddRegion(self, ShapeRegion region)</autodoc>
<paramlist>
<param name="region" type="ShapeRegion" default=""/>
</paramlist>
</method>
<method name="ClearRegions" type="" overloaded="no">
- <autodoc>ClearRegions()</autodoc>
+ <autodoc>ClearRegions(self)</autodoc>
</method>
<method name="AssignNewIds" type="" overloaded="no">
- <autodoc>AssignNewIds()</autodoc>
+ <autodoc>AssignNewIds(self)</autodoc>
</method>
<method name="FindRegion" type="PyShape" overloaded="no">
- <autodoc>FindRegion(String regionName, int OUTPUT) -> PyShape</autodoc>
+ <autodoc>FindRegion(self, String regionName, int OUTPUT) -> PyShape</autodoc>
<paramlist>
<param name="regionName" type="String" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="FindRegionNames" type="" overloaded="no">
- <autodoc>FindRegionNames(wxStringList list)</autodoc>
+ <autodoc>FindRegionNames(self, wxStringList list)</autodoc>
<paramlist>
<param name="list" type="wxStringList" default=""/>
</paramlist>
</method>
<method name="ClearText" type="" overloaded="no">
- <autodoc>ClearText(int regionId=0)</autodoc>
+ <autodoc>ClearText(self, int regionId=0)</autodoc>
<paramlist>
<param name="regionId" type="int" default="0"/>
</paramlist>
</method>
<method name="RemoveLine" type="" overloaded="no">
- <autodoc>RemoveLine(PyLineShape line)</autodoc>
+ <autodoc>RemoveLine(self, PyLineShape line)</autodoc>
<paramlist>
<param name="line" type="wxPyLineShape" default=""/>
</paramlist>
</method>
<method name="GetAttachmentPosition" type="bool" overloaded="no">
- <autodoc>GetAttachmentPosition(int attachment, double OUTPUT, double OUTPUT, int nth=0,
+ <autodoc>GetAttachmentPosition(self, int attachment, double OUTPUT, double OUTPUT, int nth=0,
int no_arcs=1, PyLineShape line=None) -> bool</autodoc>
<paramlist>
<param name="attachment" type="int" default=""/>
</paramlist>
</method>
<method name="GetNumberOfAttachments" type="int" overloaded="no">
- <autodoc>GetNumberOfAttachments() -> int</autodoc>
+ <autodoc>GetNumberOfAttachments(self) -> int</autodoc>
</method>
<method name="AttachmentIsValid" type="bool" overloaded="no">
- <autodoc>AttachmentIsValid(int attachment) -> bool</autodoc>
+ <autodoc>AttachmentIsValid(self, int attachment) -> bool</autodoc>
<paramlist>
<param name="attachment" type="int" default=""/>
</paramlist>
</method>
<method name="GetAttachments" type="PyObject" overloaded="no">
- <autodoc>GetAttachments() -> PyObject</autodoc>
+ <autodoc>GetAttachments(self) -> PyObject</autodoc>
</method>
<method name="GetAttachmentPositionEdge" type="bool" overloaded="no">
- <autodoc>GetAttachmentPositionEdge(int attachment, double OUTPUT, double OUTPUT, int nth=0,
+ <autodoc>GetAttachmentPositionEdge(self, int attachment, double OUTPUT, double OUTPUT, int nth=0,
int no_arcs=1, PyLineShape line=None) -> bool</autodoc>
<paramlist>
<param name="attachment" type="int" default=""/>
</paramlist>
</method>
<method name="CalcSimpleAttachment" type="RealPoint" overloaded="no">
- <autodoc>CalcSimpleAttachment(RealPoint pt1, RealPoint pt2, int nth, int noArcs,
+ <autodoc>CalcSimpleAttachment(self, RealPoint pt1, RealPoint pt2, int nth, int noArcs,
PyLineShape line) -> RealPoint</autodoc>
<paramlist>
<param name="pt1" type="RealPoint" default=""/>
</paramlist>
</method>
<method name="AttachmentSortTest" type="bool" overloaded="no">
- <autodoc>AttachmentSortTest(int attachmentPoint, RealPoint pt1, RealPoint pt2) -> bool</autodoc>
+ <autodoc>AttachmentSortTest(self, int attachmentPoint, RealPoint pt1, RealPoint pt2) -> bool</autodoc>
<paramlist>
<param name="attachmentPoint" type="int" default=""/>
<param name="pt1" type="RealPoint" default=""/>
</paramlist>
</method>
<method name="EraseLinks" type="" overloaded="no">
- <autodoc>EraseLinks(DC dc, int attachment=-1, bool recurse=False)</autodoc>
+ <autodoc>EraseLinks(self, DC dc, int attachment=-1, bool recurse=False)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="attachment" type="int" default="-1"/>
</paramlist>
</method>
<method name="DrawLinks" type="" overloaded="no">
- <autodoc>DrawLinks(DC dc, int attachment=-1, bool recurse=False)</autodoc>
+ <autodoc>DrawLinks(self, DC dc, int attachment=-1, bool recurse=False)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="attachment" type="int" default="-1"/>
</paramlist>
</method>
<method name="MoveLineToNewAttachment" type="bool" overloaded="no">
- <autodoc>MoveLineToNewAttachment(DC dc, PyLineShape to_move, double x, double y) -> bool</autodoc>
+ <autodoc>MoveLineToNewAttachment(self, DC dc, PyLineShape to_move, double x, double y) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="to_move" type="wxPyLineShape" default=""/>
</paramlist>
</method>
<method name="ApplyAttachmentOrdering" type="" overloaded="no">
- <autodoc>ApplyAttachmentOrdering(PyObject linesToSort)</autodoc>
+ <autodoc>ApplyAttachmentOrdering(self, PyObject linesToSort)</autodoc>
<paramlist>
<param name="linesToSort" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetBranchingAttachmentRoot" type="RealPoint" overloaded="no">
- <autodoc>GetBranchingAttachmentRoot(int attachment) -> RealPoint</autodoc>
+ <autodoc>GetBranchingAttachmentRoot(self, int attachment) -> RealPoint</autodoc>
<paramlist>
<param name="attachment" type="int" default=""/>
</paramlist>
</method>
<method name="GetBranchingAttachmentInfo" type="bool" overloaded="no">
- <autodoc>GetBranchingAttachmentInfo(int attachment, RealPoint root, RealPoint neck, RealPoint shoulder1,
+ <autodoc>GetBranchingAttachmentInfo(self, int attachment, RealPoint root, RealPoint neck, RealPoint shoulder1,
RealPoint shoulder2) -> bool</autodoc>
<paramlist>
<param name="attachment" type="int" default=""/>
</paramlist>
</method>
<method name="GetBranchingAttachmentPoint" type="bool" overloaded="no">
- <autodoc>GetBranchingAttachmentPoint(int attachment, int n, RealPoint attachmentPoint, RealPoint stemPoint) -> bool</autodoc>
+ <autodoc>GetBranchingAttachmentPoint(self, int attachment, int n, RealPoint attachmentPoint, RealPoint stemPoint) -> bool</autodoc>
<paramlist>
<param name="attachment" type="int" default=""/>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetAttachmentLineCount" type="int" overloaded="no">
- <autodoc>GetAttachmentLineCount(int attachment) -> int</autodoc>
+ <autodoc>GetAttachmentLineCount(self, int attachment) -> int</autodoc>
<paramlist>
<param name="attachment" type="int" default=""/>
</paramlist>
</method>
<method name="SetBranchNeckLength" type="" overloaded="no">
- <autodoc>SetBranchNeckLength(int len)</autodoc>
+ <autodoc>SetBranchNeckLength(self, int len)</autodoc>
<paramlist>
<param name="len" type="int" default=""/>
</paramlist>
</method>
<method name="GetBranchNeckLength" type="int" overloaded="no">
- <autodoc>GetBranchNeckLength() -> int</autodoc>
+ <autodoc>GetBranchNeckLength(self) -> int</autodoc>
</method>
<method name="SetBranchStemLength" type="" overloaded="no">
- <autodoc>SetBranchStemLength(int len)</autodoc>
+ <autodoc>SetBranchStemLength(self, int len)</autodoc>
<paramlist>
<param name="len" type="int" default=""/>
</paramlist>
</method>
<method name="GetBranchStemLength" type="int" overloaded="no">
- <autodoc>GetBranchStemLength() -> int</autodoc>
+ <autodoc>GetBranchStemLength(self) -> int</autodoc>
</method>
<method name="SetBranchSpacing" type="" overloaded="no">
- <autodoc>SetBranchSpacing(int len)</autodoc>
+ <autodoc>SetBranchSpacing(self, int len)</autodoc>
<paramlist>
<param name="len" type="int" default=""/>
</paramlist>
</method>
<method name="GetBranchSpacing" type="int" overloaded="no">
- <autodoc>GetBranchSpacing() -> int</autodoc>
+ <autodoc>GetBranchSpacing(self) -> int</autodoc>
</method>
<method name="SetBranchStyle" type="" overloaded="no">
- <autodoc>SetBranchStyle(long style)</autodoc>
+ <autodoc>SetBranchStyle(self, long style)</autodoc>
<paramlist>
<param name="style" type="long" default=""/>
</paramlist>
</method>
<method name="GetBranchStyle" type="long" overloaded="no">
- <autodoc>GetBranchStyle() -> long</autodoc>
+ <autodoc>GetBranchStyle(self) -> long</autodoc>
</method>
<method name="PhysicalToLogicalAttachment" type="int" overloaded="no">
- <autodoc>PhysicalToLogicalAttachment(int physicalAttachment) -> int</autodoc>
+ <autodoc>PhysicalToLogicalAttachment(self, int physicalAttachment) -> int</autodoc>
<paramlist>
<param name="physicalAttachment" type="int" default=""/>
</paramlist>
</method>
<method name="LogicalToPhysicalAttachment" type="int" overloaded="no">
- <autodoc>LogicalToPhysicalAttachment(int logicalAttachment) -> int</autodoc>
+ <autodoc>LogicalToPhysicalAttachment(self, int logicalAttachment) -> int</autodoc>
<paramlist>
<param name="logicalAttachment" type="int" default=""/>
</paramlist>
</method>
<method name="Draggable" type="bool" overloaded="no">
- <autodoc>Draggable() -> bool</autodoc>
+ <autodoc>Draggable(self) -> bool</autodoc>
</method>
<method name="HasDescendant" type="bool" overloaded="no">
- <autodoc>HasDescendant(PyShape image) -> bool</autodoc>
+ <autodoc>HasDescendant(self, PyShape image) -> bool</autodoc>
<paramlist>
<param name="image" type="PyShape" default=""/>
</paramlist>
</method>
<method name="CreateNewCopy" type="PyShape" overloaded="no">
- <autodoc>CreateNewCopy(bool resetMapping=True, bool recompute=True) -> PyShape</autodoc>
+ <autodoc>CreateNewCopy(self, bool resetMapping=True, bool recompute=True) -> PyShape</autodoc>
<paramlist>
<param name="resetMapping" type="bool" default="True"/>
<param name="recompute" type="bool" default="True"/>
</paramlist>
</method>
<method name="Copy" type="" overloaded="no">
- <autodoc>Copy(PyShape copy)</autodoc>
+ <autodoc>Copy(self, PyShape copy)</autodoc>
<paramlist>
<param name="copy" type="PyShape" default=""/>
</paramlist>
</method>
<method name="CopyWithHandler" type="" overloaded="no">
- <autodoc>CopyWithHandler(PyShape copy)</autodoc>
+ <autodoc>CopyWithHandler(self, PyShape copy)</autodoc>
<paramlist>
<param name="copy" type="PyShape" default=""/>
</paramlist>
</method>
<method name="Rotate" type="" overloaded="no">
- <autodoc>Rotate(double x, double y, double theta)</autodoc>
+ <autodoc>Rotate(self, double x, double y, double theta)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="GetRotation" type="double" overloaded="no">
- <autodoc>GetRotation() -> double</autodoc>
+ <autodoc>GetRotation(self) -> double</autodoc>
</method>
<method name="SetRotation" type="" overloaded="no">
- <autodoc>SetRotation(double rotation)</autodoc>
+ <autodoc>SetRotation(self, double rotation)</autodoc>
<paramlist>
<param name="rotation" type="double" default=""/>
</paramlist>
</method>
<method name="ClearAttachments" type="" overloaded="no">
- <autodoc>ClearAttachments()</autodoc>
+ <autodoc>ClearAttachments(self)</autodoc>
</method>
<method name="Recentre" type="" overloaded="no">
- <autodoc>Recentre(DC dc)</autodoc>
+ <autodoc>Recentre(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="ClearPointList" type="" overloaded="no">
- <autodoc>ClearPointList(wxList list)</autodoc>
+ <autodoc>ClearPointList(self, wxList list)</autodoc>
<paramlist>
<param name="list" type="wxList" default=""/>
</paramlist>
</method>
<method name="GetBackgroundPen" type="Pen" overloaded="no">
- <autodoc>GetBackgroundPen() -> wxPen</autodoc>
+ <autodoc>GetBackgroundPen(self) -> wxPen</autodoc>
</method>
<method name="GetBackgroundBrush" type="Brush" overloaded="no">
- <autodoc>GetBackgroundBrush() -> wxBrush</autodoc>
+ <autodoc>GetBackgroundBrush(self) -> wxBrush</autodoc>
</method>
<method name="base_OnDelete" type="" overloaded="no">
- <autodoc>base_OnDelete()</autodoc>
+ <autodoc>base_OnDelete(self)</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=False)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=False)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="False"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="wxPyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="wxPyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="wxPyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="PseudoMetaFile" oldname="wxPseudoMetaFile" module="ogl">
<baseclass name="Object"/>
<constructor name="PseudoMetaFile" overloaded="no">
- <autodoc>__init__() -> PseudoMetaFile</autodoc>
+ <autodoc>__init__(self) -> PseudoMetaFile</autodoc>
</constructor>
<destructor name="~wxPseudoMetaFile" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Draw" type="" overloaded="no">
- <autodoc>Draw(DC dc, double xoffset, double yoffset)</autodoc>
+ <autodoc>Draw(self, DC dc, double xoffset, double yoffset)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="xoffset" type="double" default=""/>
</paramlist>
</method>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear()</autodoc>
+ <autodoc>Clear(self)</autodoc>
</method>
<method name="Copy" type="" overloaded="no">
- <autodoc>Copy(PseudoMetaFile copy)</autodoc>
+ <autodoc>Copy(self, PseudoMetaFile copy)</autodoc>
<paramlist>
<param name="copy" type="PseudoMetaFile" default=""/>
</paramlist>
</method>
<method name="Scale" type="" overloaded="no">
- <autodoc>Scale(double sx, double sy)</autodoc>
+ <autodoc>Scale(self, double sx, double sy)</autodoc>
<paramlist>
<param name="sx" type="double" default=""/>
<param name="sy" type="double" default=""/>
</paramlist>
</method>
<method name="ScaleTo" type="" overloaded="no">
- <autodoc>ScaleTo(double w, double h)</autodoc>
+ <autodoc>ScaleTo(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="Translate" type="" overloaded="no">
- <autodoc>Translate(double x, double y)</autodoc>
+ <autodoc>Translate(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="Rotate" type="" overloaded="no">
- <autodoc>Rotate(double x, double y, double theta)</autodoc>
+ <autodoc>Rotate(self, double x, double y, double theta)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="LoadFromMetaFile" type="bool" overloaded="no">
- <autodoc>LoadFromMetaFile(String filename, double width, double height) -> bool</autodoc>
+ <autodoc>LoadFromMetaFile(self, String filename, double width, double height) -> bool</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
<param name="width" type="double" default=""/>
</paramlist>
</method>
<method name="GetBounds" type="" overloaded="no">
- <autodoc>GetBounds(double minX, double minY, double maxX, double maxY)</autodoc>
+ <autodoc>GetBounds(self, double minX, double minY, double maxX, double maxY)</autodoc>
<paramlist>
<param name="minX" type="double" default=""/>
<param name="minY" type="double" default=""/>
</paramlist>
</method>
<method name="CalculateSize" type="" overloaded="no">
- <autodoc>CalculateSize(PyDrawnShape shape)</autodoc>
+ <autodoc>CalculateSize(self, PyDrawnShape shape)</autodoc>
<paramlist>
<param name="shape" type="wxPyDrawnShape" default=""/>
</paramlist>
</method>
<method name="SetRotateable" type="" overloaded="no">
- <autodoc>SetRotateable(bool rot)</autodoc>
+ <autodoc>SetRotateable(self, bool rot)</autodoc>
<paramlist>
<param name="rot" type="bool" default=""/>
</paramlist>
</method>
<method name="GetRotateable" type="bool" overloaded="no">
- <autodoc>GetRotateable() -> bool</autodoc>
+ <autodoc>GetRotateable(self) -> bool</autodoc>
</method>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(double w, double h)</autodoc>
+ <autodoc>SetSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="SetFillBrush" type="" overloaded="no">
- <autodoc>SetFillBrush(wxBrush brush)</autodoc>
+ <autodoc>SetFillBrush(self, wxBrush brush)</autodoc>
<paramlist>
<param name="brush" type="Brush" default=""/>
</paramlist>
</method>
<method name="GetFillBrush" type="Brush" overloaded="no">
- <autodoc>GetFillBrush() -> wxBrush</autodoc>
+ <autodoc>GetFillBrush(self) -> wxBrush</autodoc>
</method>
<method name="SetOutlinePen" type="" overloaded="no">
- <autodoc>SetOutlinePen(wxPen pen)</autodoc>
+ <autodoc>SetOutlinePen(self, wxPen pen)</autodoc>
<paramlist>
<param name="pen" type="Pen" default=""/>
</paramlist>
</method>
<method name="GetOutlinePen" type="Pen" overloaded="no">
- <autodoc>GetOutlinePen() -> wxPen</autodoc>
+ <autodoc>GetOutlinePen(self) -> wxPen</autodoc>
</method>
<method name="SetOutlineOp" type="" overloaded="no">
- <autodoc>SetOutlineOp(int op)</autodoc>
+ <autodoc>SetOutlineOp(self, int op)</autodoc>
<paramlist>
<param name="op" type="int" default=""/>
</paramlist>
</method>
<method name="GetOutlineOp" type="int" overloaded="no">
- <autodoc>GetOutlineOp() -> int</autodoc>
+ <autodoc>GetOutlineOp(self) -> int</autodoc>
</method>
<method name="IsValid" type="bool" overloaded="no">
- <autodoc>IsValid() -> bool</autodoc>
+ <autodoc>IsValid(self) -> bool</autodoc>
</method>
<method name="DrawLine" type="" overloaded="no">
- <autodoc>DrawLine(Point pt1, Point pt2)</autodoc>
+ <autodoc>DrawLine(self, Point pt1, Point pt2)</autodoc>
<paramlist>
<param name="pt1" type="Point" default=""/>
<param name="pt2" type="Point" default=""/>
</paramlist>
</method>
<method name="DrawRectangle" type="" overloaded="no">
- <autodoc>DrawRectangle(Rect rect)</autodoc>
+ <autodoc>DrawRectangle(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="DrawRoundedRectangle" type="" overloaded="no">
- <autodoc>DrawRoundedRectangle(Rect rect, double radius)</autodoc>
+ <autodoc>DrawRoundedRectangle(self, Rect rect, double radius)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
<param name="radius" type="double" default=""/>
</paramlist>
</method>
<method name="DrawArc" type="" overloaded="no">
- <autodoc>DrawArc(Point centrePt, Point startPt, Point endPt)</autodoc>
+ <autodoc>DrawArc(self, Point centrePt, Point startPt, Point endPt)</autodoc>
<paramlist>
<param name="centrePt" type="Point" default=""/>
<param name="startPt" type="Point" default=""/>
</paramlist>
</method>
<method name="DrawEllipticArc" type="" overloaded="no">
- <autodoc>DrawEllipticArc(Rect rect, double startAngle, double endAngle)</autodoc>
+ <autodoc>DrawEllipticArc(self, Rect rect, double startAngle, double endAngle)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
<param name="startAngle" type="double" default=""/>
</paramlist>
</method>
<method name="DrawEllipse" type="" overloaded="no">
- <autodoc>DrawEllipse(Rect rect)</autodoc>
+ <autodoc>DrawEllipse(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="DrawPoint" type="" overloaded="no">
- <autodoc>DrawPoint(Point pt)</autodoc>
+ <autodoc>DrawPoint(self, Point pt)</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="DrawText" type="" overloaded="no">
- <autodoc>DrawText(String text, Point pt)</autodoc>
+ <autodoc>DrawText(self, String text, Point pt)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="DrawLines" type="" overloaded="no">
- <autodoc>DrawLines(int PCOUNT, Point points)</autodoc>
+ <autodoc>DrawLines(self, int points, Point points_array)</autodoc>
<paramlist>
- <param name="PCOUNT" type="int" default=""/>
- <param name="points" type="Point" default=""/>
+ <param name="points" type="int" default=""/>
+ <param name="points_array" type="Point" default=""/>
</paramlist>
</method>
<method name="DrawPolygon" type="" overloaded="no">
- <autodoc>DrawPolygon(int PCOUNT, Point points, int flags=0)</autodoc>
+ <autodoc>DrawPolygon(self, int points, Point points_array, int flags=0)</autodoc>
<paramlist>
- <param name="PCOUNT" type="int" default=""/>
- <param name="points" type="Point" default=""/>
+ <param name="points" type="int" default=""/>
+ <param name="points_array" type="Point" default=""/>
<param name="flags" type="int" default="0"/>
</paramlist>
</method>
<method name="DrawSpline" type="" overloaded="no">
- <autodoc>DrawSpline(int PCOUNT, Point points)</autodoc>
+ <autodoc>DrawSpline(self, int points, Point points_array)</autodoc>
<paramlist>
- <param name="PCOUNT" type="int" default=""/>
- <param name="points" type="Point" default=""/>
+ <param name="points" type="int" default=""/>
+ <param name="points_array" type="Point" default=""/>
</paramlist>
</method>
<method name="SetClippingRect" type="" overloaded="no">
- <autodoc>SetClippingRect(Rect rect)</autodoc>
+ <autodoc>SetClippingRect(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="DestroyClippingRect" type="" overloaded="no">
- <autodoc>DestroyClippingRect()</autodoc>
+ <autodoc>DestroyClippingRect(self)</autodoc>
</method>
<method name="SetPen" type="" overloaded="no">
- <autodoc>SetPen(wxPen pen, bool isOutline=FALSE)</autodoc>
+ <autodoc>SetPen(self, wxPen pen, bool isOutline=FALSE)</autodoc>
<paramlist>
<param name="pen" type="Pen" default=""/>
<param name="isOutline" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="SetBrush" type="" overloaded="no">
- <autodoc>SetBrush(wxBrush brush, bool isFill=FALSE)</autodoc>
+ <autodoc>SetBrush(self, wxBrush brush, bool isFill=FALSE)</autodoc>
<paramlist>
<param name="brush" type="Brush" default=""/>
<param name="isFill" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="SetFont" type="" overloaded="no">
- <autodoc>SetFont(Font font)</autodoc>
+ <autodoc>SetFont(self, Font font)</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="SetTextColour" type="" overloaded="no">
- <autodoc>SetTextColour(Colour colour)</autodoc>
+ <autodoc>SetTextColour(self, Colour colour)</autodoc>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetBackgroundColour" type="" overloaded="no">
- <autodoc>SetBackgroundColour(Colour colour)</autodoc>
+ <autodoc>SetBackgroundColour(self, Colour colour)</autodoc>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetBackgroundMode" type="" overloaded="no">
- <autodoc>SetBackgroundMode(int mode)</autodoc>
+ <autodoc>SetBackgroundMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
<class name="PyRectangleShape" oldname="wxPyRectangleShape" module="ogl">
<baseclass name="PyShape"/>
<constructor name="PyRectangleShape" overloaded="no">
- <autodoc>__init__(double width=0.0, double height=0.0) -> PyRectangleShape</autodoc>
+ <autodoc>__init__(self, double width=0.0, double height=0.0) -> PyRectangleShape</autodoc>
<paramlist>
<param name="width" type="double" default="0.0"/>
<param name="height" type="double" default="0.0"/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetCornerRadius" type="" overloaded="no">
- <autodoc>SetCornerRadius(double radius)</autodoc>
+ <autodoc>SetCornerRadius(self, double radius)</autodoc>
<paramlist>
<param name="radius" type="double" default=""/>
</paramlist>
</method>
<method name="GetCornerRadius" type="double" overloaded="no">
- <autodoc>GetCornerRadius() -> double</autodoc>
+ <autodoc>GetCornerRadius(self) -> double</autodoc>
</method>
<method name="base_OnDelete" type="" overloaded="no">
- <autodoc>base_OnDelete()</autodoc>
+ <autodoc>base_OnDelete(self)</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="wxPyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="wxPyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="wxPyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="PyControlPoint" oldname="wxPyControlPoint" module="ogl">
<baseclass name="PyRectangleShape"/>
<constructor name="PyControlPoint" overloaded="no">
- <autodoc>__init__(PyShapeCanvas the_canvas=None, PyShape object=None,
+ <autodoc>__init__(self, PyShapeCanvas the_canvas=None, PyShape object=None,
double size=0.0, double the_xoffset=0.0, double the_yoffset=0.0,
int the_type=0) -> PyControlPoint</autodoc>
<paramlist>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetCornerRadius" type="" overloaded="no">
- <autodoc>SetCornerRadius(double radius)</autodoc>
+ <autodoc>SetCornerRadius(self, double radius)</autodoc>
<paramlist>
<param name="radius" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDelete" type="" overloaded="no">
- <autodoc>base_OnDelete()</autodoc>
+ <autodoc>base_OnDelete(self)</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="PyBitmapShape" oldname="wxPyBitmapShape" module="ogl">
<baseclass name="PyRectangleShape"/>
<constructor name="PyBitmapShape" overloaded="no">
- <autodoc>__init__() -> PyBitmapShape</autodoc>
+ <autodoc>__init__(self) -> PyBitmapShape</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetBitmap" type="Bitmap" overloaded="no">
- <autodoc>GetBitmap() -> Bitmap</autodoc>
+ <autodoc>GetBitmap(self) -> Bitmap</autodoc>
</method>
<method name="GetFilename" type="String" overloaded="no">
- <autodoc>GetFilename() -> String</autodoc>
+ <autodoc>GetFilename(self) -> String</autodoc>
</method>
<method name="SetBitmap" type="" overloaded="no">
- <autodoc>SetBitmap(Bitmap bitmap)</autodoc>
+ <autodoc>SetBitmap(self, Bitmap bitmap)</autodoc>
<paramlist>
<param name="bitmap" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="SetFilename" type="" overloaded="no">
- <autodoc>SetFilename(String filename)</autodoc>
+ <autodoc>SetFilename(self, String filename)</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
</paramlist>
</method>
<method name="base_OnDelete" type="" overloaded="no">
- <autodoc>base_OnDelete()</autodoc>
+ <autodoc>base_OnDelete(self)</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="PyDrawnShape" oldname="wxPyDrawnShape" module="ogl">
<baseclass name="PyRectangleShape"/>
<constructor name="PyDrawnShape" overloaded="no">
- <autodoc>__init__() -> PyDrawnShape</autodoc>
+ <autodoc>__init__(self) -> PyDrawnShape</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="CalculateSize" type="" overloaded="no">
- <autodoc>CalculateSize()</autodoc>
+ <autodoc>CalculateSize(self)</autodoc>
</method>
<method name="DestroyClippingRect" type="" overloaded="no">
- <autodoc>DestroyClippingRect()</autodoc>
+ <autodoc>DestroyClippingRect(self)</autodoc>
</method>
<method name="DrawArc" type="" overloaded="no">
- <autodoc>DrawArc(Point centrePoint, Point startPoint, Point endPoint)</autodoc>
+ <autodoc>DrawArc(self, Point centrePoint, Point startPoint, Point endPoint)</autodoc>
<paramlist>
<param name="centrePoint" type="Point" default=""/>
<param name="startPoint" type="Point" default=""/>
</paramlist>
</method>
<method name="DrawAtAngle" type="" overloaded="no">
- <autodoc>DrawAtAngle(int angle)</autodoc>
+ <autodoc>DrawAtAngle(self, int angle)</autodoc>
<paramlist>
<param name="angle" type="int" default=""/>
</paramlist>
</method>
<method name="DrawEllipticArc" type="" overloaded="no">
- <autodoc>DrawEllipticArc(Rect rect, double startAngle, double endAngle)</autodoc>
+ <autodoc>DrawEllipticArc(self, Rect rect, double startAngle, double endAngle)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
<param name="startAngle" type="double" default=""/>
</paramlist>
</method>
<method name="DrawLine" type="" overloaded="no">
- <autodoc>DrawLine(Point point1, Point point2)</autodoc>
+ <autodoc>DrawLine(self, Point point1, Point point2)</autodoc>
<paramlist>
<param name="point1" type="Point" default=""/>
<param name="point2" type="Point" default=""/>
</paramlist>
</method>
<method name="DrawLines" type="" overloaded="no">
- <autodoc>DrawLines(int PCOUNT, Point points)</autodoc>
+ <autodoc>DrawLines(self, int points, Point points_array)</autodoc>
<paramlist>
- <param name="PCOUNT" type="int" default=""/>
- <param name="points" type="Point" default=""/>
+ <param name="points" type="int" default=""/>
+ <param name="points_array" type="Point" default=""/>
</paramlist>
</method>
<method name="DrawPoint" type="" overloaded="no">
- <autodoc>DrawPoint(Point point)</autodoc>
+ <autodoc>DrawPoint(self, Point point)</autodoc>
<paramlist>
<param name="point" type="Point" default=""/>
</paramlist>
</method>
<method name="DrawPolygon" type="" overloaded="no">
- <autodoc>DrawPolygon(int PCOUNT, Point points, int flags=0)</autodoc>
+ <autodoc>DrawPolygon(self, int points, Point points_array, int flags=0)</autodoc>
<paramlist>
- <param name="PCOUNT" type="int" default=""/>
- <param name="points" type="Point" default=""/>
+ <param name="points" type="int" default=""/>
+ <param name="points_array" type="Point" default=""/>
<param name="flags" type="int" default="0"/>
</paramlist>
</method>
<method name="DrawRectangle" type="" overloaded="no">
- <autodoc>DrawRectangle(Rect rect)</autodoc>
+ <autodoc>DrawRectangle(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="DrawRoundedRectangle" type="" overloaded="no">
- <autodoc>DrawRoundedRectangle(Rect rect, double radius)</autodoc>
+ <autodoc>DrawRoundedRectangle(self, Rect rect, double radius)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
<param name="radius" type="double" default=""/>
</paramlist>
</method>
<method name="DrawSpline" type="" overloaded="no">
- <autodoc>DrawSpline(int PCOUNT, Point points)</autodoc>
+ <autodoc>DrawSpline(self, int points, Point points_array)</autodoc>
<paramlist>
- <param name="PCOUNT" type="int" default=""/>
- <param name="points" type="Point" default=""/>
+ <param name="points" type="int" default=""/>
+ <param name="points_array" type="Point" default=""/>
</paramlist>
</method>
<method name="DrawText" type="" overloaded="no">
- <autodoc>DrawText(String text, Point point)</autodoc>
+ <autodoc>DrawText(self, String text, Point point)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="point" type="Point" default=""/>
</paramlist>
</method>
<method name="GetAngle" type="int" overloaded="no">
- <autodoc>GetAngle() -> int</autodoc>
+ <autodoc>GetAngle(self) -> int</autodoc>
</method>
<method name="GetMetaFile" type="PseudoMetaFile" overloaded="no">
- <autodoc>GetMetaFile() -> PseudoMetaFile</autodoc>
+ <autodoc>GetMetaFile(self) -> PseudoMetaFile</autodoc>
</method>
<method name="GetRotation" type="double" overloaded="no">
- <autodoc>GetRotation() -> double</autodoc>
+ <autodoc>GetRotation(self) -> double</autodoc>
</method>
<method name="LoadFromMetaFile" type="bool" overloaded="no">
- <autodoc>LoadFromMetaFile(String filename) -> bool</autodoc>
+ <autodoc>LoadFromMetaFile(self, String filename) -> bool</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
</paramlist>
</method>
<method name="Rotate" type="" overloaded="no">
- <autodoc>Rotate(double x, double y, double theta)</autodoc>
+ <autodoc>Rotate(self, double x, double y, double theta)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="SetClippingRect" type="" overloaded="no">
- <autodoc>SetClippingRect(Rect rect)</autodoc>
+ <autodoc>SetClippingRect(self, Rect rect)</autodoc>
<paramlist>
<param name="rect" type="Rect" default=""/>
</paramlist>
</method>
<method name="SetDrawnBackgroundColour" type="" overloaded="no">
- <autodoc>SetDrawnBackgroundColour(Colour colour)</autodoc>
+ <autodoc>SetDrawnBackgroundColour(self, Colour colour)</autodoc>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetDrawnBackgroundMode" type="" overloaded="no">
- <autodoc>SetDrawnBackgroundMode(int mode)</autodoc>
+ <autodoc>SetDrawnBackgroundMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="SetDrawnBrush" type="" overloaded="no">
- <autodoc>SetDrawnBrush(wxBrush pen, bool isOutline=FALSE)</autodoc>
+ <autodoc>SetDrawnBrush(self, wxBrush pen, bool isOutline=FALSE)</autodoc>
<paramlist>
<param name="pen" type="Brush" default=""/>
<param name="isOutline" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="SetDrawnFont" type="" overloaded="no">
- <autodoc>SetDrawnFont(Font font)</autodoc>
+ <autodoc>SetDrawnFont(self, Font font)</autodoc>
<paramlist>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="SetDrawnPen" type="" overloaded="no">
- <autodoc>SetDrawnPen(wxPen pen, bool isOutline=FALSE)</autodoc>
+ <autodoc>SetDrawnPen(self, wxPen pen, bool isOutline=FALSE)</autodoc>
<paramlist>
<param name="pen" type="Pen" default=""/>
<param name="isOutline" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="SetDrawnTextColour" type="" overloaded="no">
- <autodoc>SetDrawnTextColour(Colour colour)</autodoc>
+ <autodoc>SetDrawnTextColour(self, Colour colour)</autodoc>
<paramlist>
<param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="Scale" type="" overloaded="no">
- <autodoc>Scale(double sx, double sy)</autodoc>
+ <autodoc>Scale(self, double sx, double sy)</autodoc>
<paramlist>
<param name="sx" type="double" default=""/>
<param name="sy" type="double" default=""/>
</paramlist>
</method>
<method name="SetSaveToFile" type="" overloaded="no">
- <autodoc>SetSaveToFile(bool save)</autodoc>
+ <autodoc>SetSaveToFile(self, bool save)</autodoc>
<paramlist>
<param name="save" type="bool" default=""/>
</paramlist>
</method>
<method name="Translate" type="" overloaded="no">
- <autodoc>Translate(double x, double y)</autodoc>
+ <autodoc>Translate(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDelete" type="" overloaded="no">
- <autodoc>base_OnDelete()</autodoc>
+ <autodoc>base_OnDelete(self)</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="OGLConstraint" oldname="wxOGLConstraint" module="ogl">
<baseclass name="Object"/>
<constructor name="OGLConstraint" overloaded="no">
- <autodoc>__init__(int type, PyShape constraining, PyObject constrained) -> OGLConstraint</autodoc>
+ <autodoc>__init__(self, int type, PyShape constraining, PyObject constrained) -> OGLConstraint</autodoc>
<paramlist>
<param name="type" type="int" default=""/>
<param name="constraining" type="PyShape" default=""/>
</paramlist>
</constructor>
<method name="Evaluate" type="bool" overloaded="no">
- <autodoc>Evaluate() -> bool</autodoc>
+ <autodoc>Evaluate(self) -> bool</autodoc>
</method>
<method name="SetSpacing" type="" overloaded="no">
- <autodoc>SetSpacing(double x, double y)</autodoc>
+ <autodoc>SetSpacing(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="Equals" type="bool" overloaded="no">
- <autodoc>Equals(double a, double b) -> bool</autodoc>
+ <autodoc>Equals(self, double a, double b) -> bool</autodoc>
<paramlist>
<param name="a" type="double" default=""/>
<param name="b" type="double" default=""/>
<class name="PyCompositeShape" oldname="wxPyCompositeShape" module="ogl">
<baseclass name="PyRectangleShape"/>
<constructor name="PyCompositeShape" overloaded="no">
- <autodoc>__init__() -> PyCompositeShape</autodoc>
+ <autodoc>__init__(self) -> PyCompositeShape</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="AddChild" type="" overloaded="no">
- <autodoc>AddChild(PyShape child, PyShape addAfter=None)</autodoc>
+ <autodoc>AddChild(self, PyShape child, PyShape addAfter=None)</autodoc>
<paramlist>
<param name="child" type="PyShape" default=""/>
<param name="addAfter" type="PyShape" default="NULL"/>
</paramlist>
</method>
<method name="AddConstraint" type="OGLConstraint" overloaded="no">
- <autodoc>AddConstraint(OGLConstraint constraint) -> OGLConstraint</autodoc>
+ <autodoc>AddConstraint(self, OGLConstraint constraint) -> OGLConstraint</autodoc>
<paramlist>
<param name="constraint" type="OGLConstraint" default=""/>
</paramlist>
</method>
<method name="AddConstrainedShapes" type="OGLConstraint" overloaded="no">
- <autodoc>AddConstrainedShapes(int type, PyShape constraining, PyObject constrained) -> OGLConstraint</autodoc>
+ <autodoc>AddConstrainedShapes(self, int type, PyShape constraining, PyObject constrained) -> OGLConstraint</autodoc>
<paramlist>
<param name="type" type="int" default=""/>
<param name="constraining" type="PyShape" default=""/>
</paramlist>
</method>
<method name="AddSimpleConstraint" type="OGLConstraint" overloaded="no">
- <autodoc>AddSimpleConstraint(int type, PyShape constraining, PyShape constrained) -> OGLConstraint</autodoc>
+ <autodoc>AddSimpleConstraint(self, int type, PyShape constraining, PyShape constrained) -> OGLConstraint</autodoc>
<paramlist>
<param name="type" type="int" default=""/>
<param name="constraining" type="PyShape" default=""/>
</paramlist>
</method>
<method name="CalculateSize" type="" overloaded="no">
- <autodoc>CalculateSize()</autodoc>
+ <autodoc>CalculateSize(self)</autodoc>
</method>
<method name="ContainsDivision" type="bool" overloaded="no">
- <autodoc>ContainsDivision(PyDivisionShape division) -> bool</autodoc>
+ <autodoc>ContainsDivision(self, PyDivisionShape division) -> bool</autodoc>
<paramlist>
<param name="division" type="wxPyDivisionShape" default=""/>
</paramlist>
</method>
<method name="DeleteConstraint" type="" overloaded="no">
- <autodoc>DeleteConstraint(OGLConstraint constraint)</autodoc>
+ <autodoc>DeleteConstraint(self, OGLConstraint constraint)</autodoc>
<paramlist>
<param name="constraint" type="OGLConstraint" default=""/>
</paramlist>
</method>
<method name="DeleteConstraintsInvolvingChild" type="" overloaded="no">
- <autodoc>DeleteConstraintsInvolvingChild(PyShape child)</autodoc>
+ <autodoc>DeleteConstraintsInvolvingChild(self, PyShape child)</autodoc>
<paramlist>
<param name="child" type="PyShape" default=""/>
</paramlist>
</method>
<method name="FindContainerImage" type="PyShape" overloaded="no">
- <autodoc>FindContainerImage() -> PyShape</autodoc>
+ <autodoc>FindContainerImage(self) -> PyShape</autodoc>
</method>
<method name="GetConstraints" type="PyObject" overloaded="no">
- <autodoc>GetConstraints() -> PyObject</autodoc>
+ <autodoc>GetConstraints(self) -> PyObject</autodoc>
</method>
<method name="GetDivisions" type="PyObject" overloaded="no">
- <autodoc>GetDivisions() -> PyObject</autodoc>
+ <autodoc>GetDivisions(self) -> PyObject</autodoc>
</method>
<method name="MakeContainer" type="" overloaded="no">
- <autodoc>MakeContainer()</autodoc>
+ <autodoc>MakeContainer(self)</autodoc>
</method>
<method name="Recompute" type="bool" overloaded="no">
- <autodoc>Recompute() -> bool</autodoc>
+ <autodoc>Recompute(self) -> bool</autodoc>
</method>
<method name="RemoveChild" type="" overloaded="no">
- <autodoc>RemoveChild(PyShape child)</autodoc>
+ <autodoc>RemoveChild(self, PyShape child)</autodoc>
<paramlist>
<param name="child" type="PyShape" default=""/>
</paramlist>
</method>
<method name="base_OnDelete" type="" overloaded="no">
- <autodoc>base_OnDelete()</autodoc>
+ <autodoc>base_OnDelete(self)</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="PyDividedShape" oldname="wxPyDividedShape" module="ogl">
<baseclass name="PyRectangleShape"/>
<constructor name="PyDividedShape" overloaded="no">
- <autodoc>__init__(double width=0.0, double height=0.0) -> PyDividedShape</autodoc>
+ <autodoc>__init__(self, double width=0.0, double height=0.0) -> PyDividedShape</autodoc>
<paramlist>
<param name="width" type="double" default="0.0"/>
<param name="height" type="double" default="0.0"/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="EditRegions" type="" overloaded="no">
- <autodoc>EditRegions()</autodoc>
+ <autodoc>EditRegions(self)</autodoc>
</method>
<method name="SetRegionSizes" type="" overloaded="no">
- <autodoc>SetRegionSizes()</autodoc>
+ <autodoc>SetRegionSizes(self)</autodoc>
</method>
<method name="base_OnDelete" type="" overloaded="no">
- <autodoc>base_OnDelete()</autodoc>
+ <autodoc>base_OnDelete(self)</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="PyDivisionShape" oldname="wxPyDivisionShape" module="ogl">
<baseclass name="PyCompositeShape"/>
<constructor name="PyDivisionShape" overloaded="no">
- <autodoc>__init__() -> PyDivisionShape</autodoc>
+ <autodoc>__init__(self) -> PyDivisionShape</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="AdjustBottom" type="" overloaded="no">
- <autodoc>AdjustBottom(double bottom, bool test)</autodoc>
+ <autodoc>AdjustBottom(self, double bottom, bool test)</autodoc>
<paramlist>
<param name="bottom" type="double" default=""/>
<param name="test" type="bool" default=""/>
</paramlist>
</method>
<method name="AdjustLeft" type="" overloaded="no">
- <autodoc>AdjustLeft(double left, bool test)</autodoc>
+ <autodoc>AdjustLeft(self, double left, bool test)</autodoc>
<paramlist>
<param name="left" type="double" default=""/>
<param name="test" type="bool" default=""/>
</paramlist>
</method>
<method name="AdjustRight" type="" overloaded="no">
- <autodoc>AdjustRight(double right, bool test)</autodoc>
+ <autodoc>AdjustRight(self, double right, bool test)</autodoc>
<paramlist>
<param name="right" type="double" default=""/>
<param name="test" type="bool" default=""/>
</paramlist>
</method>
<method name="AdjustTop" type="" overloaded="no">
- <autodoc>AdjustTop(double top, bool test)</autodoc>
+ <autodoc>AdjustTop(self, double top, bool test)</autodoc>
<paramlist>
<param name="top" type="double" default=""/>
<param name="test" type="bool" default=""/>
</paramlist>
</method>
<method name="Divide" type="" overloaded="no">
- <autodoc>Divide(int direction)</autodoc>
+ <autodoc>Divide(self, int direction)</autodoc>
<paramlist>
<param name="direction" type="int" default=""/>
</paramlist>
</method>
<method name="EditEdge" type="" overloaded="no">
- <autodoc>EditEdge(int side)</autodoc>
+ <autodoc>EditEdge(self, int side)</autodoc>
<paramlist>
<param name="side" type="int" default=""/>
</paramlist>
</method>
<method name="GetBottomSide" type="PyDivisionShape" overloaded="no">
- <autodoc>GetBottomSide() -> PyDivisionShape</autodoc>
+ <autodoc>GetBottomSide(self) -> PyDivisionShape</autodoc>
</method>
<method name="GetHandleSide" type="int" overloaded="no">
- <autodoc>GetHandleSide() -> int</autodoc>
+ <autodoc>GetHandleSide(self) -> int</autodoc>
</method>
<method name="GetLeftSide" type="PyDivisionShape" overloaded="no">
- <autodoc>GetLeftSide() -> PyDivisionShape</autodoc>
+ <autodoc>GetLeftSide(self) -> PyDivisionShape</autodoc>
</method>
<method name="GetLeftSideColour" type="String" overloaded="no">
- <autodoc>GetLeftSideColour() -> String</autodoc>
+ <autodoc>GetLeftSideColour(self) -> String</autodoc>
</method>
<method name="GetLeftSidePen" type="Pen" overloaded="no">
- <autodoc>GetLeftSidePen() -> wxPen</autodoc>
+ <autodoc>GetLeftSidePen(self) -> wxPen</autodoc>
</method>
<method name="GetRightSide" type="PyDivisionShape" overloaded="no">
- <autodoc>GetRightSide() -> PyDivisionShape</autodoc>
+ <autodoc>GetRightSide(self) -> PyDivisionShape</autodoc>
</method>
<method name="GetTopSide" type="PyDivisionShape" overloaded="no">
- <autodoc>GetTopSide() -> PyDivisionShape</autodoc>
+ <autodoc>GetTopSide(self) -> PyDivisionShape</autodoc>
</method>
<method name="GetTopSidePen" type="Pen" overloaded="no">
- <autodoc>GetTopSidePen() -> wxPen</autodoc>
+ <autodoc>GetTopSidePen(self) -> wxPen</autodoc>
</method>
<method name="ResizeAdjoining" type="" overloaded="no">
- <autodoc>ResizeAdjoining(int side, double newPos, bool test)</autodoc>
+ <autodoc>ResizeAdjoining(self, int side, double newPos, bool test)</autodoc>
<paramlist>
<param name="side" type="int" default=""/>
<param name="newPos" type="double" default=""/>
</paramlist>
</method>
<method name="PopupMenu" type="" overloaded="no">
- <autodoc>PopupMenu(double x, double y)</autodoc>
+ <autodoc>PopupMenu(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="SetBottomSide" type="" overloaded="no">
- <autodoc>SetBottomSide(PyDivisionShape shape)</autodoc>
+ <autodoc>SetBottomSide(self, PyDivisionShape shape)</autodoc>
<paramlist>
<param name="shape" type="PyDivisionShape" default=""/>
</paramlist>
</method>
<method name="SetHandleSide" type="" overloaded="no">
- <autodoc>SetHandleSide(int side)</autodoc>
+ <autodoc>SetHandleSide(self, int side)</autodoc>
<paramlist>
<param name="side" type="int" default=""/>
</paramlist>
</method>
<method name="SetLeftSide" type="" overloaded="no">
- <autodoc>SetLeftSide(PyDivisionShape shape)</autodoc>
+ <autodoc>SetLeftSide(self, PyDivisionShape shape)</autodoc>
<paramlist>
<param name="shape" type="PyDivisionShape" default=""/>
</paramlist>
</method>
<method name="SetLeftSideColour" type="" overloaded="no">
- <autodoc>SetLeftSideColour(String colour)</autodoc>
+ <autodoc>SetLeftSideColour(self, String colour)</autodoc>
<paramlist>
<param name="colour" type="String" default=""/>
</paramlist>
</method>
<method name="SetLeftSidePen" type="" overloaded="no">
- <autodoc>SetLeftSidePen(wxPen pen)</autodoc>
+ <autodoc>SetLeftSidePen(self, wxPen pen)</autodoc>
<paramlist>
<param name="pen" type="Pen" default=""/>
</paramlist>
</method>
<method name="SetRightSide" type="" overloaded="no">
- <autodoc>SetRightSide(PyDivisionShape shape)</autodoc>
+ <autodoc>SetRightSide(self, PyDivisionShape shape)</autodoc>
<paramlist>
<param name="shape" type="PyDivisionShape" default=""/>
</paramlist>
</method>
<method name="SetTopSide" type="" overloaded="no">
- <autodoc>SetTopSide(PyDivisionShape shape)</autodoc>
+ <autodoc>SetTopSide(self, PyDivisionShape shape)</autodoc>
<paramlist>
<param name="shape" type="PyDivisionShape" default=""/>
</paramlist>
</method>
<method name="SetTopSideColour" type="" overloaded="no">
- <autodoc>SetTopSideColour(String colour)</autodoc>
+ <autodoc>SetTopSideColour(self, String colour)</autodoc>
<paramlist>
<param name="colour" type="String" default=""/>
</paramlist>
</method>
<method name="SetTopSidePen" type="" overloaded="no">
- <autodoc>SetTopSidePen(wxPen pen)</autodoc>
+ <autodoc>SetTopSidePen(self, wxPen pen)</autodoc>
<paramlist>
<param name="pen" type="Pen" default=""/>
</paramlist>
</method>
<method name="base_OnDelete" type="" overloaded="no">
- <autodoc>base_OnDelete()</autodoc>
+ <autodoc>base_OnDelete(self)</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="PyEllipseShape" oldname="wxPyEllipseShape" module="ogl">
<baseclass name="PyShape"/>
<constructor name="PyEllipseShape" overloaded="no">
- <autodoc>__init__(double width=0.0, double height=0.0) -> PyEllipseShape</autodoc>
+ <autodoc>__init__(self, double width=0.0, double height=0.0) -> PyEllipseShape</autodoc>
<paramlist>
<param name="width" type="double" default="0.0"/>
<param name="height" type="double" default="0.0"/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="PyCircleShape" oldname="wxPyCircleShape" module="ogl">
<baseclass name="PyEllipseShape"/>
<constructor name="PyCircleShape" overloaded="no">
- <autodoc>__init__(double width=0.0) -> PyCircleShape</autodoc>
+ <autodoc>__init__(self, double width=0.0) -> PyCircleShape</autodoc>
<paramlist>
<param name="width" type="double" default="0.0"/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="ArrowHead" oldname="wxArrowHead" module="ogl">
<baseclass name="Object"/>
<constructor name="ArrowHead" overloaded="no">
- <autodoc>__init__(int type=0, int end=0, double size=0.0, double dist=0.0,
+ <autodoc>__init__(self, int type=0, int end=0, double size=0.0, double dist=0.0,
String name=EmptyString, PseudoMetaFile mf=None,
long arrowId=-1) -> ArrowHead</autodoc>
<paramlist>
</paramlist>
</constructor>
<destructor name="~wxArrowHead" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="_GetType" type="int" overloaded="no">
- <autodoc>_GetType() -> int</autodoc>
+ <autodoc>_GetType(self) -> int</autodoc>
</method>
<method name="GetPosition" type="int" overloaded="no">
- <autodoc>GetPosition() -> int</autodoc>
+ <autodoc>GetPosition(self) -> int</autodoc>
</method>
<method name="SetPosition" type="" overloaded="no">
- <autodoc>SetPosition(int pos)</autodoc>
+ <autodoc>SetPosition(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="GetXOffset" type="double" overloaded="no">
- <autodoc>GetXOffset() -> double</autodoc>
+ <autodoc>GetXOffset(self) -> double</autodoc>
</method>
<method name="GetYOffset" type="double" overloaded="no">
- <autodoc>GetYOffset() -> double</autodoc>
+ <autodoc>GetYOffset(self) -> double</autodoc>
</method>
<method name="GetSpacing" type="double" overloaded="no">
- <autodoc>GetSpacing() -> double</autodoc>
+ <autodoc>GetSpacing(self) -> double</autodoc>
</method>
<method name="GetSize" type="double" overloaded="no">
- <autodoc>GetSize() -> double</autodoc>
+ <autodoc>GetSize(self) -> double</autodoc>
</method>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
+ <autodoc>GetName(self) -> String</autodoc>
</method>
<method name="SetXOffset" type="" overloaded="no">
- <autodoc>SetXOffset(double x)</autodoc>
+ <autodoc>SetXOffset(self, double x)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="SetYOffset" type="" overloaded="no">
- <autodoc>SetYOffset(double y)</autodoc>
+ <autodoc>SetYOffset(self, double y)</autodoc>
<paramlist>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="GetMetaFile" type="PseudoMetaFile" overloaded="no">
- <autodoc>GetMetaFile() -> PseudoMetaFile</autodoc>
+ <autodoc>GetMetaFile(self) -> PseudoMetaFile</autodoc>
</method>
<method name="GetId" type="long" overloaded="no">
- <autodoc>GetId() -> long</autodoc>
+ <autodoc>GetId(self) -> long</autodoc>
</method>
<method name="GetArrowEnd" type="int" overloaded="no">
- <autodoc>GetArrowEnd() -> int</autodoc>
+ <autodoc>GetArrowEnd(self) -> int</autodoc>
</method>
<method name="GetArrowSize" type="double" overloaded="no">
- <autodoc>GetArrowSize() -> double</autodoc>
+ <autodoc>GetArrowSize(self) -> double</autodoc>
</method>
<method name="SetSize" type="" overloaded="no">
- <autodoc>SetSize(double size)</autodoc>
+ <autodoc>SetSize(self, double size)</autodoc>
<paramlist>
<param name="size" type="double" default=""/>
</paramlist>
</method>
<method name="SetSpacing" type="" overloaded="no">
- <autodoc>SetSpacing(double sp)</autodoc>
+ <autodoc>SetSpacing(self, double sp)</autodoc>
<paramlist>
<param name="sp" type="double" default=""/>
</paramlist>
<class name="PyLineShape" oldname="wxPyLineShape" module="ogl">
<baseclass name="PyShape"/>
<constructor name="PyLineShape" overloaded="no">
- <autodoc>__init__() -> PyLineShape</autodoc>
+ <autodoc>__init__(self) -> PyLineShape</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="AddArrow" type="" overloaded="no">
- <autodoc>AddArrow(int type, int end=ARROW_POSITION_END, double arrowSize=10.0,
+ <autodoc>AddArrow(self, int type, int end=ARROW_POSITION_END, double arrowSize=10.0,
double xOffset=0.0, String name=EmptyString,
PseudoMetaFile mf=None, long arrowId=-1)</autodoc>
<paramlist>
</paramlist>
</method>
<method name="AddArrowOrdered" type="" overloaded="no">
- <autodoc>AddArrowOrdered(ArrowHead arrow, PyObject referenceList, int end)</autodoc>
+ <autodoc>AddArrowOrdered(self, ArrowHead arrow, PyObject referenceList, int end)</autodoc>
<paramlist>
<param name="arrow" type="ArrowHead" default=""/>
<param name="referenceList" type="PyObject" default=""/>
</paramlist>
</method>
<method name="ClearArrow" type="bool" overloaded="no">
- <autodoc>ClearArrow(String name) -> bool</autodoc>
+ <autodoc>ClearArrow(self, String name) -> bool</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="ClearArrowsAtPosition" type="" overloaded="no">
- <autodoc>ClearArrowsAtPosition(int position=-1)</autodoc>
+ <autodoc>ClearArrowsAtPosition(self, int position=-1)</autodoc>
<paramlist>
<param name="position" type="int" default="-1"/>
</paramlist>
</method>
<method name="DrawArrow" type="" overloaded="no">
- <autodoc>DrawArrow(DC dc, ArrowHead arrow, double xOffset, bool proportionalOffset)</autodoc>
+ <autodoc>DrawArrow(self, DC dc, ArrowHead arrow, double xOffset, bool proportionalOffset)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="arrow" type="ArrowHead" default=""/>
</paramlist>
</method>
<method name="DeleteArrowHeadId" type="bool" overloaded="no">
- <autodoc>DeleteArrowHeadId(long arrowId) -> bool</autodoc>
+ <autodoc>DeleteArrowHeadId(self, long arrowId) -> bool</autodoc>
<paramlist>
<param name="arrowId" type="long" default=""/>
</paramlist>
</method>
<method name="DeleteArrowHead" type="bool" overloaded="no">
- <autodoc>DeleteArrowHead(int position, String name) -> bool</autodoc>
+ <autodoc>DeleteArrowHead(self, int position, String name) -> bool</autodoc>
<paramlist>
<param name="position" type="int" default=""/>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="DeleteLineControlPoint" type="bool" overloaded="no">
- <autodoc>DeleteLineControlPoint() -> bool</autodoc>
+ <autodoc>DeleteLineControlPoint(self) -> bool</autodoc>
</method>
<method name="DrawArrows" type="" overloaded="no">
- <autodoc>DrawArrows(DC dc)</autodoc>
+ <autodoc>DrawArrows(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="DrawRegion" type="" overloaded="no">
- <autodoc>DrawRegion(DC dc, ShapeRegion region, double x, double y)</autodoc>
+ <autodoc>DrawRegion(self, DC dc, ShapeRegion region, double x, double y)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="region" type="ShapeRegion" default=""/>
</paramlist>
</method>
<method name="EraseRegion" type="" overloaded="no">
- <autodoc>EraseRegion(DC dc, ShapeRegion region, double x, double y)</autodoc>
+ <autodoc>EraseRegion(self, DC dc, ShapeRegion region, double x, double y)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="region" type="ShapeRegion" default=""/>
</paramlist>
</method>
<method name="FindArrowHeadId" type="ArrowHead" overloaded="no">
- <autodoc>FindArrowHeadId(long arrowId) -> ArrowHead</autodoc>
+ <autodoc>FindArrowHeadId(self, long arrowId) -> ArrowHead</autodoc>
<paramlist>
<param name="arrowId" type="long" default=""/>
</paramlist>
</method>
<method name="FindArrowHead" type="ArrowHead" overloaded="no">
- <autodoc>FindArrowHead(int position, String name) -> ArrowHead</autodoc>
+ <autodoc>FindArrowHead(self, int position, String name) -> ArrowHead</autodoc>
<paramlist>
<param name="position" type="int" default=""/>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="FindLineEndPoints" type="" overloaded="no">
- <autodoc>FindLineEndPoints(double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT)</autodoc>
+ <autodoc>FindLineEndPoints(self, double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT)</autodoc>
<paramlist>
<param name="OUTPUT" type="double" default=""/>
<param name="OUTPUT" type="double" default=""/>
</paramlist>
</method>
<method name="FindLinePosition" type="int" overloaded="no">
- <autodoc>FindLinePosition(double x, double y) -> int</autodoc>
+ <autodoc>FindLinePosition(self, double x, double y) -> int</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="FindMinimumWidth" type="double" overloaded="no">
- <autodoc>FindMinimumWidth() -> double</autodoc>
+ <autodoc>FindMinimumWidth(self) -> double</autodoc>
</method>
<method name="FindNth" type="" overloaded="no">
- <autodoc>FindNth(PyShape image, int OUTPUT, int OUTPUT, bool incoming)</autodoc>
+ <autodoc>FindNth(self, PyShape image, int OUTPUT, int OUTPUT, bool incoming)</autodoc>
<paramlist>
<param name="image" type="PyShape" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="GetAttachmentFrom" type="int" overloaded="no">
- <autodoc>GetAttachmentFrom() -> int</autodoc>
+ <autodoc>GetAttachmentFrom(self) -> int</autodoc>
</method>
<method name="GetAttachmentTo" type="int" overloaded="no">
- <autodoc>GetAttachmentTo() -> int</autodoc>
+ <autodoc>GetAttachmentTo(self) -> int</autodoc>
</method>
<method name="GetEnds" type="" overloaded="no">
- <autodoc>GetEnds(double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT)</autodoc>
+ <autodoc>GetEnds(self, double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT)</autodoc>
<paramlist>
<param name="OUTPUT" type="double" default=""/>
<param name="OUTPUT" type="double" default=""/>
</paramlist>
</method>
<method name="GetFrom" type="PyShape" overloaded="no">
- <autodoc>GetFrom() -> PyShape</autodoc>
+ <autodoc>GetFrom(self) -> PyShape</autodoc>
</method>
<method name="GetLabelPosition" type="" overloaded="no">
- <autodoc>GetLabelPosition(int position, double OUTPUT, double OUTPUT)</autodoc>
+ <autodoc>GetLabelPosition(self, int position, double OUTPUT, double OUTPUT)</autodoc>
<paramlist>
<param name="position" type="int" default=""/>
<param name="OUTPUT" type="double" default=""/>
</paramlist>
</method>
<method name="GetNextControlPoint" type="RealPoint" overloaded="no">
- <autodoc>GetNextControlPoint(PyShape shape) -> RealPoint</autodoc>
+ <autodoc>GetNextControlPoint(self, PyShape shape) -> RealPoint</autodoc>
<paramlist>
<param name="shape" type="PyShape" default=""/>
</paramlist>
</method>
<method name="GetTo" type="PyShape" overloaded="no">
- <autodoc>GetTo() -> PyShape</autodoc>
+ <autodoc>GetTo(self) -> PyShape</autodoc>
</method>
<method name="Initialise" type="" overloaded="no">
- <autodoc>Initialise()</autodoc>
+ <autodoc>Initialise(self)</autodoc>
</method>
<method name="InsertLineControlPoint" type="" overloaded="no">
- <autodoc>InsertLineControlPoint(DC dc)</autodoc>
+ <autodoc>InsertLineControlPoint(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="IsEnd" type="bool" overloaded="no">
- <autodoc>IsEnd(PyShape shape) -> bool</autodoc>
+ <autodoc>IsEnd(self, PyShape shape) -> bool</autodoc>
<paramlist>
<param name="shape" type="PyShape" default=""/>
</paramlist>
</method>
<method name="IsSpline" type="bool" overloaded="no">
- <autodoc>IsSpline() -> bool</autodoc>
+ <autodoc>IsSpline(self) -> bool</autodoc>
</method>
<method name="MakeLineControlPoints" type="" overloaded="no">
- <autodoc>MakeLineControlPoints(int n)</autodoc>
+ <autodoc>MakeLineControlPoints(self, int n)</autodoc>
<paramlist>
<param name="n" type="int" default=""/>
</paramlist>
</method>
<method name="GetLineControlPoints" type="PyObject" overloaded="no">
- <autodoc>GetLineControlPoints() -> PyObject</autodoc>
+ <autodoc>GetLineControlPoints(self) -> PyObject</autodoc>
+ </method>
+ <method name="SetLineControlPoints" type="" overloaded="no">
+ <autodoc>SetLineControlPoints(self, PyObject list)</autodoc>
+ <paramlist>
+ <param name="list" type="PyObject" default=""/>
+ </paramlist>
</method>
<method name="SetAttachmentFrom" type="" overloaded="no">
- <autodoc>SetAttachmentFrom(int fromAttach)</autodoc>
+ <autodoc>SetAttachmentFrom(self, int fromAttach)</autodoc>
<paramlist>
<param name="fromAttach" type="int" default=""/>
</paramlist>
</method>
<method name="SetAttachments" type="" overloaded="no">
- <autodoc>SetAttachments(int fromAttach, int toAttach)</autodoc>
+ <autodoc>SetAttachments(self, int fromAttach, int toAttach)</autodoc>
<paramlist>
<param name="fromAttach" type="int" default=""/>
<param name="toAttach" type="int" default=""/>
</paramlist>
</method>
<method name="SetAttachmentTo" type="" overloaded="no">
- <autodoc>SetAttachmentTo(int toAttach)</autodoc>
+ <autodoc>SetAttachmentTo(self, int toAttach)</autodoc>
<paramlist>
<param name="toAttach" type="int" default=""/>
</paramlist>
</method>
<method name="SetEnds" type="" overloaded="no">
- <autodoc>SetEnds(double x1, double y1, double x2, double y2)</autodoc>
+ <autodoc>SetEnds(self, double x1, double y1, double x2, double y2)</autodoc>
<paramlist>
<param name="x1" type="double" default=""/>
<param name="y1" type="double" default=""/>
</paramlist>
</method>
<method name="SetFrom" type="" overloaded="no">
- <autodoc>SetFrom(PyShape object)</autodoc>
+ <autodoc>SetFrom(self, PyShape object)</autodoc>
<paramlist>
<param name="object" type="PyShape" default=""/>
</paramlist>
</method>
<method name="SetIgnoreOffsets" type="" overloaded="no">
- <autodoc>SetIgnoreOffsets(bool ignore)</autodoc>
+ <autodoc>SetIgnoreOffsets(self, bool ignore)</autodoc>
<paramlist>
<param name="ignore" type="bool" default=""/>
</paramlist>
</method>
<method name="SetSpline" type="" overloaded="no">
- <autodoc>SetSpline(bool spline)</autodoc>
+ <autodoc>SetSpline(self, bool spline)</autodoc>
<paramlist>
<param name="spline" type="bool" default=""/>
</paramlist>
</method>
<method name="SetTo" type="" overloaded="no">
- <autodoc>SetTo(PyShape object)</autodoc>
+ <autodoc>SetTo(self, PyShape object)</autodoc>
<paramlist>
<param name="object" type="PyShape" default=""/>
</paramlist>
</method>
<method name="Straighten" type="" overloaded="no">
- <autodoc>Straighten(DC dc=None)</autodoc>
+ <autodoc>Straighten(self, DC dc=None)</autodoc>
<paramlist>
<param name="dc" type="DC" default="NULL"/>
</paramlist>
</method>
<method name="Unlink" type="" overloaded="no">
- <autodoc>Unlink()</autodoc>
+ <autodoc>Unlink(self)</autodoc>
</method>
<method name="SetAlignmentOrientation" type="" overloaded="no">
- <autodoc>SetAlignmentOrientation(bool isEnd, bool isHoriz)</autodoc>
+ <autodoc>SetAlignmentOrientation(self, bool isEnd, bool isHoriz)</autodoc>
<paramlist>
<param name="isEnd" type="bool" default=""/>
<param name="isHoriz" type="bool" default=""/>
</paramlist>
</method>
<method name="SetAlignmentType" type="" overloaded="no">
- <autodoc>SetAlignmentType(bool isEnd, int alignType)</autodoc>
+ <autodoc>SetAlignmentType(self, bool isEnd, int alignType)</autodoc>
<paramlist>
<param name="isEnd" type="bool" default=""/>
<param name="alignType" type="int" default=""/>
</paramlist>
</method>
<method name="GetAlignmentOrientation" type="bool" overloaded="no">
- <autodoc>GetAlignmentOrientation(bool isEnd) -> bool</autodoc>
+ <autodoc>GetAlignmentOrientation(self, bool isEnd) -> bool</autodoc>
<paramlist>
<param name="isEnd" type="bool" default=""/>
</paramlist>
</method>
<method name="GetAlignmentType" type="int" overloaded="no">
- <autodoc>GetAlignmentType(bool isEnd) -> int</autodoc>
+ <autodoc>GetAlignmentType(self, bool isEnd) -> int</autodoc>
<paramlist>
<param name="isEnd" type="bool" default=""/>
</paramlist>
</method>
<method name="GetAlignmentStart" type="int" overloaded="no">
- <autodoc>GetAlignmentStart() -> int</autodoc>
+ <autodoc>GetAlignmentStart(self) -> int</autodoc>
</method>
<method name="GetAlignmentEnd" type="int" overloaded="no">
- <autodoc>GetAlignmentEnd() -> int</autodoc>
+ <autodoc>GetAlignmentEnd(self) -> int</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="PyPolygonShape" oldname="wxPyPolygonShape" module="ogl">
<baseclass name="PyShape"/>
<constructor name="PyPolygonShape" overloaded="no">
- <autodoc>__init__() -> PyPolygonShape</autodoc>
+ <autodoc>__init__(self) -> PyPolygonShape</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="Create" type="PyObject" overloaded="no">
- <autodoc>Create(PyObject points) -> PyObject</autodoc>
+ <autodoc>Create(self, PyObject points) -> PyObject</autodoc>
<paramlist>
<param name="points" type="PyObject" default=""/>
</paramlist>
</method>
<method name="AddPolygonPoint" type="" overloaded="no">
- <autodoc>AddPolygonPoint(int pos=0)</autodoc>
+ <autodoc>AddPolygonPoint(self, int pos=0)</autodoc>
<paramlist>
<param name="pos" type="int" default="0"/>
</paramlist>
</method>
<method name="CalculatePolygonCentre" type="" overloaded="no">
- <autodoc>CalculatePolygonCentre()</autodoc>
+ <autodoc>CalculatePolygonCentre(self)</autodoc>
</method>
<method name="DeletePolygonPoint" type="" overloaded="no">
- <autodoc>DeletePolygonPoint(int pos=0)</autodoc>
+ <autodoc>DeletePolygonPoint(self, int pos=0)</autodoc>
<paramlist>
<param name="pos" type="int" default="0"/>
</paramlist>
</method>
<method name="GetPoints" type="PyObject" overloaded="no">
- <autodoc>GetPoints() -> PyObject</autodoc>
+ <autodoc>GetPoints(self) -> PyObject</autodoc>
</method>
<method name="GetOriginalPoints" type="PyObject" overloaded="no">
- <autodoc>GetOriginalPoints() -> PyObject</autodoc>
+ <autodoc>GetOriginalPoints(self) -> PyObject</autodoc>
</method>
<method name="GetOriginalWidth" type="double" overloaded="no">
- <autodoc>GetOriginalWidth() -> double</autodoc>
+ <autodoc>GetOriginalWidth(self) -> double</autodoc>
</method>
<method name="GetOriginalHeight" type="double" overloaded="no">
- <autodoc>GetOriginalHeight() -> double</autodoc>
+ <autodoc>GetOriginalHeight(self) -> double</autodoc>
</method>
<method name="SetOriginalWidth" type="" overloaded="no">
- <autodoc>SetOriginalWidth(double w)</autodoc>
+ <autodoc>SetOriginalWidth(self, double w)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
</paramlist>
</method>
<method name="SetOriginalHeight" type="" overloaded="no">
- <autodoc>SetOriginalHeight(double h)</autodoc>
+ <autodoc>SetOriginalHeight(self, double h)</autodoc>
<paramlist>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="UpdateOriginalPoints" type="" overloaded="no">
- <autodoc>UpdateOriginalPoints()</autodoc>
+ <autodoc>UpdateOriginalPoints(self)</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="PyTextShape" oldname="wxPyTextShape" module="ogl">
<baseclass name="PyRectangleShape"/>
<constructor name="PyTextShape" overloaded="no">
- <autodoc>__init__(double width=0.0, double height=0.0) -> PyTextShape</autodoc>
+ <autodoc>__init__(self, double width=0.0, double height=0.0) -> PyTextShape</autodoc>
<paramlist>
<param name="width" type="double" default="0.0"/>
<param name="height" type="double" default="0.0"/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="base_OnDelete" type="" overloaded="no">
- <autodoc>base_OnDelete()</autodoc>
+ <autodoc>base_OnDelete(self)</autodoc>
</method>
<method name="base_OnDraw" type="" overloaded="no">
- <autodoc>base_OnDraw(DC dc)</autodoc>
+ <autodoc>base_OnDraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawContents" type="" overloaded="no">
- <autodoc>base_OnDrawContents(DC dc)</autodoc>
+ <autodoc>base_OnDrawContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDrawBranches" type="" overloaded="no">
- <autodoc>base_OnDrawBranches(DC dc, bool erase=FALSE)</autodoc>
+ <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="erase" type="bool" default="FALSE"/>
</paramlist>
</method>
<method name="base_OnMoveLinks" type="" overloaded="no">
- <autodoc>base_OnMoveLinks(DC dc)</autodoc>
+ <autodoc>base_OnMoveLinks(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnErase" type="" overloaded="no">
- <autodoc>base_OnErase(DC dc)</autodoc>
+ <autodoc>base_OnErase(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseContents" type="" overloaded="no">
- <autodoc>base_OnEraseContents(DC dc)</autodoc>
+ <autodoc>base_OnEraseContents(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnHighlight" type="" overloaded="no">
- <autodoc>base_OnHighlight(DC dc)</autodoc>
+ <autodoc>base_OnHighlight(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftDoubleClick" type="" overloaded="no">
- <autodoc>base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnSize" type="" overloaded="no">
- <autodoc>base_OnSize(double x, double y)</autodoc>
+ <autodoc>base_OnSize(self, double x, double y)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnMovePre" type="bool" overloaded="no">
- <autodoc>base_OnMovePre(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True) -> bool</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMovePost" type="" overloaded="no">
- <autodoc>base_OnMovePost(DC dc, double x, double y, double old_x, double old_y,
+ <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
bool display=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0, int attachment=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawOutline" type="" overloaded="no">
- <autodoc>base_OnDrawOutline(DC dc, double x, double y, double w, double h)</autodoc>
+ <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDrawControlPoints" type="" overloaded="no">
- <autodoc>base_OnDrawControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnEraseControlPoints" type="" overloaded="no">
- <autodoc>base_OnEraseControlPoints(DC dc)</autodoc>
+ <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="base_OnMoveLink" type="" overloaded="no">
- <autodoc>base_OnMoveLink(DC dc, bool moveControlPoints=True)</autodoc>
+ <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="moveControlPoints" type="bool" default="True"/>
</paramlist>
</method>
<method name="base_OnSizingDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0,
+ <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnSizingEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0,
+ <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0,
int attachment=0)</autodoc>
<paramlist>
<param name="pt" type="PyControlPoint" default=""/>
</paramlist>
</method>
<method name="base_OnBeginSize" type="" overloaded="no">
- <autodoc>base_OnBeginSize(double w, double h)</autodoc>
+ <autodoc>base_OnBeginSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndSize" type="" overloaded="no">
- <autodoc>base_OnEndSize(double w, double h)</autodoc>
+ <autodoc>base_OnEndSize(self, double w, double h)</autodoc>
<paramlist>
<param name="w" type="double" default=""/>
<param name="h" type="double" default=""/>
<class name="Diagram" oldname="wxDiagram" module="ogl">
<baseclass name="Object"/>
<constructor name="Diagram" overloaded="no">
- <autodoc>__init__() -> Diagram</autodoc>
+ <autodoc>__init__(self) -> Diagram</autodoc>
</constructor>
<method name="AddShape" type="" overloaded="no">
- <autodoc>AddShape(PyShape shape, PyShape addAfter=None)</autodoc>
+ <autodoc>AddShape(self, PyShape shape, PyShape addAfter=None)</autodoc>
<paramlist>
<param name="shape" type="PyShape" default=""/>
<param name="addAfter" type="PyShape" default="NULL"/>
</paramlist>
</method>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear(DC dc)</autodoc>
+ <autodoc>Clear(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="DeleteAllShapes" type="" overloaded="no">
- <autodoc>DeleteAllShapes()</autodoc>
+ <autodoc>DeleteAllShapes(self)</autodoc>
</method>
<method name="DrawOutline" type="" overloaded="no">
- <autodoc>DrawOutline(DC dc, double x1, double y1, double x2, double y2)</autodoc>
+ <autodoc>DrawOutline(self, DC dc, double x1, double y1, double x2, double y2)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
<param name="x1" type="double" default=""/>
</paramlist>
</method>
<method name="FindShape" type="PyShape" overloaded="no">
- <autodoc>FindShape(long id) -> PyShape</autodoc>
+ <autodoc>FindShape(self, long id) -> PyShape</autodoc>
<paramlist>
<param name="id" type="long" default=""/>
</paramlist>
</method>
<method name="GetCanvas" type="wxPyShapeCanvas" overloaded="no">
- <autodoc>GetCanvas() -> PyShapeCanvas</autodoc>
+ <autodoc>GetCanvas(self) -> PyShapeCanvas</autodoc>
</method>
<method name="GetCount" type="int" overloaded="no">
- <autodoc>GetCount() -> int</autodoc>
+ <autodoc>GetCount(self) -> int</autodoc>
</method>
<method name="GetGridSpacing" type="double" overloaded="no">
- <autodoc>GetGridSpacing() -> double</autodoc>
+ <autodoc>GetGridSpacing(self) -> double</autodoc>
</method>
<method name="GetMouseTolerance" type="int" overloaded="no">
- <autodoc>GetMouseTolerance() -> int</autodoc>
+ <autodoc>GetMouseTolerance(self) -> int</autodoc>
</method>
<method name="GetShapeList" type="PyObject" overloaded="no">
- <autodoc>GetShapeList() -> PyObject</autodoc>
+ <autodoc>GetShapeList(self) -> PyObject</autodoc>
</method>
<method name="GetQuickEditMode" type="bool" overloaded="no">
- <autodoc>GetQuickEditMode() -> bool</autodoc>
+ <autodoc>GetQuickEditMode(self) -> bool</autodoc>
</method>
<method name="GetSnapToGrid" type="bool" overloaded="no">
- <autodoc>GetSnapToGrid() -> bool</autodoc>
+ <autodoc>GetSnapToGrid(self) -> bool</autodoc>
</method>
<method name="InsertShape" type="" overloaded="no">
- <autodoc>InsertShape(PyShape shape)</autodoc>
+ <autodoc>InsertShape(self, PyShape shape)</autodoc>
<paramlist>
<param name="shape" type="PyShape" default=""/>
</paramlist>
</method>
<method name="RecentreAll" type="" overloaded="no">
- <autodoc>RecentreAll(DC dc)</autodoc>
+ <autodoc>RecentreAll(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="Redraw" type="" overloaded="no">
- <autodoc>Redraw(DC dc)</autodoc>
+ <autodoc>Redraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="RemoveAllShapes" type="" overloaded="no">
- <autodoc>RemoveAllShapes()</autodoc>
+ <autodoc>RemoveAllShapes(self)</autodoc>
</method>
<method name="RemoveShape" type="" overloaded="no">
- <autodoc>RemoveShape(PyShape shape)</autodoc>
+ <autodoc>RemoveShape(self, PyShape shape)</autodoc>
<paramlist>
<param name="shape" type="PyShape" default=""/>
</paramlist>
</method>
<method name="SetCanvas" type="" overloaded="no">
- <autodoc>SetCanvas(PyShapeCanvas canvas)</autodoc>
+ <autodoc>SetCanvas(self, PyShapeCanvas canvas)</autodoc>
<paramlist>
<param name="canvas" type="wxPyShapeCanvas" default=""/>
</paramlist>
</method>
<method name="SetGridSpacing" type="" overloaded="no">
- <autodoc>SetGridSpacing(double spacing)</autodoc>
+ <autodoc>SetGridSpacing(self, double spacing)</autodoc>
<paramlist>
<param name="spacing" type="double" default=""/>
</paramlist>
</method>
<method name="SetMouseTolerance" type="" overloaded="no">
- <autodoc>SetMouseTolerance(int tolerance)</autodoc>
+ <autodoc>SetMouseTolerance(self, int tolerance)</autodoc>
<paramlist>
<param name="tolerance" type="int" default=""/>
</paramlist>
</method>
<method name="SetQuickEditMode" type="" overloaded="no">
- <autodoc>SetQuickEditMode(bool mode)</autodoc>
+ <autodoc>SetQuickEditMode(self, bool mode)</autodoc>
<paramlist>
<param name="mode" type="bool" default=""/>
</paramlist>
</method>
<method name="SetSnapToGrid" type="" overloaded="no">
- <autodoc>SetSnapToGrid(bool snap)</autodoc>
+ <autodoc>SetSnapToGrid(self, bool snap)</autodoc>
<paramlist>
<param name="snap" type="bool" default=""/>
</paramlist>
</method>
<method name="ShowAll" type="" overloaded="no">
- <autodoc>ShowAll(bool show)</autodoc>
+ <autodoc>ShowAll(self, bool show)</autodoc>
<paramlist>
<param name="show" type="bool" default=""/>
</paramlist>
</method>
<method name="Snap" type="" overloaded="no">
- <autodoc>Snap(double INOUT, double INOUT)</autodoc>
+ <autodoc>Snap(self, double INOUT, double INOUT)</autodoc>
<paramlist>
<param name="INOUT" type="double" default=""/>
<param name="INOUT" type="double" default=""/>
<class name="PyShapeCanvas" oldname="wxPyShapeCanvas" module="ogl">
<baseclass name="ScrolledWindow"/>
<constructor name="PyShapeCanvas" overloaded="no">
- <autodoc>__init__(Window parent=None, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent=None, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=BORDER,
String name=wxPyShapeCanvasNameStr) -> PyShapeCanvas</autodoc>
<paramlist>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="AddShape" type="" overloaded="no">
- <autodoc>AddShape(PyShape shape, PyShape addAfter=None)</autodoc>
+ <autodoc>AddShape(self, PyShape shape, PyShape addAfter=None)</autodoc>
<paramlist>
<param name="shape" type="PyShape" default=""/>
<param name="addAfter" type="PyShape" default="NULL"/>
</paramlist>
</method>
<method name="FindShape" type="PyShape" overloaded="no">
- <autodoc>FindShape(double x1, double y, int OUTPUT, wxClassInfo info=None,
+ <autodoc>FindShape(self, double x1, double y, int OUTPUT, wxClassInfo info=None,
PyShape notImage=None) -> PyShape</autodoc>
<paramlist>
<param name="x1" type="double" default=""/>
</paramlist>
</method>
<method name="FindFirstSensitiveShape" type="PyShape" overloaded="no">
- <autodoc>FindFirstSensitiveShape(double x1, double y, int OUTPUT, int op) -> PyShape</autodoc>
+ <autodoc>FindFirstSensitiveShape(self, double x1, double y, int OUTPUT, int op) -> PyShape</autodoc>
<paramlist>
<param name="x1" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="GetDiagram" type="Diagram" overloaded="no">
- <autodoc>GetDiagram() -> Diagram</autodoc>
+ <autodoc>GetDiagram(self) -> Diagram</autodoc>
</method>
<method name="GetQuickEditMode" type="bool" overloaded="no">
- <autodoc>GetQuickEditMode() -> bool</autodoc>
+ <autodoc>GetQuickEditMode(self) -> bool</autodoc>
</method>
<method name="InsertShape" type="" overloaded="no">
- <autodoc>InsertShape(PyShape shape)</autodoc>
+ <autodoc>InsertShape(self, PyShape shape)</autodoc>
<paramlist>
<param name="shape" type="PyShape" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragLeft" type="" overloaded="no">
- <autodoc>base_OnBeginDragLeft(double x, double y, int keys=0)</autodoc>
+ <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnBeginDragRight" type="" overloaded="no">
- <autodoc>base_OnBeginDragRight(double x, double y, int keys=0)</autodoc>
+ <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragLeft" type="" overloaded="no">
- <autodoc>base_OnEndDragLeft(double x, double y, int keys=0)</autodoc>
+ <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnEndDragRight" type="" overloaded="no">
- <autodoc>base_OnEndDragRight(double x, double y, int keys=0)</autodoc>
+ <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragLeft" type="" overloaded="no">
- <autodoc>base_OnDragLeft(bool draw, double x, double y, int keys=0)</autodoc>
+ <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnDragRight" type="" overloaded="no">
- <autodoc>base_OnDragRight(bool draw, double x, double y, int keys=0)</autodoc>
+ <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0)</autodoc>
<paramlist>
<param name="draw" type="bool" default=""/>
<param name="x" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnLeftClick" type="" overloaded="no">
- <autodoc>base_OnLeftClick(double x, double y, int keys=0)</autodoc>
+ <autodoc>base_OnLeftClick(self, double x, double y, int keys=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="base_OnRightClick" type="" overloaded="no">
- <autodoc>base_OnRightClick(double x, double y, int keys=0)</autodoc>
+ <autodoc>base_OnRightClick(self, double x, double y, int keys=0)</autodoc>
<paramlist>
<param name="x" type="double" default=""/>
<param name="y" type="double" default=""/>
</paramlist>
</method>
<method name="Redraw" type="" overloaded="no">
- <autodoc>Redraw(DC dc)</autodoc>
+ <autodoc>Redraw(self, DC dc)</autodoc>
<paramlist>
<param name="dc" type="DC" default=""/>
</paramlist>
</method>
<method name="RemoveShape" type="" overloaded="no">
- <autodoc>RemoveShape(PyShape shape)</autodoc>
+ <autodoc>RemoveShape(self, PyShape shape)</autodoc>
<paramlist>
<param name="shape" type="PyShape" default=""/>
</paramlist>
</method>
<method name="SetDiagram" type="" overloaded="no">
- <autodoc>SetDiagram(Diagram diagram)</autodoc>
+ <autodoc>SetDiagram(self, Diagram diagram)</autodoc>
<paramlist>
<param name="diagram" type="Diagram" default=""/>
</paramlist>
</method>
<method name="Snap" type="" overloaded="no">
- <autodoc>Snap(double INOUT, double INOUT)</autodoc>
+ <autodoc>Snap(self, double INOUT, double INOUT)</autodoc>
<paramlist>
<param name="INOUT" type="double" default=""/>
<param name="INOUT" type="double" default=""/>
</method>
</module>
<module name="stc">
- <import name="core"/>
- <import name="misc"/>
- <pythoncode> wx = core </pythoncode>
+ <import name="_core"/>
+ <import name="_misc"/>
+ <pythoncode> wx = _core </pythoncode>
+ <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode>
<class name="StyledTextCtrl" oldname="wxStyledTextCtrl" module="stc">
<baseclass name="Control"/>
<constructor name="StyledTextCtrl" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, String name=STCNameStr) -> StyledTextCtrl</autodoc>
+ <autodoc>__init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, String name=STCNameStr) -> StyledTextCtrl</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="wxID_ANY"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
<autodoc>PreStyledTextCtrl() -> StyledTextCtrl</autodoc>
</constructor>
<method name="Create" type="" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, String name=wxSTCNameStr)</autodoc>
+ <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, String name=wxSTCNameStr)</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="wxID_ANY"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="0"/>
</paramlist>
</method>
<method name="AddText" type="" overloaded="no">
- <autodoc>AddText(String text)</autodoc>
+ <autodoc>AddText(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="AddStyledText" type="" overloaded="no">
- <autodoc>AddStyledText(wxMemoryBuffer data)</autodoc>
+ <autodoc>AddStyledText(self, wxMemoryBuffer data)</autodoc>
<paramlist>
<param name="data" type="wxMemoryBuffer" default=""/>
</paramlist>
</method>
<method name="InsertText" type="" overloaded="no">
- <autodoc>InsertText(int pos, String text)</autodoc>
+ <autodoc>InsertText(self, int pos, String text)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="ClearAll" type="" overloaded="no">
- <autodoc>ClearAll()</autodoc>
+ <autodoc>ClearAll(self)</autodoc>
</method>
<method name="ClearDocumentStyle" type="" overloaded="no">
- <autodoc>ClearDocumentStyle()</autodoc>
+ <autodoc>ClearDocumentStyle(self)</autodoc>
</method>
<method name="GetLength" type="int" overloaded="no">
- <autodoc>GetLength() -> int</autodoc>
+ <autodoc>GetLength(self) -> int</autodoc>
</method>
<method name="GetCharAt" type="int" overloaded="no">
- <autodoc>GetCharAt(int pos) -> int</autodoc>
+ <autodoc>GetCharAt(self, int pos) -> int</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="GetCurrentPos" type="int" overloaded="no">
- <autodoc>GetCurrentPos() -> int</autodoc>
+ <autodoc>GetCurrentPos(self) -> int</autodoc>
</method>
<method name="GetAnchor" type="int" overloaded="no">
- <autodoc>GetAnchor() -> int</autodoc>
+ <autodoc>GetAnchor(self) -> int</autodoc>
</method>
<method name="GetStyleAt" type="int" overloaded="no">
- <autodoc>GetStyleAt(int pos) -> int</autodoc>
+ <autodoc>GetStyleAt(self, int pos) -> int</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="Redo" type="" overloaded="no">
- <autodoc>Redo()</autodoc>
+ <autodoc>Redo(self)</autodoc>
</method>
<method name="SetUndoCollection" type="" overloaded="no">
- <autodoc>SetUndoCollection(bool collectUndo)</autodoc>
+ <autodoc>SetUndoCollection(self, bool collectUndo)</autodoc>
<paramlist>
<param name="collectUndo" type="bool" default=""/>
</paramlist>
</method>
<method name="SelectAll" type="" overloaded="no">
- <autodoc>SelectAll()</autodoc>
+ <autodoc>SelectAll(self)</autodoc>
</method>
<method name="SetSavePoint" type="" overloaded="no">
- <autodoc>SetSavePoint()</autodoc>
+ <autodoc>SetSavePoint(self)</autodoc>
</method>
<method name="GetStyledText" type="wxMemoryBuffer" overloaded="no">
- <autodoc>GetStyledText(int startPos, int endPos) -> wxMemoryBuffer</autodoc>
+ <autodoc>GetStyledText(self, int startPos, int endPos) -> wxMemoryBuffer</autodoc>
<paramlist>
<param name="startPos" type="int" default=""/>
<param name="endPos" type="int" default=""/>
</paramlist>
</method>
<method name="CanRedo" type="bool" overloaded="no">
- <autodoc>CanRedo() -> bool</autodoc>
+ <autodoc>CanRedo(self) -> bool</autodoc>
</method>
<method name="MarkerLineFromHandle" type="int" overloaded="no">
- <autodoc>MarkerLineFromHandle(int handle) -> int</autodoc>
+ <autodoc>MarkerLineFromHandle(self, int handle) -> int</autodoc>
<paramlist>
<param name="handle" type="int" default=""/>
</paramlist>
</method>
<method name="MarkerDeleteHandle" type="" overloaded="no">
- <autodoc>MarkerDeleteHandle(int handle)</autodoc>
+ <autodoc>MarkerDeleteHandle(self, int handle)</autodoc>
<paramlist>
<param name="handle" type="int" default=""/>
</paramlist>
</method>
<method name="GetUndoCollection" type="bool" overloaded="no">
- <autodoc>GetUndoCollection() -> bool</autodoc>
+ <autodoc>GetUndoCollection(self) -> bool</autodoc>
</method>
<method name="GetViewWhiteSpace" type="int" overloaded="no">
- <autodoc>GetViewWhiteSpace() -> int</autodoc>
+ <autodoc>GetViewWhiteSpace(self) -> int</autodoc>
</method>
<method name="SetViewWhiteSpace" type="" overloaded="no">
- <autodoc>SetViewWhiteSpace(int viewWS)</autodoc>
+ <autodoc>SetViewWhiteSpace(self, int viewWS)</autodoc>
<paramlist>
<param name="viewWS" type="int" default=""/>
</paramlist>
</method>
<method name="PositionFromPoint" type="int" overloaded="no">
- <autodoc>PositionFromPoint(Point pt) -> int</autodoc>
+ <autodoc>PositionFromPoint(self, Point pt) -> int</autodoc>
<paramlist>
<param name="pt" type="Point" default=""/>
</paramlist>
</method>
<method name="PositionFromPointClose" type="int" overloaded="no">
- <autodoc>PositionFromPointClose(int x, int y) -> int</autodoc>
+ <autodoc>PositionFromPointClose(self, int x, int y) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="GotoLine" type="" overloaded="no">
- <autodoc>GotoLine(int line)</autodoc>
+ <autodoc>GotoLine(self, int line)</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="GotoPos" type="" overloaded="no">
- <autodoc>GotoPos(int pos)</autodoc>
+ <autodoc>GotoPos(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="SetAnchor" type="" overloaded="no">
- <autodoc>SetAnchor(int posAnchor)</autodoc>
+ <autodoc>SetAnchor(self, int posAnchor)</autodoc>
<paramlist>
<param name="posAnchor" type="int" default=""/>
</paramlist>
</method>
<method name="GetCurLine" type="String" overloaded="no">
- <autodoc>GetCurLine(int OUTPUT) -> String</autodoc>
+ <autodoc>GetCurLine(self, int OUTPUT) -> String</autodoc>
<paramlist>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="GetEndStyled" type="int" overloaded="no">
- <autodoc>GetEndStyled() -> int</autodoc>
+ <autodoc>GetEndStyled(self) -> int</autodoc>
</method>
<method name="ConvertEOLs" type="" overloaded="no">
- <autodoc>ConvertEOLs(int eolMode)</autodoc>
+ <autodoc>ConvertEOLs(self, int eolMode)</autodoc>
<paramlist>
<param name="eolMode" type="int" default=""/>
</paramlist>
</method>
<method name="GetEOLMode" type="int" overloaded="no">
- <autodoc>GetEOLMode() -> int</autodoc>
+ <autodoc>GetEOLMode(self) -> int</autodoc>
</method>
<method name="SetEOLMode" type="" overloaded="no">
- <autodoc>SetEOLMode(int eolMode)</autodoc>
+ <autodoc>SetEOLMode(self, int eolMode)</autodoc>
<paramlist>
<param name="eolMode" type="int" default=""/>
</paramlist>
</method>
<method name="StartStyling" type="" overloaded="no">
- <autodoc>StartStyling(int pos, int mask)</autodoc>
+ <autodoc>StartStyling(self, int pos, int mask)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
<param name="mask" type="int" default=""/>
</paramlist>
</method>
<method name="SetStyling" type="" overloaded="no">
- <autodoc>SetStyling(int length, int style)</autodoc>
+ <autodoc>SetStyling(self, int length, int style)</autodoc>
<paramlist>
<param name="length" type="int" default=""/>
<param name="style" type="int" default=""/>
</paramlist>
</method>
<method name="GetBufferedDraw" type="bool" overloaded="no">
- <autodoc>GetBufferedDraw() -> bool</autodoc>
+ <autodoc>GetBufferedDraw(self) -> bool</autodoc>
</method>
<method name="SetBufferedDraw" type="" overloaded="no">
- <autodoc>SetBufferedDraw(bool buffered)</autodoc>
+ <autodoc>SetBufferedDraw(self, bool buffered)</autodoc>
<paramlist>
<param name="buffered" type="bool" default=""/>
</paramlist>
</method>
<method name="SetTabWidth" type="" overloaded="no">
- <autodoc>SetTabWidth(int tabWidth)</autodoc>
+ <autodoc>SetTabWidth(self, int tabWidth)</autodoc>
<paramlist>
<param name="tabWidth" type="int" default=""/>
</paramlist>
</method>
<method name="GetTabWidth" type="int" overloaded="no">
- <autodoc>GetTabWidth() -> int</autodoc>
+ <autodoc>GetTabWidth(self) -> int</autodoc>
</method>
<method name="SetCodePage" type="" overloaded="no">
- <autodoc>SetCodePage(int codePage)</autodoc>
+ <autodoc>SetCodePage(self, int codePage)</autodoc>
<paramlist>
<param name="codePage" type="int" default=""/>
</paramlist>
</method>
<method name="MarkerDefine" type="" overloaded="no">
- <autodoc>MarkerDefine(int markerNumber, int markerSymbol, Colour foreground=wxNullColour,
+ <autodoc>MarkerDefine(self, int markerNumber, int markerSymbol, Colour foreground=wxNullColour,
Colour background=wxNullColour)</autodoc>
<paramlist>
<param name="markerNumber" type="int" default=""/>
</paramlist>
</method>
<method name="MarkerSetForeground" type="" overloaded="no">
- <autodoc>MarkerSetForeground(int markerNumber, Colour fore)</autodoc>
+ <autodoc>MarkerSetForeground(self, int markerNumber, Colour fore)</autodoc>
<paramlist>
<param name="markerNumber" type="int" default=""/>
<param name="fore" type="Colour" default=""/>
</paramlist>
</method>
<method name="MarkerSetBackground" type="" overloaded="no">
- <autodoc>MarkerSetBackground(int markerNumber, Colour back)</autodoc>
+ <autodoc>MarkerSetBackground(self, int markerNumber, Colour back)</autodoc>
<paramlist>
<param name="markerNumber" type="int" default=""/>
<param name="back" type="Colour" default=""/>
</paramlist>
</method>
<method name="MarkerAdd" type="int" overloaded="no">
- <autodoc>MarkerAdd(int line, int markerNumber) -> int</autodoc>
+ <autodoc>MarkerAdd(self, int line, int markerNumber) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
<param name="markerNumber" type="int" default=""/>
</paramlist>
</method>
<method name="MarkerDelete" type="" overloaded="no">
- <autodoc>MarkerDelete(int line, int markerNumber)</autodoc>
+ <autodoc>MarkerDelete(self, int line, int markerNumber)</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
<param name="markerNumber" type="int" default=""/>
</paramlist>
</method>
<method name="MarkerDeleteAll" type="" overloaded="no">
- <autodoc>MarkerDeleteAll(int markerNumber)</autodoc>
+ <autodoc>MarkerDeleteAll(self, int markerNumber)</autodoc>
<paramlist>
<param name="markerNumber" type="int" default=""/>
</paramlist>
</method>
<method name="MarkerGet" type="int" overloaded="no">
- <autodoc>MarkerGet(int line) -> int</autodoc>
+ <autodoc>MarkerGet(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="MarkerNext" type="int" overloaded="no">
- <autodoc>MarkerNext(int lineStart, int markerMask) -> int</autodoc>
+ <autodoc>MarkerNext(self, int lineStart, int markerMask) -> int</autodoc>
<paramlist>
<param name="lineStart" type="int" default=""/>
<param name="markerMask" type="int" default=""/>
</paramlist>
</method>
<method name="MarkerPrevious" type="int" overloaded="no">
- <autodoc>MarkerPrevious(int lineStart, int markerMask) -> int</autodoc>
+ <autodoc>MarkerPrevious(self, int lineStart, int markerMask) -> int</autodoc>
<paramlist>
<param name="lineStart" type="int" default=""/>
<param name="markerMask" type="int" default=""/>
</paramlist>
</method>
<method name="MarkerDefineBitmap" type="" overloaded="no">
- <autodoc>MarkerDefineBitmap(int markerNumber, Bitmap bmp)</autodoc>
+ <autodoc>MarkerDefineBitmap(self, int markerNumber, Bitmap bmp)</autodoc>
<paramlist>
<param name="markerNumber" type="int" default=""/>
<param name="bmp" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="SetMarginType" type="" overloaded="no">
- <autodoc>SetMarginType(int margin, int marginType)</autodoc>
+ <autodoc>SetMarginType(self, int margin, int marginType)</autodoc>
<paramlist>
<param name="margin" type="int" default=""/>
<param name="marginType" type="int" default=""/>
</paramlist>
</method>
<method name="GetMarginType" type="int" overloaded="no">
- <autodoc>GetMarginType(int margin) -> int</autodoc>
+ <autodoc>GetMarginType(self, int margin) -> int</autodoc>
<paramlist>
<param name="margin" type="int" default=""/>
</paramlist>
</method>
<method name="SetMarginWidth" type="" overloaded="no">
- <autodoc>SetMarginWidth(int margin, int pixelWidth)</autodoc>
+ <autodoc>SetMarginWidth(self, int margin, int pixelWidth)</autodoc>
<paramlist>
<param name="margin" type="int" default=""/>
<param name="pixelWidth" type="int" default=""/>
</paramlist>
</method>
<method name="GetMarginWidth" type="int" overloaded="no">
- <autodoc>GetMarginWidth(int margin) -> int</autodoc>
+ <autodoc>GetMarginWidth(self, int margin) -> int</autodoc>
<paramlist>
<param name="margin" type="int" default=""/>
</paramlist>
</method>
<method name="SetMarginMask" type="" overloaded="no">
- <autodoc>SetMarginMask(int margin, int mask)</autodoc>
+ <autodoc>SetMarginMask(self, int margin, int mask)</autodoc>
<paramlist>
<param name="margin" type="int" default=""/>
<param name="mask" type="int" default=""/>
</paramlist>
</method>
<method name="GetMarginMask" type="int" overloaded="no">
- <autodoc>GetMarginMask(int margin) -> int</autodoc>
+ <autodoc>GetMarginMask(self, int margin) -> int</autodoc>
<paramlist>
<param name="margin" type="int" default=""/>
</paramlist>
</method>
<method name="SetMarginSensitive" type="" overloaded="no">
- <autodoc>SetMarginSensitive(int margin, bool sensitive)</autodoc>
+ <autodoc>SetMarginSensitive(self, int margin, bool sensitive)</autodoc>
<paramlist>
<param name="margin" type="int" default=""/>
<param name="sensitive" type="bool" default=""/>
</paramlist>
</method>
<method name="GetMarginSensitive" type="bool" overloaded="no">
- <autodoc>GetMarginSensitive(int margin) -> bool</autodoc>
+ <autodoc>GetMarginSensitive(self, int margin) -> bool</autodoc>
<paramlist>
<param name="margin" type="int" default=""/>
</paramlist>
</method>
<method name="StyleClearAll" type="" overloaded="no">
- <autodoc>StyleClearAll()</autodoc>
+ <autodoc>StyleClearAll(self)</autodoc>
</method>
<method name="StyleSetForeground" type="" overloaded="no">
- <autodoc>StyleSetForeground(int style, Colour fore)</autodoc>
+ <autodoc>StyleSetForeground(self, int style, Colour fore)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="fore" type="Colour" default=""/>
</paramlist>
</method>
<method name="StyleSetBackground" type="" overloaded="no">
- <autodoc>StyleSetBackground(int style, Colour back)</autodoc>
+ <autodoc>StyleSetBackground(self, int style, Colour back)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="back" type="Colour" default=""/>
</paramlist>
</method>
<method name="StyleSetBold" type="" overloaded="no">
- <autodoc>StyleSetBold(int style, bool bold)</autodoc>
+ <autodoc>StyleSetBold(self, int style, bool bold)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="bold" type="bool" default=""/>
</paramlist>
</method>
<method name="StyleSetItalic" type="" overloaded="no">
- <autodoc>StyleSetItalic(int style, bool italic)</autodoc>
+ <autodoc>StyleSetItalic(self, int style, bool italic)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="italic" type="bool" default=""/>
</paramlist>
</method>
<method name="StyleSetSize" type="" overloaded="no">
- <autodoc>StyleSetSize(int style, int sizePoints)</autodoc>
+ <autodoc>StyleSetSize(self, int style, int sizePoints)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="sizePoints" type="int" default=""/>
</paramlist>
</method>
<method name="StyleSetFaceName" type="" overloaded="no">
- <autodoc>StyleSetFaceName(int style, String fontName)</autodoc>
+ <autodoc>StyleSetFaceName(self, int style, String fontName)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="fontName" type="String" default=""/>
</paramlist>
</method>
<method name="StyleSetEOLFilled" type="" overloaded="no">
- <autodoc>StyleSetEOLFilled(int style, bool filled)</autodoc>
+ <autodoc>StyleSetEOLFilled(self, int style, bool filled)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="filled" type="bool" default=""/>
</paramlist>
</method>
<method name="StyleResetDefault" type="" overloaded="no">
- <autodoc>StyleResetDefault()</autodoc>
+ <autodoc>StyleResetDefault(self)</autodoc>
</method>
<method name="StyleSetUnderline" type="" overloaded="no">
- <autodoc>StyleSetUnderline(int style, bool underline)</autodoc>
+ <autodoc>StyleSetUnderline(self, int style, bool underline)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="underline" type="bool" default=""/>
</paramlist>
</method>
<method name="StyleSetCase" type="" overloaded="no">
- <autodoc>StyleSetCase(int style, int caseForce)</autodoc>
+ <autodoc>StyleSetCase(self, int style, int caseForce)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="caseForce" type="int" default=""/>
</paramlist>
</method>
<method name="StyleSetCharacterSet" type="" overloaded="no">
- <autodoc>StyleSetCharacterSet(int style, int characterSet)</autodoc>
+ <autodoc>StyleSetCharacterSet(self, int style, int characterSet)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="characterSet" type="int" default=""/>
</paramlist>
</method>
<method name="StyleSetHotSpot" type="" overloaded="no">
- <autodoc>StyleSetHotSpot(int style, bool hotspot)</autodoc>
+ <autodoc>StyleSetHotSpot(self, int style, bool hotspot)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="hotspot" type="bool" default=""/>
</paramlist>
</method>
<method name="SetSelForeground" type="" overloaded="no">
- <autodoc>SetSelForeground(bool useSetting, Colour fore)</autodoc>
+ <autodoc>SetSelForeground(self, bool useSetting, Colour fore)</autodoc>
<paramlist>
<param name="useSetting" type="bool" default=""/>
<param name="fore" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetSelBackground" type="" overloaded="no">
- <autodoc>SetSelBackground(bool useSetting, Colour back)</autodoc>
+ <autodoc>SetSelBackground(self, bool useSetting, Colour back)</autodoc>
<paramlist>
<param name="useSetting" type="bool" default=""/>
<param name="back" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetCaretForeground" type="" overloaded="no">
- <autodoc>SetCaretForeground(Colour fore)</autodoc>
+ <autodoc>SetCaretForeground(self, Colour fore)</autodoc>
<paramlist>
<param name="fore" type="Colour" default=""/>
</paramlist>
</method>
<method name="CmdKeyAssign" type="" overloaded="no">
- <autodoc>CmdKeyAssign(int key, int modifiers, int cmd)</autodoc>
+ <autodoc>CmdKeyAssign(self, int key, int modifiers, int cmd)</autodoc>
<paramlist>
<param name="key" type="int" default=""/>
<param name="modifiers" type="int" default=""/>
</paramlist>
</method>
<method name="CmdKeyClear" type="" overloaded="no">
- <autodoc>CmdKeyClear(int key, int modifiers)</autodoc>
+ <autodoc>CmdKeyClear(self, int key, int modifiers)</autodoc>
<paramlist>
<param name="key" type="int" default=""/>
<param name="modifiers" type="int" default=""/>
</paramlist>
</method>
<method name="CmdKeyClearAll" type="" overloaded="no">
- <autodoc>CmdKeyClearAll()</autodoc>
+ <autodoc>CmdKeyClearAll(self)</autodoc>
</method>
<method name="SetStyleBytes" type="" overloaded="no">
- <autodoc>SetStyleBytes(int length, char styleBytes)</autodoc>
+ <autodoc>SetStyleBytes(self, int length, char styleBytes)</autodoc>
<paramlist>
<param name="length" type="int" default=""/>
<param name="styleBytes" type="char" default=""/>
</paramlist>
</method>
<method name="StyleSetVisible" type="" overloaded="no">
- <autodoc>StyleSetVisible(int style, bool visible)</autodoc>
+ <autodoc>StyleSetVisible(self, int style, bool visible)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="visible" type="bool" default=""/>
</paramlist>
</method>
<method name="GetCaretPeriod" type="int" overloaded="no">
- <autodoc>GetCaretPeriod() -> int</autodoc>
+ <autodoc>GetCaretPeriod(self) -> int</autodoc>
</method>
<method name="SetCaretPeriod" type="" overloaded="no">
- <autodoc>SetCaretPeriod(int periodMilliseconds)</autodoc>
+ <autodoc>SetCaretPeriod(self, int periodMilliseconds)</autodoc>
<paramlist>
<param name="periodMilliseconds" type="int" default=""/>
</paramlist>
</method>
<method name="SetWordChars" type="" overloaded="no">
- <autodoc>SetWordChars(String characters)</autodoc>
+ <autodoc>SetWordChars(self, String characters)</autodoc>
<paramlist>
<param name="characters" type="String" default=""/>
</paramlist>
</method>
<method name="BeginUndoAction" type="" overloaded="no">
- <autodoc>BeginUndoAction()</autodoc>
+ <autodoc>BeginUndoAction(self)</autodoc>
</method>
<method name="EndUndoAction" type="" overloaded="no">
- <autodoc>EndUndoAction()</autodoc>
+ <autodoc>EndUndoAction(self)</autodoc>
</method>
<method name="IndicatorSetStyle" type="" overloaded="no">
- <autodoc>IndicatorSetStyle(int indic, int style)</autodoc>
+ <autodoc>IndicatorSetStyle(self, int indic, int style)</autodoc>
<paramlist>
<param name="indic" type="int" default=""/>
<param name="style" type="int" default=""/>
</paramlist>
</method>
<method name="IndicatorGetStyle" type="int" overloaded="no">
- <autodoc>IndicatorGetStyle(int indic) -> int</autodoc>
+ <autodoc>IndicatorGetStyle(self, int indic) -> int</autodoc>
<paramlist>
<param name="indic" type="int" default=""/>
</paramlist>
</method>
<method name="IndicatorSetForeground" type="" overloaded="no">
- <autodoc>IndicatorSetForeground(int indic, Colour fore)</autodoc>
+ <autodoc>IndicatorSetForeground(self, int indic, Colour fore)</autodoc>
<paramlist>
<param name="indic" type="int" default=""/>
<param name="fore" type="Colour" default=""/>
</paramlist>
</method>
<method name="IndicatorGetForeground" type="Colour" overloaded="no">
- <autodoc>IndicatorGetForeground(int indic) -> Colour</autodoc>
+ <autodoc>IndicatorGetForeground(self, int indic) -> Colour</autodoc>
<paramlist>
<param name="indic" type="int" default=""/>
</paramlist>
</method>
<method name="SetWhitespaceForeground" type="" overloaded="no">
- <autodoc>SetWhitespaceForeground(bool useSetting, Colour fore)</autodoc>
+ <autodoc>SetWhitespaceForeground(self, bool useSetting, Colour fore)</autodoc>
<paramlist>
<param name="useSetting" type="bool" default=""/>
<param name="fore" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetWhitespaceBackground" type="" overloaded="no">
- <autodoc>SetWhitespaceBackground(bool useSetting, Colour back)</autodoc>
+ <autodoc>SetWhitespaceBackground(self, bool useSetting, Colour back)</autodoc>
<paramlist>
<param name="useSetting" type="bool" default=""/>
<param name="back" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetStyleBits" type="" overloaded="no">
- <autodoc>SetStyleBits(int bits)</autodoc>
+ <autodoc>SetStyleBits(self, int bits)</autodoc>
<paramlist>
<param name="bits" type="int" default=""/>
</paramlist>
</method>
<method name="GetStyleBits" type="int" overloaded="no">
- <autodoc>GetStyleBits() -> int</autodoc>
+ <autodoc>GetStyleBits(self) -> int</autodoc>
</method>
<method name="SetLineState" type="" overloaded="no">
- <autodoc>SetLineState(int line, int state)</autodoc>
+ <autodoc>SetLineState(self, int line, int state)</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
<param name="state" type="int" default=""/>
</paramlist>
</method>
<method name="GetLineState" type="int" overloaded="no">
- <autodoc>GetLineState(int line) -> int</autodoc>
+ <autodoc>GetLineState(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="GetMaxLineState" type="int" overloaded="no">
- <autodoc>GetMaxLineState() -> int</autodoc>
+ <autodoc>GetMaxLineState(self) -> int</autodoc>
</method>
<method name="GetCaretLineVisible" type="bool" overloaded="no">
- <autodoc>GetCaretLineVisible() -> bool</autodoc>
+ <autodoc>GetCaretLineVisible(self) -> bool</autodoc>
</method>
<method name="SetCaretLineVisible" type="" overloaded="no">
- <autodoc>SetCaretLineVisible(bool show)</autodoc>
+ <autodoc>SetCaretLineVisible(self, bool show)</autodoc>
<paramlist>
<param name="show" type="bool" default=""/>
</paramlist>
</method>
<method name="GetCaretLineBack" type="Colour" overloaded="no">
- <autodoc>GetCaretLineBack() -> Colour</autodoc>
+ <autodoc>GetCaretLineBack(self) -> Colour</autodoc>
</method>
<method name="SetCaretLineBack" type="" overloaded="no">
- <autodoc>SetCaretLineBack(Colour back)</autodoc>
+ <autodoc>SetCaretLineBack(self, Colour back)</autodoc>
<paramlist>
<param name="back" type="Colour" default=""/>
</paramlist>
</method>
<method name="StyleSetChangeable" type="" overloaded="no">
- <autodoc>StyleSetChangeable(int style, bool changeable)</autodoc>
+ <autodoc>StyleSetChangeable(self, int style, bool changeable)</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="changeable" type="bool" default=""/>
</paramlist>
</method>
<method name="AutoCompShow" type="" overloaded="no">
- <autodoc>AutoCompShow(int lenEntered, String itemList)</autodoc>
+ <autodoc>AutoCompShow(self, int lenEntered, String itemList)</autodoc>
<paramlist>
<param name="lenEntered" type="int" default=""/>
<param name="itemList" type="String" default=""/>
</paramlist>
</method>
<method name="AutoCompCancel" type="" overloaded="no">
- <autodoc>AutoCompCancel()</autodoc>
+ <autodoc>AutoCompCancel(self)</autodoc>
</method>
<method name="AutoCompActive" type="bool" overloaded="no">
- <autodoc>AutoCompActive() -> bool</autodoc>
+ <autodoc>AutoCompActive(self) -> bool</autodoc>
</method>
<method name="AutoCompPosStart" type="int" overloaded="no">
- <autodoc>AutoCompPosStart() -> int</autodoc>
+ <autodoc>AutoCompPosStart(self) -> int</autodoc>
</method>
<method name="AutoCompComplete" type="" overloaded="no">
- <autodoc>AutoCompComplete()</autodoc>
+ <autodoc>AutoCompComplete(self)</autodoc>
</method>
<method name="AutoCompStops" type="" overloaded="no">
- <autodoc>AutoCompStops(String characterSet)</autodoc>
+ <autodoc>AutoCompStops(self, String characterSet)</autodoc>
<paramlist>
<param name="characterSet" type="String" default=""/>
</paramlist>
</method>
<method name="AutoCompSetSeparator" type="" overloaded="no">
- <autodoc>AutoCompSetSeparator(int separatorCharacter)</autodoc>
+ <autodoc>AutoCompSetSeparator(self, int separatorCharacter)</autodoc>
<paramlist>
<param name="separatorCharacter" type="int" default=""/>
</paramlist>
</method>
<method name="AutoCompGetSeparator" type="int" overloaded="no">
- <autodoc>AutoCompGetSeparator() -> int</autodoc>
+ <autodoc>AutoCompGetSeparator(self) -> int</autodoc>
</method>
<method name="AutoCompSelect" type="" overloaded="no">
- <autodoc>AutoCompSelect(String text)</autodoc>
+ <autodoc>AutoCompSelect(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="AutoCompSetCancelAtStart" type="" overloaded="no">
- <autodoc>AutoCompSetCancelAtStart(bool cancel)</autodoc>
+ <autodoc>AutoCompSetCancelAtStart(self, bool cancel)</autodoc>
<paramlist>
<param name="cancel" type="bool" default=""/>
</paramlist>
</method>
<method name="AutoCompGetCancelAtStart" type="bool" overloaded="no">
- <autodoc>AutoCompGetCancelAtStart() -> bool</autodoc>
+ <autodoc>AutoCompGetCancelAtStart(self) -> bool</autodoc>
</method>
<method name="AutoCompSetFillUps" type="" overloaded="no">
- <autodoc>AutoCompSetFillUps(String characterSet)</autodoc>
+ <autodoc>AutoCompSetFillUps(self, String characterSet)</autodoc>
<paramlist>
<param name="characterSet" type="String" default=""/>
</paramlist>
</method>
<method name="AutoCompSetChooseSingle" type="" overloaded="no">
- <autodoc>AutoCompSetChooseSingle(bool chooseSingle)</autodoc>
+ <autodoc>AutoCompSetChooseSingle(self, bool chooseSingle)</autodoc>
<paramlist>
<param name="chooseSingle" type="bool" default=""/>
</paramlist>
</method>
<method name="AutoCompGetChooseSingle" type="bool" overloaded="no">
- <autodoc>AutoCompGetChooseSingle() -> bool</autodoc>
+ <autodoc>AutoCompGetChooseSingle(self) -> bool</autodoc>
</method>
<method name="AutoCompSetIgnoreCase" type="" overloaded="no">
- <autodoc>AutoCompSetIgnoreCase(bool ignoreCase)</autodoc>
+ <autodoc>AutoCompSetIgnoreCase(self, bool ignoreCase)</autodoc>
<paramlist>
<param name="ignoreCase" type="bool" default=""/>
</paramlist>
</method>
<method name="AutoCompGetIgnoreCase" type="bool" overloaded="no">
- <autodoc>AutoCompGetIgnoreCase() -> bool</autodoc>
+ <autodoc>AutoCompGetIgnoreCase(self) -> bool</autodoc>
</method>
<method name="UserListShow" type="" overloaded="no">
- <autodoc>UserListShow(int listType, String itemList)</autodoc>
+ <autodoc>UserListShow(self, int listType, String itemList)</autodoc>
<paramlist>
<param name="listType" type="int" default=""/>
<param name="itemList" type="String" default=""/>
</paramlist>
</method>
<method name="AutoCompSetAutoHide" type="" overloaded="no">
- <autodoc>AutoCompSetAutoHide(bool autoHide)</autodoc>
+ <autodoc>AutoCompSetAutoHide(self, bool autoHide)</autodoc>
<paramlist>
<param name="autoHide" type="bool" default=""/>
</paramlist>
</method>
<method name="AutoCompGetAutoHide" type="bool" overloaded="no">
- <autodoc>AutoCompGetAutoHide() -> bool</autodoc>
+ <autodoc>AutoCompGetAutoHide(self) -> bool</autodoc>
</method>
<method name="AutoCompSetDropRestOfWord" type="" overloaded="no">
- <autodoc>AutoCompSetDropRestOfWord(bool dropRestOfWord)</autodoc>
+ <autodoc>AutoCompSetDropRestOfWord(self, bool dropRestOfWord)</autodoc>
<paramlist>
<param name="dropRestOfWord" type="bool" default=""/>
</paramlist>
</method>
<method name="AutoCompGetDropRestOfWord" type="bool" overloaded="no">
- <autodoc>AutoCompGetDropRestOfWord() -> bool</autodoc>
+ <autodoc>AutoCompGetDropRestOfWord(self) -> bool</autodoc>
</method>
<method name="RegisterImage" type="" overloaded="no">
- <autodoc>RegisterImage(int type, Bitmap bmp)</autodoc>
+ <autodoc>RegisterImage(self, int type, Bitmap bmp)</autodoc>
<paramlist>
<param name="type" type="int" default=""/>
<param name="bmp" type="Bitmap" default=""/>
</paramlist>
</method>
<method name="ClearRegisteredImages" type="" overloaded="no">
- <autodoc>ClearRegisteredImages()</autodoc>
+ <autodoc>ClearRegisteredImages(self)</autodoc>
</method>
<method name="AutoCompGetTypeSeparator" type="int" overloaded="no">
- <autodoc>AutoCompGetTypeSeparator() -> int</autodoc>
+ <autodoc>AutoCompGetTypeSeparator(self) -> int</autodoc>
</method>
<method name="AutoCompSetTypeSeparator" type="" overloaded="no">
- <autodoc>AutoCompSetTypeSeparator(int separatorCharacter)</autodoc>
+ <autodoc>AutoCompSetTypeSeparator(self, int separatorCharacter)</autodoc>
<paramlist>
<param name="separatorCharacter" type="int" default=""/>
</paramlist>
</method>
<method name="SetIndent" type="" overloaded="no">
- <autodoc>SetIndent(int indentSize)</autodoc>
+ <autodoc>SetIndent(self, int indentSize)</autodoc>
<paramlist>
<param name="indentSize" type="int" default=""/>
</paramlist>
</method>
<method name="GetIndent" type="int" overloaded="no">
- <autodoc>GetIndent() -> int</autodoc>
+ <autodoc>GetIndent(self) -> int</autodoc>
</method>
<method name="SetUseTabs" type="" overloaded="no">
- <autodoc>SetUseTabs(bool useTabs)</autodoc>
+ <autodoc>SetUseTabs(self, bool useTabs)</autodoc>
<paramlist>
<param name="useTabs" type="bool" default=""/>
</paramlist>
</method>
<method name="GetUseTabs" type="bool" overloaded="no">
- <autodoc>GetUseTabs() -> bool</autodoc>
+ <autodoc>GetUseTabs(self) -> bool</autodoc>
</method>
<method name="SetLineIndentation" type="" overloaded="no">
- <autodoc>SetLineIndentation(int line, int indentSize)</autodoc>
+ <autodoc>SetLineIndentation(self, int line, int indentSize)</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
<param name="indentSize" type="int" default=""/>
</paramlist>
</method>
<method name="GetLineIndentation" type="int" overloaded="no">
- <autodoc>GetLineIndentation(int line) -> int</autodoc>
+ <autodoc>GetLineIndentation(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="GetLineIndentPosition" type="int" overloaded="no">
- <autodoc>GetLineIndentPosition(int line) -> int</autodoc>
+ <autodoc>GetLineIndentPosition(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="GetColumn" type="int" overloaded="no">
- <autodoc>GetColumn(int pos) -> int</autodoc>
+ <autodoc>GetColumn(self, int pos) -> int</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="SetUseHorizontalScrollBar" type="" overloaded="no">
- <autodoc>SetUseHorizontalScrollBar(bool show)</autodoc>
+ <autodoc>SetUseHorizontalScrollBar(self, bool show)</autodoc>
<paramlist>
<param name="show" type="bool" default=""/>
</paramlist>
</method>
<method name="GetUseHorizontalScrollBar" type="bool" overloaded="no">
- <autodoc>GetUseHorizontalScrollBar() -> bool</autodoc>
+ <autodoc>GetUseHorizontalScrollBar(self) -> bool</autodoc>
</method>
<method name="SetIndentationGuides" type="" overloaded="no">
- <autodoc>SetIndentationGuides(bool show)</autodoc>
+ <autodoc>SetIndentationGuides(self, bool show)</autodoc>
<paramlist>
<param name="show" type="bool" default=""/>
</paramlist>
</method>
<method name="GetIndentationGuides" type="bool" overloaded="no">
- <autodoc>GetIndentationGuides() -> bool</autodoc>
+ <autodoc>GetIndentationGuides(self) -> bool</autodoc>
</method>
<method name="SetHighlightGuide" type="" overloaded="no">
- <autodoc>SetHighlightGuide(int column)</autodoc>
+ <autodoc>SetHighlightGuide(self, int column)</autodoc>
<paramlist>
<param name="column" type="int" default=""/>
</paramlist>
</method>
<method name="GetHighlightGuide" type="int" overloaded="no">
- <autodoc>GetHighlightGuide() -> int</autodoc>
+ <autodoc>GetHighlightGuide(self) -> int</autodoc>
</method>
<method name="GetLineEndPosition" type="int" overloaded="no">
- <autodoc>GetLineEndPosition(int line) -> int</autodoc>
+ <autodoc>GetLineEndPosition(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="GetCodePage" type="int" overloaded="no">
- <autodoc>GetCodePage() -> int</autodoc>
+ <autodoc>GetCodePage(self) -> int</autodoc>
</method>
<method name="GetCaretForeground" type="Colour" overloaded="no">
- <autodoc>GetCaretForeground() -> Colour</autodoc>
+ <autodoc>GetCaretForeground(self) -> Colour</autodoc>
</method>
<method name="GetReadOnly" type="bool" overloaded="no">
- <autodoc>GetReadOnly() -> bool</autodoc>
+ <autodoc>GetReadOnly(self) -> bool</autodoc>
</method>
<method name="SetCurrentPos" type="" overloaded="no">
- <autodoc>SetCurrentPos(int pos)</autodoc>
+ <autodoc>SetCurrentPos(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="SetSelectionStart" type="" overloaded="no">
- <autodoc>SetSelectionStart(int pos)</autodoc>
+ <autodoc>SetSelectionStart(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="GetSelectionStart" type="int" overloaded="no">
- <autodoc>GetSelectionStart() -> int</autodoc>
+ <autodoc>GetSelectionStart(self) -> int</autodoc>
</method>
<method name="SetSelectionEnd" type="" overloaded="no">
- <autodoc>SetSelectionEnd(int pos)</autodoc>
+ <autodoc>SetSelectionEnd(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="GetSelectionEnd" type="int" overloaded="no">
- <autodoc>GetSelectionEnd() -> int</autodoc>
+ <autodoc>GetSelectionEnd(self) -> int</autodoc>
</method>
<method name="SetPrintMagnification" type="" overloaded="no">
- <autodoc>SetPrintMagnification(int magnification)</autodoc>
+ <autodoc>SetPrintMagnification(self, int magnification)</autodoc>
<paramlist>
<param name="magnification" type="int" default=""/>
</paramlist>
</method>
<method name="GetPrintMagnification" type="int" overloaded="no">
- <autodoc>GetPrintMagnification() -> int</autodoc>
+ <autodoc>GetPrintMagnification(self) -> int</autodoc>
</method>
<method name="SetPrintColourMode" type="" overloaded="no">
- <autodoc>SetPrintColourMode(int mode)</autodoc>
+ <autodoc>SetPrintColourMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="GetPrintColourMode" type="int" overloaded="no">
- <autodoc>GetPrintColourMode() -> int</autodoc>
+ <autodoc>GetPrintColourMode(self) -> int</autodoc>
</method>
<method name="FindText" type="int" overloaded="no">
- <autodoc>FindText(int minPos, int maxPos, String text, int flags=0) -> int</autodoc>
+ <autodoc>FindText(self, int minPos, int maxPos, String text, int flags=0) -> int</autodoc>
<paramlist>
<param name="minPos" type="int" default=""/>
<param name="maxPos" type="int" default=""/>
</paramlist>
</method>
<method name="FormatRange" type="int" overloaded="no">
- <autodoc>FormatRange(bool doDraw, int startPos, int endPos, DC draw, DC target,
+ <autodoc>FormatRange(self, bool doDraw, int startPos, int endPos, DC draw, DC target,
Rect renderRect, Rect pageRect) -> int</autodoc>
<paramlist>
<param name="doDraw" type="bool" default=""/>
</paramlist>
</method>
<method name="GetFirstVisibleLine" type="int" overloaded="no">
- <autodoc>GetFirstVisibleLine() -> int</autodoc>
+ <autodoc>GetFirstVisibleLine(self) -> int</autodoc>
</method>
<method name="GetLine" type="String" overloaded="no">
- <autodoc>GetLine(int line) -> String</autodoc>
+ <autodoc>GetLine(self, int line) -> String</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="GetLineCount" type="int" overloaded="no">
- <autodoc>GetLineCount() -> int</autodoc>
+ <autodoc>GetLineCount(self) -> int</autodoc>
</method>
<method name="SetMarginLeft" type="" overloaded="no">
- <autodoc>SetMarginLeft(int pixelWidth)</autodoc>
+ <autodoc>SetMarginLeft(self, int pixelWidth)</autodoc>
<paramlist>
<param name="pixelWidth" type="int" default=""/>
</paramlist>
</method>
<method name="GetMarginLeft" type="int" overloaded="no">
- <autodoc>GetMarginLeft() -> int</autodoc>
+ <autodoc>GetMarginLeft(self) -> int</autodoc>
</method>
<method name="SetMarginRight" type="" overloaded="no">
- <autodoc>SetMarginRight(int pixelWidth)</autodoc>
+ <autodoc>SetMarginRight(self, int pixelWidth)</autodoc>
<paramlist>
<param name="pixelWidth" type="int" default=""/>
</paramlist>
</method>
<method name="GetMarginRight" type="int" overloaded="no">
- <autodoc>GetMarginRight() -> int</autodoc>
+ <autodoc>GetMarginRight(self) -> int</autodoc>
</method>
<method name="GetModify" type="bool" overloaded="no">
- <autodoc>GetModify() -> bool</autodoc>
+ <autodoc>GetModify(self) -> bool</autodoc>
</method>
<method name="SetSelection" type="" overloaded="no">
- <autodoc>SetSelection(int start, int end)</autodoc>
+ <autodoc>SetSelection(self, int start, int end)</autodoc>
<paramlist>
<param name="start" type="int" default=""/>
<param name="end" type="int" default=""/>
</paramlist>
</method>
<method name="GetSelectedText" type="String" overloaded="no">
- <autodoc>GetSelectedText() -> String</autodoc>
+ <autodoc>GetSelectedText(self) -> String</autodoc>
</method>
<method name="GetTextRange" type="String" overloaded="no">
- <autodoc>GetTextRange(int startPos, int endPos) -> String</autodoc>
+ <autodoc>GetTextRange(self, int startPos, int endPos) -> String</autodoc>
<paramlist>
<param name="startPos" type="int" default=""/>
<param name="endPos" type="int" default=""/>
</paramlist>
</method>
<method name="HideSelection" type="" overloaded="no">
- <autodoc>HideSelection(bool normal)</autodoc>
+ <autodoc>HideSelection(self, bool normal)</autodoc>
<paramlist>
<param name="normal" type="bool" default=""/>
</paramlist>
</method>
<method name="LineFromPosition" type="int" overloaded="no">
- <autodoc>LineFromPosition(int pos) -> int</autodoc>
+ <autodoc>LineFromPosition(self, int pos) -> int</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="PositionFromLine" type="int" overloaded="no">
- <autodoc>PositionFromLine(int line) -> int</autodoc>
+ <autodoc>PositionFromLine(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="LineScroll" type="" overloaded="no">
- <autodoc>LineScroll(int columns, int lines)</autodoc>
+ <autodoc>LineScroll(self, int columns, int lines)</autodoc>
<paramlist>
<param name="columns" type="int" default=""/>
<param name="lines" type="int" default=""/>
</paramlist>
</method>
<method name="EnsureCaretVisible" type="" overloaded="no">
- <autodoc>EnsureCaretVisible()</autodoc>
+ <autodoc>EnsureCaretVisible(self)</autodoc>
</method>
<method name="ReplaceSelection" type="" overloaded="no">
- <autodoc>ReplaceSelection(String text)</autodoc>
+ <autodoc>ReplaceSelection(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SetReadOnly" type="" overloaded="no">
- <autodoc>SetReadOnly(bool readOnly)</autodoc>
+ <autodoc>SetReadOnly(self, bool readOnly)</autodoc>
<paramlist>
<param name="readOnly" type="bool" default=""/>
</paramlist>
</method>
<method name="CanPaste" type="bool" overloaded="no">
- <autodoc>CanPaste() -> bool</autodoc>
+ <autodoc>CanPaste(self) -> bool</autodoc>
</method>
<method name="CanUndo" type="bool" overloaded="no">
- <autodoc>CanUndo() -> bool</autodoc>
+ <autodoc>CanUndo(self) -> bool</autodoc>
</method>
<method name="EmptyUndoBuffer" type="" overloaded="no">
- <autodoc>EmptyUndoBuffer()</autodoc>
+ <autodoc>EmptyUndoBuffer(self)</autodoc>
</method>
<method name="Undo" type="" overloaded="no">
- <autodoc>Undo()</autodoc>
+ <autodoc>Undo(self)</autodoc>
</method>
<method name="Cut" type="" overloaded="no">
- <autodoc>Cut()</autodoc>
+ <autodoc>Cut(self)</autodoc>
</method>
<method name="Copy" type="" overloaded="no">
- <autodoc>Copy()</autodoc>
+ <autodoc>Copy(self)</autodoc>
</method>
<method name="Paste" type="" overloaded="no">
- <autodoc>Paste()</autodoc>
+ <autodoc>Paste(self)</autodoc>
</method>
<method name="Clear" type="" overloaded="no">
- <autodoc>Clear()</autodoc>
+ <autodoc>Clear(self)</autodoc>
</method>
<method name="SetText" type="" overloaded="no">
- <autodoc>SetText(String text)</autodoc>
+ <autodoc>SetText(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="GetText" type="String" overloaded="no">
- <autodoc>GetText() -> String</autodoc>
+ <autodoc>GetText(self) -> String</autodoc>
</method>
<method name="GetTextLength" type="int" overloaded="no">
- <autodoc>GetTextLength() -> int</autodoc>
+ <autodoc>GetTextLength(self) -> int</autodoc>
</method>
<method name="SetOvertype" type="" overloaded="no">
- <autodoc>SetOvertype(bool overtype)</autodoc>
+ <autodoc>SetOvertype(self, bool overtype)</autodoc>
<paramlist>
<param name="overtype" type="bool" default=""/>
</paramlist>
</method>
<method name="GetOvertype" type="bool" overloaded="no">
- <autodoc>GetOvertype() -> bool</autodoc>
+ <autodoc>GetOvertype(self) -> bool</autodoc>
</method>
<method name="SetCaretWidth" type="" overloaded="no">
- <autodoc>SetCaretWidth(int pixelWidth)</autodoc>
+ <autodoc>SetCaretWidth(self, int pixelWidth)</autodoc>
<paramlist>
<param name="pixelWidth" type="int" default=""/>
</paramlist>
</method>
<method name="GetCaretWidth" type="int" overloaded="no">
- <autodoc>GetCaretWidth() -> int</autodoc>
+ <autodoc>GetCaretWidth(self) -> int</autodoc>
</method>
<method name="SetTargetStart" type="" overloaded="no">
- <autodoc>SetTargetStart(int pos)</autodoc>
+ <autodoc>SetTargetStart(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="GetTargetStart" type="int" overloaded="no">
- <autodoc>GetTargetStart() -> int</autodoc>
+ <autodoc>GetTargetStart(self) -> int</autodoc>
</method>
<method name="SetTargetEnd" type="" overloaded="no">
- <autodoc>SetTargetEnd(int pos)</autodoc>
+ <autodoc>SetTargetEnd(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="GetTargetEnd" type="int" overloaded="no">
- <autodoc>GetTargetEnd() -> int</autodoc>
+ <autodoc>GetTargetEnd(self) -> int</autodoc>
</method>
<method name="ReplaceTarget" type="int" overloaded="no">
- <autodoc>ReplaceTarget(String text) -> int</autodoc>
+ <autodoc>ReplaceTarget(self, String text) -> int</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="ReplaceTargetRE" type="int" overloaded="no">
- <autodoc>ReplaceTargetRE(String text) -> int</autodoc>
+ <autodoc>ReplaceTargetRE(self, String text) -> int</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SearchInTarget" type="int" overloaded="no">
- <autodoc>SearchInTarget(String text) -> int</autodoc>
+ <autodoc>SearchInTarget(self, String text) -> int</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SetSearchFlags" type="" overloaded="no">
- <autodoc>SetSearchFlags(int flags)</autodoc>
+ <autodoc>SetSearchFlags(self, int flags)</autodoc>
<paramlist>
<param name="flags" type="int" default=""/>
</paramlist>
</method>
<method name="GetSearchFlags" type="int" overloaded="no">
- <autodoc>GetSearchFlags() -> int</autodoc>
+ <autodoc>GetSearchFlags(self) -> int</autodoc>
</method>
<method name="CallTipShow" type="" overloaded="no">
- <autodoc>CallTipShow(int pos, String definition)</autodoc>
+ <autodoc>CallTipShow(self, int pos, String definition)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
<param name="definition" type="String" default=""/>
</paramlist>
</method>
<method name="CallTipCancel" type="" overloaded="no">
- <autodoc>CallTipCancel()</autodoc>
+ <autodoc>CallTipCancel(self)</autodoc>
</method>
<method name="CallTipActive" type="bool" overloaded="no">
- <autodoc>CallTipActive() -> bool</autodoc>
+ <autodoc>CallTipActive(self) -> bool</autodoc>
</method>
<method name="CallTipPosAtStart" type="int" overloaded="no">
- <autodoc>CallTipPosAtStart() -> int</autodoc>
+ <autodoc>CallTipPosAtStart(self) -> int</autodoc>
</method>
<method name="CallTipSetHighlight" type="" overloaded="no">
- <autodoc>CallTipSetHighlight(int start, int end)</autodoc>
+ <autodoc>CallTipSetHighlight(self, int start, int end)</autodoc>
<paramlist>
<param name="start" type="int" default=""/>
<param name="end" type="int" default=""/>
</paramlist>
</method>
<method name="CallTipSetBackground" type="" overloaded="no">
- <autodoc>CallTipSetBackground(Colour back)</autodoc>
+ <autodoc>CallTipSetBackground(self, Colour back)</autodoc>
<paramlist>
<param name="back" type="Colour" default=""/>
</paramlist>
</method>
<method name="CallTipSetForeground" type="" overloaded="no">
- <autodoc>CallTipSetForeground(Colour fore)</autodoc>
+ <autodoc>CallTipSetForeground(self, Colour fore)</autodoc>
<paramlist>
<param name="fore" type="Colour" default=""/>
</paramlist>
</method>
<method name="CallTipSetForegroundHighlight" type="" overloaded="no">
- <autodoc>CallTipSetForegroundHighlight(Colour fore)</autodoc>
+ <autodoc>CallTipSetForegroundHighlight(self, Colour fore)</autodoc>
<paramlist>
<param name="fore" type="Colour" default=""/>
</paramlist>
</method>
<method name="VisibleFromDocLine" type="int" overloaded="no">
- <autodoc>VisibleFromDocLine(int line) -> int</autodoc>
+ <autodoc>VisibleFromDocLine(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="DocLineFromVisible" type="int" overloaded="no">
- <autodoc>DocLineFromVisible(int lineDisplay) -> int</autodoc>
+ <autodoc>DocLineFromVisible(self, int lineDisplay) -> int</autodoc>
<paramlist>
<param name="lineDisplay" type="int" default=""/>
</paramlist>
</method>
<method name="SetFoldLevel" type="" overloaded="no">
- <autodoc>SetFoldLevel(int line, int level)</autodoc>
+ <autodoc>SetFoldLevel(self, int line, int level)</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
<param name="level" type="int" default=""/>
</paramlist>
</method>
<method name="GetFoldLevel" type="int" overloaded="no">
- <autodoc>GetFoldLevel(int line) -> int</autodoc>
+ <autodoc>GetFoldLevel(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="GetLastChild" type="int" overloaded="no">
- <autodoc>GetLastChild(int line, int level) -> int</autodoc>
+ <autodoc>GetLastChild(self, int line, int level) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
<param name="level" type="int" default=""/>
</paramlist>
</method>
<method name="GetFoldParent" type="int" overloaded="no">
- <autodoc>GetFoldParent(int line) -> int</autodoc>
+ <autodoc>GetFoldParent(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="ShowLines" type="" overloaded="no">
- <autodoc>ShowLines(int lineStart, int lineEnd)</autodoc>
+ <autodoc>ShowLines(self, int lineStart, int lineEnd)</autodoc>
<paramlist>
<param name="lineStart" type="int" default=""/>
<param name="lineEnd" type="int" default=""/>
</paramlist>
</method>
<method name="HideLines" type="" overloaded="no">
- <autodoc>HideLines(int lineStart, int lineEnd)</autodoc>
+ <autodoc>HideLines(self, int lineStart, int lineEnd)</autodoc>
<paramlist>
<param name="lineStart" type="int" default=""/>
<param name="lineEnd" type="int" default=""/>
</paramlist>
</method>
<method name="GetLineVisible" type="bool" overloaded="no">
- <autodoc>GetLineVisible(int line) -> bool</autodoc>
+ <autodoc>GetLineVisible(self, int line) -> bool</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="SetFoldExpanded" type="" overloaded="no">
- <autodoc>SetFoldExpanded(int line, bool expanded)</autodoc>
+ <autodoc>SetFoldExpanded(self, int line, bool expanded)</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
<param name="expanded" type="bool" default=""/>
</paramlist>
</method>
<method name="GetFoldExpanded" type="bool" overloaded="no">
- <autodoc>GetFoldExpanded(int line) -> bool</autodoc>
+ <autodoc>GetFoldExpanded(self, int line) -> bool</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="ToggleFold" type="" overloaded="no">
- <autodoc>ToggleFold(int line)</autodoc>
+ <autodoc>ToggleFold(self, int line)</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="EnsureVisible" type="" overloaded="no">
- <autodoc>EnsureVisible(int line)</autodoc>
+ <autodoc>EnsureVisible(self, int line)</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="SetFoldFlags" type="" overloaded="no">
- <autodoc>SetFoldFlags(int flags)</autodoc>
+ <autodoc>SetFoldFlags(self, int flags)</autodoc>
<paramlist>
<param name="flags" type="int" default=""/>
</paramlist>
</method>
<method name="EnsureVisibleEnforcePolicy" type="" overloaded="no">
- <autodoc>EnsureVisibleEnforcePolicy(int line)</autodoc>
+ <autodoc>EnsureVisibleEnforcePolicy(self, int line)</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="SetTabIndents" type="" overloaded="no">
- <autodoc>SetTabIndents(bool tabIndents)</autodoc>
+ <autodoc>SetTabIndents(self, bool tabIndents)</autodoc>
<paramlist>
<param name="tabIndents" type="bool" default=""/>
</paramlist>
</method>
<method name="GetTabIndents" type="bool" overloaded="no">
- <autodoc>GetTabIndents() -> bool</autodoc>
+ <autodoc>GetTabIndents(self) -> bool</autodoc>
</method>
<method name="SetBackSpaceUnIndents" type="" overloaded="no">
- <autodoc>SetBackSpaceUnIndents(bool bsUnIndents)</autodoc>
+ <autodoc>SetBackSpaceUnIndents(self, bool bsUnIndents)</autodoc>
<paramlist>
<param name="bsUnIndents" type="bool" default=""/>
</paramlist>
</method>
<method name="GetBackSpaceUnIndents" type="bool" overloaded="no">
- <autodoc>GetBackSpaceUnIndents() -> bool</autodoc>
+ <autodoc>GetBackSpaceUnIndents(self) -> bool</autodoc>
</method>
<method name="SetMouseDwellTime" type="" overloaded="no">
- <autodoc>SetMouseDwellTime(int periodMilliseconds)</autodoc>
+ <autodoc>SetMouseDwellTime(self, int periodMilliseconds)</autodoc>
<paramlist>
<param name="periodMilliseconds" type="int" default=""/>
</paramlist>
</method>
<method name="GetMouseDwellTime" type="int" overloaded="no">
- <autodoc>GetMouseDwellTime() -> int</autodoc>
+ <autodoc>GetMouseDwellTime(self) -> int</autodoc>
</method>
<method name="WordStartPosition" type="int" overloaded="no">
- <autodoc>WordStartPosition(int pos, bool onlyWordCharacters) -> int</autodoc>
+ <autodoc>WordStartPosition(self, int pos, bool onlyWordCharacters) -> int</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
<param name="onlyWordCharacters" type="bool" default=""/>
</paramlist>
</method>
<method name="WordEndPosition" type="int" overloaded="no">
- <autodoc>WordEndPosition(int pos, bool onlyWordCharacters) -> int</autodoc>
+ <autodoc>WordEndPosition(self, int pos, bool onlyWordCharacters) -> int</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
<param name="onlyWordCharacters" type="bool" default=""/>
</paramlist>
</method>
<method name="SetWrapMode" type="" overloaded="no">
- <autodoc>SetWrapMode(int mode)</autodoc>
+ <autodoc>SetWrapMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="GetWrapMode" type="int" overloaded="no">
- <autodoc>GetWrapMode() -> int</autodoc>
+ <autodoc>GetWrapMode(self) -> int</autodoc>
</method>
<method name="SetLayoutCache" type="" overloaded="no">
- <autodoc>SetLayoutCache(int mode)</autodoc>
+ <autodoc>SetLayoutCache(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="GetLayoutCache" type="int" overloaded="no">
- <autodoc>GetLayoutCache() -> int</autodoc>
+ <autodoc>GetLayoutCache(self) -> int</autodoc>
</method>
<method name="SetScrollWidth" type="" overloaded="no">
- <autodoc>SetScrollWidth(int pixelWidth)</autodoc>
+ <autodoc>SetScrollWidth(self, int pixelWidth)</autodoc>
<paramlist>
<param name="pixelWidth" type="int" default=""/>
</paramlist>
</method>
<method name="GetScrollWidth" type="int" overloaded="no">
- <autodoc>GetScrollWidth() -> int</autodoc>
+ <autodoc>GetScrollWidth(self) -> int</autodoc>
</method>
<method name="TextWidth" type="int" overloaded="no">
- <autodoc>TextWidth(int style, String text) -> int</autodoc>
+ <autodoc>TextWidth(self, int style, String text) -> int</autodoc>
<paramlist>
<param name="style" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SetEndAtLastLine" type="" overloaded="no">
- <autodoc>SetEndAtLastLine(bool endAtLastLine)</autodoc>
+ <autodoc>SetEndAtLastLine(self, bool endAtLastLine)</autodoc>
<paramlist>
<param name="endAtLastLine" type="bool" default=""/>
</paramlist>
</method>
<method name="GetEndAtLastLine" type="int" overloaded="no">
- <autodoc>GetEndAtLastLine() -> int</autodoc>
+ <autodoc>GetEndAtLastLine(self) -> int</autodoc>
</method>
<method name="TextHeight" type="int" overloaded="no">
- <autodoc>TextHeight(int line) -> int</autodoc>
+ <autodoc>TextHeight(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="SetUseVerticalScrollBar" type="" overloaded="no">
- <autodoc>SetUseVerticalScrollBar(bool show)</autodoc>
+ <autodoc>SetUseVerticalScrollBar(self, bool show)</autodoc>
<paramlist>
<param name="show" type="bool" default=""/>
</paramlist>
</method>
<method name="GetUseVerticalScrollBar" type="bool" overloaded="no">
- <autodoc>GetUseVerticalScrollBar() -> bool</autodoc>
+ <autodoc>GetUseVerticalScrollBar(self) -> bool</autodoc>
</method>
<method name="AppendText" type="" overloaded="no">
- <autodoc>AppendText(int length, String text)</autodoc>
+ <autodoc>AppendText(self, int length, String text)</autodoc>
<paramlist>
<param name="length" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="GetTwoPhaseDraw" type="bool" overloaded="no">
- <autodoc>GetTwoPhaseDraw() -> bool</autodoc>
+ <autodoc>GetTwoPhaseDraw(self) -> bool</autodoc>
</method>
<method name="SetTwoPhaseDraw" type="" overloaded="no">
- <autodoc>SetTwoPhaseDraw(bool twoPhase)</autodoc>
+ <autodoc>SetTwoPhaseDraw(self, bool twoPhase)</autodoc>
<paramlist>
<param name="twoPhase" type="bool" default=""/>
</paramlist>
</method>
<method name="TargetFromSelection" type="" overloaded="no">
- <autodoc>TargetFromSelection()</autodoc>
+ <autodoc>TargetFromSelection(self)</autodoc>
</method>
<method name="LinesJoin" type="" overloaded="no">
- <autodoc>LinesJoin()</autodoc>
+ <autodoc>LinesJoin(self)</autodoc>
</method>
<method name="LinesSplit" type="" overloaded="no">
- <autodoc>LinesSplit(int pixelWidth)</autodoc>
+ <autodoc>LinesSplit(self, int pixelWidth)</autodoc>
<paramlist>
<param name="pixelWidth" type="int" default=""/>
</paramlist>
</method>
<method name="SetFoldMarginColour" type="" overloaded="no">
- <autodoc>SetFoldMarginColour(bool useSetting, Colour back)</autodoc>
+ <autodoc>SetFoldMarginColour(self, bool useSetting, Colour back)</autodoc>
<paramlist>
<param name="useSetting" type="bool" default=""/>
<param name="back" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetFoldMarginHiColour" type="" overloaded="no">
- <autodoc>SetFoldMarginHiColour(bool useSetting, Colour fore)</autodoc>
+ <autodoc>SetFoldMarginHiColour(self, bool useSetting, Colour fore)</autodoc>
<paramlist>
<param name="useSetting" type="bool" default=""/>
<param name="fore" type="Colour" default=""/>
</paramlist>
</method>
<method name="LineDown" type="" overloaded="no">
- <autodoc>LineDown()</autodoc>
+ <autodoc>LineDown(self)</autodoc>
<docstring>This is just a wrapper for ScrollLines(1).</docstring>
</method>
<method name="LineDownExtend" type="" overloaded="no">
- <autodoc>LineDownExtend()</autodoc>
+ <autodoc>LineDownExtend(self)</autodoc>
</method>
<method name="LineUp" type="" overloaded="no">
- <autodoc>LineUp()</autodoc>
+ <autodoc>LineUp(self)</autodoc>
<docstring>This is just a wrapper for ScrollLines(-1).</docstring>
</method>
<method name="LineUpExtend" type="" overloaded="no">
- <autodoc>LineUpExtend()</autodoc>
+ <autodoc>LineUpExtend(self)</autodoc>
</method>
<method name="CharLeft" type="" overloaded="no">
- <autodoc>CharLeft()</autodoc>
+ <autodoc>CharLeft(self)</autodoc>
</method>
<method name="CharLeftExtend" type="" overloaded="no">
- <autodoc>CharLeftExtend()</autodoc>
+ <autodoc>CharLeftExtend(self)</autodoc>
</method>
<method name="CharRight" type="" overloaded="no">
- <autodoc>CharRight()</autodoc>
+ <autodoc>CharRight(self)</autodoc>
</method>
<method name="CharRightExtend" type="" overloaded="no">
- <autodoc>CharRightExtend()</autodoc>
+ <autodoc>CharRightExtend(self)</autodoc>
</method>
<method name="WordLeft" type="" overloaded="no">
- <autodoc>WordLeft()</autodoc>
+ <autodoc>WordLeft(self)</autodoc>
</method>
<method name="WordLeftExtend" type="" overloaded="no">
- <autodoc>WordLeftExtend()</autodoc>
+ <autodoc>WordLeftExtend(self)</autodoc>
</method>
<method name="WordRight" type="" overloaded="no">
- <autodoc>WordRight()</autodoc>
+ <autodoc>WordRight(self)</autodoc>
</method>
<method name="WordRightExtend" type="" overloaded="no">
- <autodoc>WordRightExtend()</autodoc>
+ <autodoc>WordRightExtend(self)</autodoc>
</method>
<method name="Home" type="" overloaded="no">
- <autodoc>Home()</autodoc>
+ <autodoc>Home(self)</autodoc>
</method>
<method name="HomeExtend" type="" overloaded="no">
- <autodoc>HomeExtend()</autodoc>
+ <autodoc>HomeExtend(self)</autodoc>
</method>
<method name="LineEnd" type="" overloaded="no">
- <autodoc>LineEnd()</autodoc>
+ <autodoc>LineEnd(self)</autodoc>
</method>
<method name="LineEndExtend" type="" overloaded="no">
- <autodoc>LineEndExtend()</autodoc>
+ <autodoc>LineEndExtend(self)</autodoc>
</method>
<method name="DocumentStart" type="" overloaded="no">
- <autodoc>DocumentStart()</autodoc>
+ <autodoc>DocumentStart(self)</autodoc>
</method>
<method name="DocumentStartExtend" type="" overloaded="no">
- <autodoc>DocumentStartExtend()</autodoc>
+ <autodoc>DocumentStartExtend(self)</autodoc>
</method>
<method name="DocumentEnd" type="" overloaded="no">
- <autodoc>DocumentEnd()</autodoc>
+ <autodoc>DocumentEnd(self)</autodoc>
</method>
<method name="DocumentEndExtend" type="" overloaded="no">
- <autodoc>DocumentEndExtend()</autodoc>
+ <autodoc>DocumentEndExtend(self)</autodoc>
</method>
<method name="PageUp" type="" overloaded="no">
- <autodoc>PageUp()</autodoc>
+ <autodoc>PageUp(self)</autodoc>
<docstring>This is just a wrapper for ScrollPages(-1).</docstring>
</method>
<method name="PageUpExtend" type="" overloaded="no">
- <autodoc>PageUpExtend()</autodoc>
+ <autodoc>PageUpExtend(self)</autodoc>
</method>
<method name="PageDown" type="" overloaded="no">
- <autodoc>PageDown()</autodoc>
+ <autodoc>PageDown(self)</autodoc>
<docstring>This is just a wrapper for ScrollPages(1).</docstring>
</method>
<method name="PageDownExtend" type="" overloaded="no">
- <autodoc>PageDownExtend()</autodoc>
+ <autodoc>PageDownExtend(self)</autodoc>
</method>
<method name="EditToggleOvertype" type="" overloaded="no">
- <autodoc>EditToggleOvertype()</autodoc>
+ <autodoc>EditToggleOvertype(self)</autodoc>
</method>
<method name="Cancel" type="" overloaded="no">
- <autodoc>Cancel()</autodoc>
+ <autodoc>Cancel(self)</autodoc>
</method>
<method name="DeleteBack" type="" overloaded="no">
- <autodoc>DeleteBack()</autodoc>
+ <autodoc>DeleteBack(self)</autodoc>
</method>
<method name="Tab" type="" overloaded="no">
- <autodoc>Tab()</autodoc>
+ <autodoc>Tab(self)</autodoc>
</method>
<method name="BackTab" type="" overloaded="no">
- <autodoc>BackTab()</autodoc>
+ <autodoc>BackTab(self)</autodoc>
</method>
<method name="NewLine" type="" overloaded="no">
- <autodoc>NewLine()</autodoc>
+ <autodoc>NewLine(self)</autodoc>
</method>
<method name="FormFeed" type="" overloaded="no">
- <autodoc>FormFeed()</autodoc>
+ <autodoc>FormFeed(self)</autodoc>
</method>
<method name="VCHome" type="" overloaded="no">
- <autodoc>VCHome()</autodoc>
+ <autodoc>VCHome(self)</autodoc>
</method>
<method name="VCHomeExtend" type="" overloaded="no">
- <autodoc>VCHomeExtend()</autodoc>
+ <autodoc>VCHomeExtend(self)</autodoc>
</method>
<method name="ZoomIn" type="" overloaded="no">
- <autodoc>ZoomIn()</autodoc>
+ <autodoc>ZoomIn(self)</autodoc>
</method>
<method name="ZoomOut" type="" overloaded="no">
- <autodoc>ZoomOut()</autodoc>
+ <autodoc>ZoomOut(self)</autodoc>
</method>
<method name="DelWordLeft" type="" overloaded="no">
- <autodoc>DelWordLeft()</autodoc>
+ <autodoc>DelWordLeft(self)</autodoc>
</method>
<method name="DelWordRight" type="" overloaded="no">
- <autodoc>DelWordRight()</autodoc>
+ <autodoc>DelWordRight(self)</autodoc>
</method>
<method name="LineCut" type="" overloaded="no">
- <autodoc>LineCut()</autodoc>
+ <autodoc>LineCut(self)</autodoc>
</method>
<method name="LineDelete" type="" overloaded="no">
- <autodoc>LineDelete()</autodoc>
+ <autodoc>LineDelete(self)</autodoc>
</method>
<method name="LineTranspose" type="" overloaded="no">
- <autodoc>LineTranspose()</autodoc>
+ <autodoc>LineTranspose(self)</autodoc>
</method>
<method name="LineDuplicate" type="" overloaded="no">
- <autodoc>LineDuplicate()</autodoc>
+ <autodoc>LineDuplicate(self)</autodoc>
</method>
<method name="LowerCase" type="" overloaded="no">
- <autodoc>LowerCase()</autodoc>
+ <autodoc>LowerCase(self)</autodoc>
</method>
<method name="UpperCase" type="" overloaded="no">
- <autodoc>UpperCase()</autodoc>
+ <autodoc>UpperCase(self)</autodoc>
</method>
<method name="LineScrollDown" type="" overloaded="no">
- <autodoc>LineScrollDown()</autodoc>
+ <autodoc>LineScrollDown(self)</autodoc>
</method>
<method name="LineScrollUp" type="" overloaded="no">
- <autodoc>LineScrollUp()</autodoc>
+ <autodoc>LineScrollUp(self)</autodoc>
</method>
<method name="DeleteBackNotLine" type="" overloaded="no">
- <autodoc>DeleteBackNotLine()</autodoc>
+ <autodoc>DeleteBackNotLine(self)</autodoc>
</method>
<method name="HomeDisplay" type="" overloaded="no">
- <autodoc>HomeDisplay()</autodoc>
+ <autodoc>HomeDisplay(self)</autodoc>
</method>
<method name="HomeDisplayExtend" type="" overloaded="no">
- <autodoc>HomeDisplayExtend()</autodoc>
+ <autodoc>HomeDisplayExtend(self)</autodoc>
</method>
<method name="LineEndDisplay" type="" overloaded="no">
- <autodoc>LineEndDisplay()</autodoc>
+ <autodoc>LineEndDisplay(self)</autodoc>
</method>
<method name="LineEndDisplayExtend" type="" overloaded="no">
- <autodoc>LineEndDisplayExtend()</autodoc>
+ <autodoc>LineEndDisplayExtend(self)</autodoc>
</method>
<method name="HomeWrap" type="" overloaded="no">
- <autodoc>HomeWrap()</autodoc>
+ <autodoc>HomeWrap(self)</autodoc>
</method>
<method name="HomeWrapExtend" type="" overloaded="no">
- <autodoc>HomeWrapExtend()</autodoc>
+ <autodoc>HomeWrapExtend(self)</autodoc>
</method>
<method name="LineEndWrap" type="" overloaded="no">
- <autodoc>LineEndWrap()</autodoc>
+ <autodoc>LineEndWrap(self)</autodoc>
</method>
<method name="LineEndWrapExtend" type="" overloaded="no">
- <autodoc>LineEndWrapExtend()</autodoc>
+ <autodoc>LineEndWrapExtend(self)</autodoc>
</method>
<method name="VCHomeWrap" type="" overloaded="no">
- <autodoc>VCHomeWrap()</autodoc>
+ <autodoc>VCHomeWrap(self)</autodoc>
</method>
<method name="VCHomeWrapExtend" type="" overloaded="no">
- <autodoc>VCHomeWrapExtend()</autodoc>
+ <autodoc>VCHomeWrapExtend(self)</autodoc>
</method>
<method name="LineCopy" type="" overloaded="no">
- <autodoc>LineCopy()</autodoc>
+ <autodoc>LineCopy(self)</autodoc>
</method>
<method name="MoveCaretInsideView" type="" overloaded="no">
- <autodoc>MoveCaretInsideView()</autodoc>
+ <autodoc>MoveCaretInsideView(self)</autodoc>
</method>
<method name="LineLength" type="int" overloaded="no">
- <autodoc>LineLength(int line) -> int</autodoc>
+ <autodoc>LineLength(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="BraceHighlight" type="" overloaded="no">
- <autodoc>BraceHighlight(int pos1, int pos2)</autodoc>
+ <autodoc>BraceHighlight(self, int pos1, int pos2)</autodoc>
<paramlist>
<param name="pos1" type="int" default=""/>
<param name="pos2" type="int" default=""/>
</paramlist>
</method>
<method name="BraceBadLight" type="" overloaded="no">
- <autodoc>BraceBadLight(int pos)</autodoc>
+ <autodoc>BraceBadLight(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="BraceMatch" type="int" overloaded="no">
- <autodoc>BraceMatch(int pos) -> int</autodoc>
+ <autodoc>BraceMatch(self, int pos) -> int</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="GetViewEOL" type="bool" overloaded="no">
- <autodoc>GetViewEOL() -> bool</autodoc>
+ <autodoc>GetViewEOL(self) -> bool</autodoc>
</method>
<method name="SetViewEOL" type="" overloaded="no">
- <autodoc>SetViewEOL(bool visible)</autodoc>
+ <autodoc>SetViewEOL(self, bool visible)</autodoc>
<paramlist>
<param name="visible" type="bool" default=""/>
</paramlist>
</method>
<method name="GetDocPointer" type="" overloaded="no">
- <autodoc>GetDocPointer() -> void</autodoc>
+ <autodoc>GetDocPointer(self) -> void</autodoc>
</method>
<method name="SetDocPointer" type="" overloaded="no">
- <autodoc>SetDocPointer(void docPointer)</autodoc>
+ <autodoc>SetDocPointer(self, void docPointer)</autodoc>
<paramlist>
<param name="docPointer" type="" default=""/>
</paramlist>
</method>
<method name="SetModEventMask" type="" overloaded="no">
- <autodoc>SetModEventMask(int mask)</autodoc>
+ <autodoc>SetModEventMask(self, int mask)</autodoc>
<paramlist>
<param name="mask" type="int" default=""/>
</paramlist>
</method>
<method name="GetEdgeColumn" type="int" overloaded="no">
- <autodoc>GetEdgeColumn() -> int</autodoc>
+ <autodoc>GetEdgeColumn(self) -> int</autodoc>
</method>
<method name="SetEdgeColumn" type="" overloaded="no">
- <autodoc>SetEdgeColumn(int column)</autodoc>
+ <autodoc>SetEdgeColumn(self, int column)</autodoc>
<paramlist>
<param name="column" type="int" default=""/>
</paramlist>
</method>
<method name="GetEdgeMode" type="int" overloaded="no">
- <autodoc>GetEdgeMode() -> int</autodoc>
+ <autodoc>GetEdgeMode(self) -> int</autodoc>
</method>
<method name="SetEdgeMode" type="" overloaded="no">
- <autodoc>SetEdgeMode(int mode)</autodoc>
+ <autodoc>SetEdgeMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="GetEdgeColour" type="Colour" overloaded="no">
- <autodoc>GetEdgeColour() -> Colour</autodoc>
+ <autodoc>GetEdgeColour(self) -> Colour</autodoc>
</method>
<method name="SetEdgeColour" type="" overloaded="no">
- <autodoc>SetEdgeColour(Colour edgeColour)</autodoc>
+ <autodoc>SetEdgeColour(self, Colour edgeColour)</autodoc>
<paramlist>
<param name="edgeColour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SearchAnchor" type="" overloaded="no">
- <autodoc>SearchAnchor()</autodoc>
+ <autodoc>SearchAnchor(self)</autodoc>
</method>
<method name="SearchNext" type="int" overloaded="no">
- <autodoc>SearchNext(int flags, String text) -> int</autodoc>
+ <autodoc>SearchNext(self, int flags, String text) -> int</autodoc>
<paramlist>
<param name="flags" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SearchPrev" type="int" overloaded="no">
- <autodoc>SearchPrev(int flags, String text) -> int</autodoc>
+ <autodoc>SearchPrev(self, int flags, String text) -> int</autodoc>
<paramlist>
<param name="flags" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="LinesOnScreen" type="int" overloaded="no">
- <autodoc>LinesOnScreen() -> int</autodoc>
+ <autodoc>LinesOnScreen(self) -> int</autodoc>
</method>
<method name="UsePopUp" type="" overloaded="no">
- <autodoc>UsePopUp(bool allowPopUp)</autodoc>
+ <autodoc>UsePopUp(self, bool allowPopUp)</autodoc>
<paramlist>
<param name="allowPopUp" type="bool" default=""/>
</paramlist>
</method>
<method name="SelectionIsRectangle" type="bool" overloaded="no">
- <autodoc>SelectionIsRectangle() -> bool</autodoc>
+ <autodoc>SelectionIsRectangle(self) -> bool</autodoc>
</method>
<method name="SetZoom" type="" overloaded="no">
- <autodoc>SetZoom(int zoom)</autodoc>
+ <autodoc>SetZoom(self, int zoom)</autodoc>
<paramlist>
<param name="zoom" type="int" default=""/>
</paramlist>
</method>
<method name="GetZoom" type="int" overloaded="no">
- <autodoc>GetZoom() -> int</autodoc>
+ <autodoc>GetZoom(self) -> int</autodoc>
</method>
<method name="CreateDocument" type="" overloaded="no">
- <autodoc>CreateDocument() -> void</autodoc>
+ <autodoc>CreateDocument(self) -> void</autodoc>
</method>
<method name="AddRefDocument" type="" overloaded="no">
- <autodoc>AddRefDocument(void docPointer)</autodoc>
+ <autodoc>AddRefDocument(self, void docPointer)</autodoc>
<paramlist>
<param name="docPointer" type="" default=""/>
</paramlist>
</method>
<method name="ReleaseDocument" type="" overloaded="no">
- <autodoc>ReleaseDocument(void docPointer)</autodoc>
+ <autodoc>ReleaseDocument(self, void docPointer)</autodoc>
<paramlist>
<param name="docPointer" type="" default=""/>
</paramlist>
</method>
<method name="GetModEventMask" type="int" overloaded="no">
- <autodoc>GetModEventMask() -> int</autodoc>
+ <autodoc>GetModEventMask(self) -> int</autodoc>
</method>
<method name="SetSTCFocus" type="" overloaded="no">
- <autodoc>SetSTCFocus(bool focus)</autodoc>
+ <autodoc>SetSTCFocus(self, bool focus)</autodoc>
<paramlist>
<param name="focus" type="bool" default=""/>
</paramlist>
</method>
<method name="GetSTCFocus" type="bool" overloaded="no">
- <autodoc>GetSTCFocus() -> bool</autodoc>
+ <autodoc>GetSTCFocus(self) -> bool</autodoc>
</method>
<method name="SetStatus" type="" overloaded="no">
- <autodoc>SetStatus(int statusCode)</autodoc>
+ <autodoc>SetStatus(self, int statusCode)</autodoc>
<paramlist>
<param name="statusCode" type="int" default=""/>
</paramlist>
</method>
<method name="GetStatus" type="int" overloaded="no">
- <autodoc>GetStatus() -> int</autodoc>
+ <autodoc>GetStatus(self) -> int</autodoc>
</method>
<method name="SetMouseDownCaptures" type="" overloaded="no">
- <autodoc>SetMouseDownCaptures(bool captures)</autodoc>
+ <autodoc>SetMouseDownCaptures(self, bool captures)</autodoc>
<paramlist>
<param name="captures" type="bool" default=""/>
</paramlist>
</method>
<method name="GetMouseDownCaptures" type="bool" overloaded="no">
- <autodoc>GetMouseDownCaptures() -> bool</autodoc>
+ <autodoc>GetMouseDownCaptures(self) -> bool</autodoc>
</method>
<method name="SetSTCCursor" type="" overloaded="no">
- <autodoc>SetSTCCursor(int cursorType)</autodoc>
+ <autodoc>SetSTCCursor(self, int cursorType)</autodoc>
<paramlist>
<param name="cursorType" type="int" default=""/>
</paramlist>
</method>
<method name="GetSTCCursor" type="int" overloaded="no">
- <autodoc>GetSTCCursor() -> int</autodoc>
+ <autodoc>GetSTCCursor(self) -> int</autodoc>
</method>
<method name="SetControlCharSymbol" type="" overloaded="no">
- <autodoc>SetControlCharSymbol(int symbol)</autodoc>
+ <autodoc>SetControlCharSymbol(self, int symbol)</autodoc>
<paramlist>
<param name="symbol" type="int" default=""/>
</paramlist>
</method>
<method name="GetControlCharSymbol" type="int" overloaded="no">
- <autodoc>GetControlCharSymbol() -> int</autodoc>
+ <autodoc>GetControlCharSymbol(self) -> int</autodoc>
</method>
<method name="WordPartLeft" type="" overloaded="no">
- <autodoc>WordPartLeft()</autodoc>
+ <autodoc>WordPartLeft(self)</autodoc>
</method>
<method name="WordPartLeftExtend" type="" overloaded="no">
- <autodoc>WordPartLeftExtend()</autodoc>
+ <autodoc>WordPartLeftExtend(self)</autodoc>
</method>
<method name="WordPartRight" type="" overloaded="no">
- <autodoc>WordPartRight()</autodoc>
+ <autodoc>WordPartRight(self)</autodoc>
</method>
<method name="WordPartRightExtend" type="" overloaded="no">
- <autodoc>WordPartRightExtend()</autodoc>
+ <autodoc>WordPartRightExtend(self)</autodoc>
</method>
<method name="SetVisiblePolicy" type="" overloaded="no">
- <autodoc>SetVisiblePolicy(int visiblePolicy, int visibleSlop)</autodoc>
+ <autodoc>SetVisiblePolicy(self, int visiblePolicy, int visibleSlop)</autodoc>
<paramlist>
<param name="visiblePolicy" type="int" default=""/>
<param name="visibleSlop" type="int" default=""/>
</paramlist>
</method>
<method name="DelLineLeft" type="" overloaded="no">
- <autodoc>DelLineLeft()</autodoc>
+ <autodoc>DelLineLeft(self)</autodoc>
</method>
<method name="DelLineRight" type="" overloaded="no">
- <autodoc>DelLineRight()</autodoc>
+ <autodoc>DelLineRight(self)</autodoc>
</method>
<method name="SetXOffset" type="" overloaded="no">
- <autodoc>SetXOffset(int newOffset)</autodoc>
+ <autodoc>SetXOffset(self, int newOffset)</autodoc>
<paramlist>
<param name="newOffset" type="int" default=""/>
</paramlist>
</method>
<method name="GetXOffset" type="int" overloaded="no">
- <autodoc>GetXOffset() -> int</autodoc>
+ <autodoc>GetXOffset(self) -> int</autodoc>
</method>
<method name="ChooseCaretX" type="" overloaded="no">
- <autodoc>ChooseCaretX()</autodoc>
+ <autodoc>ChooseCaretX(self)</autodoc>
</method>
<method name="SetXCaretPolicy" type="" overloaded="no">
- <autodoc>SetXCaretPolicy(int caretPolicy, int caretSlop)</autodoc>
+ <autodoc>SetXCaretPolicy(self, int caretPolicy, int caretSlop)</autodoc>
<paramlist>
<param name="caretPolicy" type="int" default=""/>
<param name="caretSlop" type="int" default=""/>
</paramlist>
</method>
<method name="SetYCaretPolicy" type="" overloaded="no">
- <autodoc>SetYCaretPolicy(int caretPolicy, int caretSlop)</autodoc>
+ <autodoc>SetYCaretPolicy(self, int caretPolicy, int caretSlop)</autodoc>
<paramlist>
<param name="caretPolicy" type="int" default=""/>
<param name="caretSlop" type="int" default=""/>
</paramlist>
</method>
<method name="SetPrintWrapMode" type="" overloaded="no">
- <autodoc>SetPrintWrapMode(int mode)</autodoc>
+ <autodoc>SetPrintWrapMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="GetPrintWrapMode" type="int" overloaded="no">
- <autodoc>GetPrintWrapMode() -> int</autodoc>
+ <autodoc>GetPrintWrapMode(self) -> int</autodoc>
</method>
<method name="SetHotspotActiveForeground" type="" overloaded="no">
- <autodoc>SetHotspotActiveForeground(bool useSetting, Colour fore)</autodoc>
+ <autodoc>SetHotspotActiveForeground(self, bool useSetting, Colour fore)</autodoc>
<paramlist>
<param name="useSetting" type="bool" default=""/>
<param name="fore" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetHotspotActiveBackground" type="" overloaded="no">
- <autodoc>SetHotspotActiveBackground(bool useSetting, Colour back)</autodoc>
+ <autodoc>SetHotspotActiveBackground(self, bool useSetting, Colour back)</autodoc>
<paramlist>
<param name="useSetting" type="bool" default=""/>
<param name="back" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetHotspotActiveUnderline" type="" overloaded="no">
- <autodoc>SetHotspotActiveUnderline(bool underline)</autodoc>
+ <autodoc>SetHotspotActiveUnderline(self, bool underline)</autodoc>
<paramlist>
<param name="underline" type="bool" default=""/>
</paramlist>
</method>
<method name="SetHotspotSingleLine" type="" overloaded="no">
- <autodoc>SetHotspotSingleLine(bool singleLine)</autodoc>
+ <autodoc>SetHotspotSingleLine(self, bool singleLine)</autodoc>
<paramlist>
<param name="singleLine" type="bool" default=""/>
</paramlist>
</method>
<method name="ParaDown" type="" overloaded="no">
- <autodoc>ParaDown()</autodoc>
+ <autodoc>ParaDown(self)</autodoc>
</method>
<method name="ParaDownExtend" type="" overloaded="no">
- <autodoc>ParaDownExtend()</autodoc>
+ <autodoc>ParaDownExtend(self)</autodoc>
</method>
<method name="ParaUp" type="" overloaded="no">
- <autodoc>ParaUp()</autodoc>
+ <autodoc>ParaUp(self)</autodoc>
</method>
<method name="ParaUpExtend" type="" overloaded="no">
- <autodoc>ParaUpExtend()</autodoc>
+ <autodoc>ParaUpExtend(self)</autodoc>
</method>
<method name="PositionBefore" type="int" overloaded="no">
- <autodoc>PositionBefore(int pos) -> int</autodoc>
+ <autodoc>PositionBefore(self, int pos) -> int</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="PositionAfter" type="int" overloaded="no">
- <autodoc>PositionAfter(int pos) -> int</autodoc>
+ <autodoc>PositionAfter(self, int pos) -> int</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="CopyRange" type="" overloaded="no">
- <autodoc>CopyRange(int start, int end)</autodoc>
+ <autodoc>CopyRange(self, int start, int end)</autodoc>
<paramlist>
<param name="start" type="int" default=""/>
<param name="end" type="int" default=""/>
</paramlist>
</method>
<method name="CopyText" type="" overloaded="no">
- <autodoc>CopyText(int length, String text)</autodoc>
+ <autodoc>CopyText(self, int length, String text)</autodoc>
<paramlist>
<param name="length" type="int" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SetSelectionMode" type="" overloaded="no">
- <autodoc>SetSelectionMode(int mode)</autodoc>
+ <autodoc>SetSelectionMode(self, int mode)</autodoc>
<paramlist>
<param name="mode" type="int" default=""/>
</paramlist>
</method>
<method name="GetSelectionMode" type="int" overloaded="no">
- <autodoc>GetSelectionMode() -> int</autodoc>
+ <autodoc>GetSelectionMode(self) -> int</autodoc>
</method>
<method name="GetLineSelStartPosition" type="int" overloaded="no">
- <autodoc>GetLineSelStartPosition(int line) -> int</autodoc>
+ <autodoc>GetLineSelStartPosition(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="GetLineSelEndPosition" type="int" overloaded="no">
- <autodoc>GetLineSelEndPosition(int line) -> int</autodoc>
+ <autodoc>GetLineSelEndPosition(self, int line) -> int</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="LineDownRectExtend" type="" overloaded="no">
- <autodoc>LineDownRectExtend()</autodoc>
+ <autodoc>LineDownRectExtend(self)</autodoc>
</method>
<method name="LineUpRectExtend" type="" overloaded="no">
- <autodoc>LineUpRectExtend()</autodoc>
+ <autodoc>LineUpRectExtend(self)</autodoc>
</method>
<method name="CharLeftRectExtend" type="" overloaded="no">
- <autodoc>CharLeftRectExtend()</autodoc>
+ <autodoc>CharLeftRectExtend(self)</autodoc>
</method>
<method name="CharRightRectExtend" type="" overloaded="no">
- <autodoc>CharRightRectExtend()</autodoc>
+ <autodoc>CharRightRectExtend(self)</autodoc>
</method>
<method name="HomeRectExtend" type="" overloaded="no">
- <autodoc>HomeRectExtend()</autodoc>
+ <autodoc>HomeRectExtend(self)</autodoc>
</method>
<method name="VCHomeRectExtend" type="" overloaded="no">
- <autodoc>VCHomeRectExtend()</autodoc>
+ <autodoc>VCHomeRectExtend(self)</autodoc>
</method>
<method name="LineEndRectExtend" type="" overloaded="no">
- <autodoc>LineEndRectExtend()</autodoc>
+ <autodoc>LineEndRectExtend(self)</autodoc>
</method>
<method name="PageUpRectExtend" type="" overloaded="no">
- <autodoc>PageUpRectExtend()</autodoc>
+ <autodoc>PageUpRectExtend(self)</autodoc>
</method>
<method name="PageDownRectExtend" type="" overloaded="no">
- <autodoc>PageDownRectExtend()</autodoc>
+ <autodoc>PageDownRectExtend(self)</autodoc>
</method>
<method name="StutteredPageUp" type="" overloaded="no">
- <autodoc>StutteredPageUp()</autodoc>
+ <autodoc>StutteredPageUp(self)</autodoc>
</method>
<method name="StutteredPageUpExtend" type="" overloaded="no">
- <autodoc>StutteredPageUpExtend()</autodoc>
+ <autodoc>StutteredPageUpExtend(self)</autodoc>
</method>
<method name="StutteredPageDown" type="" overloaded="no">
- <autodoc>StutteredPageDown()</autodoc>
+ <autodoc>StutteredPageDown(self)</autodoc>
</method>
<method name="StutteredPageDownExtend" type="" overloaded="no">
- <autodoc>StutteredPageDownExtend()</autodoc>
+ <autodoc>StutteredPageDownExtend(self)</autodoc>
</method>
<method name="WordLeftEnd" type="" overloaded="no">
- <autodoc>WordLeftEnd()</autodoc>
+ <autodoc>WordLeftEnd(self)</autodoc>
</method>
<method name="WordLeftEndExtend" type="" overloaded="no">
- <autodoc>WordLeftEndExtend()</autodoc>
+ <autodoc>WordLeftEndExtend(self)</autodoc>
</method>
<method name="WordRightEnd" type="" overloaded="no">
- <autodoc>WordRightEnd()</autodoc>
+ <autodoc>WordRightEnd(self)</autodoc>
</method>
<method name="WordRightEndExtend" type="" overloaded="no">
- <autodoc>WordRightEndExtend()</autodoc>
+ <autodoc>WordRightEndExtend(self)</autodoc>
</method>
<method name="SetWhitespaceChars" type="" overloaded="no">
- <autodoc>SetWhitespaceChars(String characters)</autodoc>
+ <autodoc>SetWhitespaceChars(self, String characters)</autodoc>
<paramlist>
<param name="characters" type="String" default=""/>
</paramlist>
</method>
<method name="SetCharsDefault" type="" overloaded="no">
- <autodoc>SetCharsDefault()</autodoc>
+ <autodoc>SetCharsDefault(self)</autodoc>
</method>
<method name="AutoCompGetCurrent" type="int" overloaded="no">
- <autodoc>AutoCompGetCurrent() -> int</autodoc>
+ <autodoc>AutoCompGetCurrent(self) -> int</autodoc>
</method>
<method name="StartRecord" type="" overloaded="no">
- <autodoc>StartRecord()</autodoc>
+ <autodoc>StartRecord(self)</autodoc>
</method>
<method name="StopRecord" type="" overloaded="no">
- <autodoc>StopRecord()</autodoc>
+ <autodoc>StopRecord(self)</autodoc>
</method>
<method name="SetLexer" type="" overloaded="no">
- <autodoc>SetLexer(int lexer)</autodoc>
+ <autodoc>SetLexer(self, int lexer)</autodoc>
<paramlist>
<param name="lexer" type="int" default=""/>
</paramlist>
</method>
<method name="GetLexer" type="int" overloaded="no">
- <autodoc>GetLexer() -> int</autodoc>
+ <autodoc>GetLexer(self) -> int</autodoc>
</method>
<method name="Colourise" type="" overloaded="no">
- <autodoc>Colourise(int start, int end)</autodoc>
+ <autodoc>Colourise(self, int start, int end)</autodoc>
<paramlist>
<param name="start" type="int" default=""/>
<param name="end" type="int" default=""/>
</paramlist>
</method>
<method name="SetProperty" type="" overloaded="no">
- <autodoc>SetProperty(String key, String value)</autodoc>
+ <autodoc>SetProperty(self, String key, String value)</autodoc>
<paramlist>
<param name="key" type="String" default=""/>
<param name="value" type="String" default=""/>
</paramlist>
</method>
<method name="SetKeyWords" type="" overloaded="no">
- <autodoc>SetKeyWords(int keywordSet, String keyWords)</autodoc>
+ <autodoc>SetKeyWords(self, int keywordSet, String keyWords)</autodoc>
<paramlist>
<param name="keywordSet" type="int" default=""/>
<param name="keyWords" type="String" default=""/>
</paramlist>
</method>
<method name="SetLexerLanguage" type="" overloaded="no">
- <autodoc>SetLexerLanguage(String language)</autodoc>
+ <autodoc>SetLexerLanguage(self, String language)</autodoc>
<paramlist>
<param name="language" type="String" default=""/>
</paramlist>
</method>
<method name="GetCurrentLine" type="int" overloaded="no">
- <autodoc>GetCurrentLine() -> int</autodoc>
+ <autodoc>GetCurrentLine(self) -> int</autodoc>
</method>
<method name="StyleSetSpec" type="" overloaded="no">
- <autodoc>StyleSetSpec(int styleNum, String spec)</autodoc>
+ <autodoc>StyleSetSpec(self, int styleNum, String spec)</autodoc>
<paramlist>
<param name="styleNum" type="int" default=""/>
<param name="spec" type="String" default=""/>
</paramlist>
</method>
<method name="StyleSetFont" type="" overloaded="no">
- <autodoc>StyleSetFont(int styleNum, Font font)</autodoc>
+ <autodoc>StyleSetFont(self, int styleNum, Font font)</autodoc>
<paramlist>
<param name="styleNum" type="int" default=""/>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="StyleSetFontAttr" type="" overloaded="no">
- <autodoc>StyleSetFontAttr(int styleNum, int size, String faceName, bool bold,
+ <autodoc>StyleSetFontAttr(self, int styleNum, int size, String faceName, bool bold,
bool italic, bool underline)</autodoc>
<paramlist>
<param name="styleNum" type="int" default=""/>
</paramlist>
</method>
<method name="CmdKeyExecute" type="" overloaded="no">
- <autodoc>CmdKeyExecute(int cmd)</autodoc>
+ <autodoc>CmdKeyExecute(self, int cmd)</autodoc>
<paramlist>
<param name="cmd" type="int" default=""/>
</paramlist>
</method>
<method name="SetMargins" type="" overloaded="no">
- <autodoc>SetMargins(int left, int right)</autodoc>
+ <autodoc>SetMargins(self, int left, int right)</autodoc>
<paramlist>
<param name="left" type="int" default=""/>
<param name="right" type="int" default=""/>
</paramlist>
</method>
<method name="GetSelection" type="" overloaded="no">
- <autodoc>GetSelection(int OUTPUT, int OUTPUT)</autodoc>
+ <autodoc>GetSelection(self, int OUTPUT, int OUTPUT)</autodoc>
<paramlist>
<param name="OUTPUT" type="int" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="PointFromPosition" type="Point" overloaded="no">
- <autodoc>PointFromPosition(int pos) -> Point</autodoc>
+ <autodoc>PointFromPosition(self, int pos) -> Point</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="ScrollToLine" type="" overloaded="no">
- <autodoc>ScrollToLine(int line)</autodoc>
+ <autodoc>ScrollToLine(self, int line)</autodoc>
<paramlist>
<param name="line" type="int" default=""/>
</paramlist>
</method>
<method name="ScrollToColumn" type="" overloaded="no">
- <autodoc>ScrollToColumn(int column)</autodoc>
+ <autodoc>ScrollToColumn(self, int column)</autodoc>
<paramlist>
<param name="column" type="int" default=""/>
</paramlist>
</method>
<method name="SendMsg" type="long" overloaded="no">
- <autodoc>SendMsg(int msg, long wp=0, long lp=0) -> long</autodoc>
+ <autodoc>SendMsg(self, int msg, long wp=0, long lp=0) -> long</autodoc>
<paramlist>
<param name="msg" type="int" default=""/>
<param name="wp" type="long" default="0"/>
</paramlist>
</method>
<method name="SetVScrollBar" type="" overloaded="no">
- <autodoc>SetVScrollBar(wxScrollBar bar)</autodoc>
+ <autodoc>SetVScrollBar(self, wxScrollBar bar)</autodoc>
<paramlist>
<param name="bar" type="ScrollBar" default=""/>
</paramlist>
</method>
<method name="SetHScrollBar" type="" overloaded="no">
- <autodoc>SetHScrollBar(wxScrollBar bar)</autodoc>
+ <autodoc>SetHScrollBar(self, wxScrollBar bar)</autodoc>
<paramlist>
<param name="bar" type="ScrollBar" default=""/>
</paramlist>
</method>
<method name="GetLastKeydownProcessed" type="bool" overloaded="no">
- <autodoc>GetLastKeydownProcessed() -> bool</autodoc>
+ <autodoc>GetLastKeydownProcessed(self) -> bool</autodoc>
</method>
<method name="SetLastKeydownProcessed" type="" overloaded="no">
- <autodoc>SetLastKeydownProcessed(bool val)</autodoc>
+ <autodoc>SetLastKeydownProcessed(self, bool val)</autodoc>
<paramlist>
<param name="val" type="bool" default=""/>
</paramlist>
</method>
<method name="SaveFile" type="bool" overloaded="no">
- <autodoc>SaveFile(String filename) -> bool</autodoc>
+ <autodoc>SaveFile(self, String filename) -> bool</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
</paramlist>
</method>
<method name="LoadFile" type="bool" overloaded="no">
- <autodoc>LoadFile(String filename) -> bool</autodoc>
+ <autodoc>LoadFile(self, String filename) -> bool</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
</paramlist>
</method>
<method name="DoDragOver" type="wxDragResult" overloaded="no">
- <autodoc>DoDragOver(int x, int y, int def) -> int</autodoc>
+ <autodoc>DoDragOver(self, int x, int y, int def) -> int</autodoc>
<paramlist>
<param name="x" type="int" default=""/>
<param name="y" type="int" default=""/>
</paramlist>
</method>
<method name="DoDropText" type="bool" overloaded="no">
- <autodoc>DoDropText(long x, long y, String data) -> bool</autodoc>
+ <autodoc>DoDropText(self, long x, long y, String data) -> bool</autodoc>
<paramlist>
<param name="x" type="long" default=""/>
<param name="y" type="long" default=""/>
</paramlist>
</method>
<method name="SetUseAntiAliasing" type="" overloaded="no">
- <autodoc>SetUseAntiAliasing(bool useAA)</autodoc>
+ <autodoc>SetUseAntiAliasing(self, bool useAA)</autodoc>
<paramlist>
<param name="useAA" type="bool" default=""/>
</paramlist>
</method>
<method name="GetUseAntiAliasing" type="bool" overloaded="no">
- <autodoc>GetUseAntiAliasing() -> bool</autodoc>
+ <autodoc>GetUseAntiAliasing(self) -> bool</autodoc>
</method>
</class>
<class name="StyledTextEvent" oldname="wxStyledTextEvent" module="stc">
<baseclass name="CommandEvent"/>
<constructor name="StyledTextEvent" overloaded="no">
- <autodoc>__init__(wxEventType commandType=0, int id=0) -> StyledTextEvent</autodoc>
+ <autodoc>__init__(self, wxEventType commandType=0, int id=0) -> StyledTextEvent</autodoc>
<paramlist>
<param name="commandType" type="wxEventType" default="0"/>
<param name="id" type="int" default="0"/>
</paramlist>
</constructor>
<destructor name="~wxStyledTextEvent" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="SetPosition" type="" overloaded="no">
- <autodoc>SetPosition(int pos)</autodoc>
+ <autodoc>SetPosition(self, int pos)</autodoc>
<paramlist>
<param name="pos" type="int" default=""/>
</paramlist>
</method>
<method name="SetKey" type="" overloaded="no">
- <autodoc>SetKey(int k)</autodoc>
+ <autodoc>SetKey(self, int k)</autodoc>
<paramlist>
<param name="k" type="int" default=""/>
</paramlist>
</method>
<method name="SetModifiers" type="" overloaded="no">
- <autodoc>SetModifiers(int m)</autodoc>
+ <autodoc>SetModifiers(self, int m)</autodoc>
<paramlist>
<param name="m" type="int" default=""/>
</paramlist>
</method>
<method name="SetModificationType" type="" overloaded="no">
- <autodoc>SetModificationType(int t)</autodoc>
+ <autodoc>SetModificationType(self, int t)</autodoc>
<paramlist>
<param name="t" type="int" default=""/>
</paramlist>
</method>
<method name="SetText" type="" overloaded="no">
- <autodoc>SetText(String t)</autodoc>
+ <autodoc>SetText(self, String t)</autodoc>
<paramlist>
<param name="t" type="String" default=""/>
</paramlist>
</method>
<method name="SetLength" type="" overloaded="no">
- <autodoc>SetLength(int len)</autodoc>
+ <autodoc>SetLength(self, int len)</autodoc>
<paramlist>
<param name="len" type="int" default=""/>
</paramlist>
</method>
<method name="SetLinesAdded" type="" overloaded="no">
- <autodoc>SetLinesAdded(int num)</autodoc>
+ <autodoc>SetLinesAdded(self, int num)</autodoc>
<paramlist>
<param name="num" type="int" default=""/>
</paramlist>
</method>
<method name="SetLine" type="" overloaded="no">
- <autodoc>SetLine(int val)</autodoc>
+ <autodoc>SetLine(self, int val)</autodoc>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="SetFoldLevelNow" type="" overloaded="no">
- <autodoc>SetFoldLevelNow(int val)</autodoc>
+ <autodoc>SetFoldLevelNow(self, int val)</autodoc>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="SetFoldLevelPrev" type="" overloaded="no">
- <autodoc>SetFoldLevelPrev(int val)</autodoc>
+ <autodoc>SetFoldLevelPrev(self, int val)</autodoc>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="SetMargin" type="" overloaded="no">
- <autodoc>SetMargin(int val)</autodoc>
+ <autodoc>SetMargin(self, int val)</autodoc>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="SetMessage" type="" overloaded="no">
- <autodoc>SetMessage(int val)</autodoc>
+ <autodoc>SetMessage(self, int val)</autodoc>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="SetWParam" type="" overloaded="no">
- <autodoc>SetWParam(int val)</autodoc>
+ <autodoc>SetWParam(self, int val)</autodoc>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="SetLParam" type="" overloaded="no">
- <autodoc>SetLParam(int val)</autodoc>
+ <autodoc>SetLParam(self, int val)</autodoc>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="SetListType" type="" overloaded="no">
- <autodoc>SetListType(int val)</autodoc>
+ <autodoc>SetListType(self, int val)</autodoc>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="SetX" type="" overloaded="no">
- <autodoc>SetX(int val)</autodoc>
+ <autodoc>SetX(self, int val)</autodoc>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="SetY" type="" overloaded="no">
- <autodoc>SetY(int val)</autodoc>
+ <autodoc>SetY(self, int val)</autodoc>
<paramlist>
<param name="val" type="int" default=""/>
</paramlist>
</method>
<method name="SetDragText" type="" overloaded="no">
- <autodoc>SetDragText(String val)</autodoc>
+ <autodoc>SetDragText(self, String val)</autodoc>
<paramlist>
<param name="val" type="String" default=""/>
</paramlist>
</method>
<method name="SetDragAllowMove" type="" overloaded="no">
- <autodoc>SetDragAllowMove(bool val)</autodoc>
+ <autodoc>SetDragAllowMove(self, bool val)</autodoc>
<paramlist>
<param name="val" type="bool" default=""/>
</paramlist>
</method>
<method name="SetDragResult" type="" overloaded="no">
- <autodoc>SetDragResult(int val)</autodoc>
+ <autodoc>SetDragResult(self, int val)</autodoc>
<paramlist>
<param name="val" type="wxDragResult" default=""/>
</paramlist>
</method>
<method name="GetPosition" type="int" overloaded="no">
- <autodoc>GetPosition() -> int</autodoc>
+ <autodoc>GetPosition(self) -> int</autodoc>
</method>
<method name="GetKey" type="int" overloaded="no">
- <autodoc>GetKey() -> int</autodoc>
+ <autodoc>GetKey(self) -> int</autodoc>
</method>
<method name="GetModifiers" type="int" overloaded="no">
- <autodoc>GetModifiers() -> int</autodoc>
+ <autodoc>GetModifiers(self) -> int</autodoc>
</method>
<method name="GetModificationType" type="int" overloaded="no">
- <autodoc>GetModificationType() -> int</autodoc>
+ <autodoc>GetModificationType(self) -> int</autodoc>
</method>
<method name="GetText" type="String" overloaded="no">
- <autodoc>GetText() -> String</autodoc>
+ <autodoc>GetText(self) -> String</autodoc>
</method>
<method name="GetLength" type="int" overloaded="no">
- <autodoc>GetLength() -> int</autodoc>
+ <autodoc>GetLength(self) -> int</autodoc>
</method>
<method name="GetLinesAdded" type="int" overloaded="no">
- <autodoc>GetLinesAdded() -> int</autodoc>
+ <autodoc>GetLinesAdded(self) -> int</autodoc>
</method>
<method name="GetLine" type="int" overloaded="no">
- <autodoc>GetLine() -> int</autodoc>
+ <autodoc>GetLine(self) -> int</autodoc>
</method>
<method name="GetFoldLevelNow" type="int" overloaded="no">
- <autodoc>GetFoldLevelNow() -> int</autodoc>
+ <autodoc>GetFoldLevelNow(self) -> int</autodoc>
</method>
<method name="GetFoldLevelPrev" type="int" overloaded="no">
- <autodoc>GetFoldLevelPrev() -> int</autodoc>
+ <autodoc>GetFoldLevelPrev(self) -> int</autodoc>
</method>
<method name="GetMargin" type="int" overloaded="no">
- <autodoc>GetMargin() -> int</autodoc>
+ <autodoc>GetMargin(self) -> int</autodoc>
</method>
<method name="GetMessage" type="int" overloaded="no">
- <autodoc>GetMessage() -> int</autodoc>
+ <autodoc>GetMessage(self) -> int</autodoc>
</method>
<method name="GetWParam" type="int" overloaded="no">
- <autodoc>GetWParam() -> int</autodoc>
+ <autodoc>GetWParam(self) -> int</autodoc>
</method>
<method name="GetLParam" type="int" overloaded="no">
- <autodoc>GetLParam() -> int</autodoc>
+ <autodoc>GetLParam(self) -> int</autodoc>
</method>
<method name="GetListType" type="int" overloaded="no">
- <autodoc>GetListType() -> int</autodoc>
+ <autodoc>GetListType(self) -> int</autodoc>
</method>
<method name="GetX" type="int" overloaded="no">
- <autodoc>GetX() -> int</autodoc>
+ <autodoc>GetX(self) -> int</autodoc>
</method>
<method name="GetY" type="int" overloaded="no">
- <autodoc>GetY() -> int</autodoc>
+ <autodoc>GetY(self) -> int</autodoc>
</method>
<method name="GetDragText" type="String" overloaded="no">
- <autodoc>GetDragText() -> String</autodoc>
+ <autodoc>GetDragText(self) -> String</autodoc>
</method>
<method name="GetDragAllowMove" type="bool" overloaded="no">
- <autodoc>GetDragAllowMove() -> bool</autodoc>
+ <autodoc>GetDragAllowMove(self) -> bool</autodoc>
</method>
<method name="GetDragResult" type="wxDragResult" overloaded="no">
- <autodoc>GetDragResult() -> int</autodoc>
+ <autodoc>GetDragResult(self) -> int</autodoc>
</method>
<method name="GetShift" type="bool" overloaded="no">
- <autodoc>GetShift() -> bool</autodoc>
+ <autodoc>GetShift(self) -> bool</autodoc>
</method>
<method name="GetControl" type="bool" overloaded="no">
- <autodoc>GetControl() -> bool</autodoc>
+ <autodoc>GetControl(self) -> bool</autodoc>
</method>
<method name="GetAlt" type="bool" overloaded="no">
- <autodoc>GetAlt() -> bool</autodoc>
+ <autodoc>GetAlt(self) -> bool</autodoc>
</method>
<method name="Clone" type="Event" overloaded="no">
- <autodoc>Clone() -> Event</autodoc>
+ <autodoc>Clone(self) -> Event</autodoc>
</method>
</class>
<pythoncode>
EVT_STC_MACRORECORD = wx.PyEventBinder( wxEVT_STC_MACRORECORD, 1 )
EVT_STC_MARGINCLICK = wx.PyEventBinder( wxEVT_STC_MARGINCLICK, 1 )
EVT_STC_NEEDSHOWN = wx.PyEventBinder( wxEVT_STC_NEEDSHOWN, 1 )
-EVT_STC_POSCHANGED = wx.PyEventBinder( wxEVT_STC_POSCHANGED, 1 )
EVT_STC_PAINTED = wx.PyEventBinder( wxEVT_STC_PAINTED, 1 )
EVT_STC_USERLISTSELECTION = wx.PyEventBinder( wxEVT_STC_USERLISTSELECTION, 1 )
EVT_STC_URIDROPPED = wx.PyEventBinder( wxEVT_STC_URIDROPPED, 1 )
</pythoncode>
</module>
<module name="xrc">
- <import name="core"/>
- <pythoncode> wx = core </pythoncode>
+ <import name="_core"/>
+ <pythoncode> wx = _core </pythoncode>
+ <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode>
<pythoncode>
#---------------------------------------------------------------------------
</pythoncode>
<class name="XmlResource" oldname="wxXmlResource" module="xrc">
<baseclass name="Object"/>
<constructor name="XmlResource" overloaded="no">
- <autodoc>__init__(String filemask, int flags=XRC_USE_LOCALE) -> XmlResource</autodoc>
+ <autodoc>__init__(self, String filemask, int flags=XRC_USE_LOCALE) -> XmlResource</autodoc>
<paramlist>
<param name="filemask" type="String" default=""/>
<param name="flags" type="int" default="wxXRC_USE_LOCALE"/>
</paramlist>
</constructor>
<destructor name="~wxXmlResource" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Load" type="bool" overloaded="no">
- <autodoc>Load(String filemask) -> bool</autodoc>
+ <autodoc>Load(self, String filemask) -> bool</autodoc>
<paramlist>
<param name="filemask" type="String" default=""/>
</paramlist>
</method>
<method name="LoadFromString" type="bool" overloaded="no">
- <autodoc>LoadFromString(String data) -> bool</autodoc>
+ <autodoc>LoadFromString(self, String data) -> bool</autodoc>
<paramlist>
<param name="data" type="String" default=""/>
</paramlist>
</method>
<method name="InitAllHandlers" type="" overloaded="no">
- <autodoc>InitAllHandlers()</autodoc>
+ <autodoc>InitAllHandlers(self)</autodoc>
</method>
<method name="AddHandler" type="" overloaded="no">
- <autodoc>AddHandler(XmlResourceHandler handler)</autodoc>
+ <autodoc>AddHandler(self, XmlResourceHandler handler)</autodoc>
<paramlist>
<param name="handler" type="wxPyXmlResourceHandler" default=""/>
</paramlist>
</method>
<method name="InsertHandler" type="" overloaded="no">
- <autodoc>InsertHandler(XmlResourceHandler handler)</autodoc>
+ <autodoc>InsertHandler(self, XmlResourceHandler handler)</autodoc>
<paramlist>
<param name="handler" type="wxPyXmlResourceHandler" default=""/>
</paramlist>
</method>
<method name="ClearHandlers" type="" overloaded="no">
- <autodoc>ClearHandlers()</autodoc>
+ <autodoc>ClearHandlers(self)</autodoc>
</method>
<staticmethod name="AddSubclassFactory" type="" overloaded="no">
<autodoc>AddSubclassFactory(XmlSubclassFactory factory)</autodoc>
</paramlist>
</staticmethod>
<method name="LoadMenu" type="Menu" overloaded="no">
- <autodoc>LoadMenu(String name) -> Menu</autodoc>
+ <autodoc>LoadMenu(self, String name) -> Menu</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="LoadMenuBar" type="MenuBar" overloaded="no">
- <autodoc>LoadMenuBar(String name) -> MenuBar</autodoc>
+ <autodoc>LoadMenuBar(self, String name) -> MenuBar</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="LoadMenuBarOnFrame" type="MenuBar" overloaded="no">
- <autodoc>LoadMenuBarOnFrame(Window parent, String name) -> MenuBar</autodoc>
+ <autodoc>LoadMenuBarOnFrame(self, Window parent, String name) -> MenuBar</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="LoadToolBar" type="ToolBar" overloaded="no">
- <autodoc>LoadToolBar(Window parent, String name) -> wxToolBar</autodoc>
+ <autodoc>LoadToolBar(self, Window parent, String name) -> wxToolBar</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="LoadDialog" type="Dialog" overloaded="no">
- <autodoc>LoadDialog(Window parent, String name) -> wxDialog</autodoc>
+ <autodoc>LoadDialog(self, Window parent, String name) -> wxDialog</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="LoadOnDialog" type="bool" overloaded="no">
- <autodoc>LoadOnDialog(wxDialog dlg, Window parent, String name) -> bool</autodoc>
+ <autodoc>LoadOnDialog(self, wxDialog dlg, Window parent, String name) -> bool</autodoc>
<paramlist>
<param name="dlg" type="Dialog" default=""/>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="LoadPanel" type="Panel" overloaded="no">
- <autodoc>LoadPanel(Window parent, String name) -> wxPanel</autodoc>
+ <autodoc>LoadPanel(self, Window parent, String name) -> wxPanel</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="LoadOnPanel" type="bool" overloaded="no">
- <autodoc>LoadOnPanel(wxPanel panel, Window parent, String name) -> bool</autodoc>
+ <autodoc>LoadOnPanel(self, wxPanel panel, Window parent, String name) -> bool</autodoc>
<paramlist>
<param name="panel" type="Panel" default=""/>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="LoadFrame" type="Frame" overloaded="no">
- <autodoc>LoadFrame(Window parent, String name) -> wxFrame</autodoc>
+ <autodoc>LoadFrame(self, Window parent, String name) -> wxFrame</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="LoadOnFrame" type="bool" overloaded="no">
- <autodoc>LoadOnFrame(wxFrame frame, Window parent, String name) -> bool</autodoc>
+ <autodoc>LoadOnFrame(self, wxFrame frame, Window parent, String name) -> bool</autodoc>
<paramlist>
<param name="frame" type="Frame" default=""/>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="LoadObject" type="Object" overloaded="no">
- <autodoc>LoadObject(Window parent, String name, String classname) -> Object</autodoc>
+ <autodoc>LoadObject(self, Window parent, String name, String classname) -> Object</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="LoadOnObject" type="bool" overloaded="no">
- <autodoc>LoadOnObject(Object instance, Window parent, String name, String classname) -> bool</autodoc>
+ <autodoc>LoadOnObject(self, Object instance, Window parent, String name, String classname) -> bool</autodoc>
<paramlist>
<param name="instance" type="Object" default=""/>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="LoadBitmap" type="Bitmap" overloaded="no">
- <autodoc>LoadBitmap(String name) -> Bitmap</autodoc>
+ <autodoc>LoadBitmap(self, String name) -> Bitmap</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="LoadIcon" type="Icon" overloaded="no">
- <autodoc>LoadIcon(String name) -> Icon</autodoc>
+ <autodoc>LoadIcon(self, String name) -> Icon</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="AttachUnknownControl" type="bool" overloaded="no">
- <autodoc>AttachUnknownControl(String name, Window control, Window parent=None) -> bool</autodoc>
+ <autodoc>AttachUnknownControl(self, String name, Window control, Window parent=None) -> bool</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="control" type="Window" default=""/>
</paramlist>
</staticmethod>
<method name="GetVersion" type="long" overloaded="no">
- <autodoc>GetVersion() -> long</autodoc>
+ <autodoc>GetVersion(self) -> long</autodoc>
</method>
<method name="CompareVersion" type="int" overloaded="no">
- <autodoc>CompareVersion(int major, int minor, int release, int revision) -> int</autodoc>
+ <autodoc>CompareVersion(self, int major, int minor, int release, int revision) -> int</autodoc>
<paramlist>
<param name="major" type="int" default=""/>
<param name="minor" type="int" default=""/>
</paramlist>
</staticmethod>
<method name="GetFlags" type="int" overloaded="no">
- <autodoc>GetFlags() -> int</autodoc>
+ <autodoc>GetFlags(self) -> int</autodoc>
</method>
<method name="SetFlags" type="" overloaded="no">
- <autodoc>SetFlags(int flags)</autodoc>
+ <autodoc>SetFlags(self, int flags)</autodoc>
<paramlist>
<param name="flags" type="int" default=""/>
</paramlist>
</pythoncode>
<class name="XmlSubclassFactory" oldname="wxPyXmlSubclassFactory" module="xrc">
<constructor name="wxPyXmlSubclassFactory" overloaded="no">
- <autodoc>__init__() -> XmlSubclassFactory</autodoc>
+ <autodoc>__init__(self) -> XmlSubclassFactory</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</pythoncode>
<class name="XmlProperty" oldname="wxXmlProperty" module="xrc">
<constructor name="XmlProperty" overloaded="no">
- <autodoc>__init__(String name=EmptyString, String value=EmptyString,
+ <autodoc>__init__(self, String name=EmptyString, String value=EmptyString,
XmlProperty next=None) -> XmlProperty</autodoc>
<paramlist>
<param name="name" type="String" default="wxPyEmptyString"/>
</paramlist>
</constructor>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
+ <autodoc>GetName(self) -> String</autodoc>
</method>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
</method>
<method name="GetNext" type="XmlProperty" overloaded="no">
- <autodoc>GetNext() -> XmlProperty</autodoc>
+ <autodoc>GetNext(self) -> XmlProperty</autodoc>
</method>
<method name="SetName" type="" overloaded="no">
- <autodoc>SetName(String name)</autodoc>
+ <autodoc>SetName(self, String name)</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(String value)</autodoc>
+ <autodoc>SetValue(self, String value)</autodoc>
<paramlist>
<param name="value" type="String" default=""/>
</paramlist>
</method>
<method name="SetNext" type="" overloaded="no">
- <autodoc>SetNext(XmlProperty next)</autodoc>
+ <autodoc>SetNext(self, XmlProperty next)</autodoc>
<paramlist>
<param name="next" type="XmlProperty" default=""/>
</paramlist>
</class>
<class name="XmlNode" oldname="wxXmlNode" module="xrc">
<constructor name="XmlNode" overloaded="no">
- <autodoc>__init__(XmlNode parent=None, int type=0, String name=EmptyString,
+ <autodoc>__init__(self, XmlNode parent=None, int type=0, String name=EmptyString,
String content=EmptyString, XmlProperty props=None,
XmlNode next=None) -> XmlNode</autodoc>
<paramlist>
</paramlist>
</constructor>
<destructor name="~wxXmlNode" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="AddChild" type="" overloaded="no">
- <autodoc>AddChild(XmlNode child)</autodoc>
+ <autodoc>AddChild(self, XmlNode child)</autodoc>
<paramlist>
<param name="child" type="XmlNode" default=""/>
</paramlist>
</method>
<method name="InsertChild" type="" overloaded="no">
- <autodoc>InsertChild(XmlNode child, XmlNode before_node)</autodoc>
+ <autodoc>InsertChild(self, XmlNode child, XmlNode before_node)</autodoc>
<paramlist>
<param name="child" type="XmlNode" default=""/>
<param name="before_node" type="XmlNode" default=""/>
</paramlist>
</method>
<method name="RemoveChild" type="bool" overloaded="no">
- <autodoc>RemoveChild(XmlNode child) -> bool</autodoc>
+ <autodoc>RemoveChild(self, XmlNode child) -> bool</autodoc>
<paramlist>
<param name="child" type="XmlNode" default=""/>
</paramlist>
</method>
<method name="AddProperty" type="" overloaded="no">
- <autodoc>AddProperty(XmlProperty prop)</autodoc>
+ <autodoc>AddProperty(self, XmlProperty prop)</autodoc>
<paramlist>
<param name="prop" type="XmlProperty" default=""/>
</paramlist>
</method>
<method name="AddPropertyName" type="" overloaded="no">
- <autodoc>AddPropertyName(String name, String value)</autodoc>
+ <autodoc>AddPropertyName(self, String name, String value)</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="value" type="String" default=""/>
</paramlist>
</method>
<method name="DeleteProperty" type="bool" overloaded="no">
- <autodoc>DeleteProperty(String name) -> bool</autodoc>
+ <autodoc>DeleteProperty(self, String name) -> bool</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="GetType" type="wxXmlNodeType" overloaded="no">
- <autodoc>GetType() -> int</autodoc>
+ <autodoc>GetType(self) -> int</autodoc>
</method>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
+ <autodoc>GetName(self) -> String</autodoc>
</method>
<method name="GetContent" type="String" overloaded="no">
- <autodoc>GetContent() -> String</autodoc>
+ <autodoc>GetContent(self) -> String</autodoc>
</method>
<method name="GetParent" type="XmlNode" overloaded="no">
- <autodoc>GetParent() -> XmlNode</autodoc>
+ <autodoc>GetParent(self) -> XmlNode</autodoc>
</method>
<method name="GetNext" type="XmlNode" overloaded="no">
- <autodoc>GetNext() -> XmlNode</autodoc>
+ <autodoc>GetNext(self) -> XmlNode</autodoc>
</method>
<method name="GetChildren" type="XmlNode" overloaded="no">
- <autodoc>GetChildren() -> XmlNode</autodoc>
+ <autodoc>GetChildren(self) -> XmlNode</autodoc>
</method>
<method name="GetProperties" type="XmlProperty" overloaded="no">
- <autodoc>GetProperties() -> XmlProperty</autodoc>
+ <autodoc>GetProperties(self) -> XmlProperty</autodoc>
</method>
<method name="GetPropVal" type="String" overloaded="no">
- <autodoc>GetPropVal(String propName, String defaultVal) -> String</autodoc>
+ <autodoc>GetPropVal(self, String propName, String defaultVal) -> String</autodoc>
<paramlist>
<param name="propName" type="String" default=""/>
<param name="defaultVal" type="String" default=""/>
</paramlist>
</method>
<method name="HasProp" type="bool" overloaded="no">
- <autodoc>HasProp(String propName) -> bool</autodoc>
+ <autodoc>HasProp(self, String propName) -> bool</autodoc>
<paramlist>
<param name="propName" type="String" default=""/>
</paramlist>
</method>
<method name="SetType" type="" overloaded="no">
- <autodoc>SetType(int type)</autodoc>
+ <autodoc>SetType(self, int type)</autodoc>
<paramlist>
<param name="type" type="wxXmlNodeType" default=""/>
</paramlist>
</method>
<method name="SetName" type="" overloaded="no">
- <autodoc>SetName(String name)</autodoc>
+ <autodoc>SetName(self, String name)</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
</paramlist>
</method>
<method name="SetContent" type="" overloaded="no">
- <autodoc>SetContent(String con)</autodoc>
+ <autodoc>SetContent(self, String con)</autodoc>
<paramlist>
<param name="con" type="String" default=""/>
</paramlist>
</method>
<method name="SetParent" type="" overloaded="no">
- <autodoc>SetParent(XmlNode parent)</autodoc>
+ <autodoc>SetParent(self, XmlNode parent)</autodoc>
<paramlist>
<param name="parent" type="XmlNode" default=""/>
</paramlist>
</method>
<method name="SetNext" type="" overloaded="no">
- <autodoc>SetNext(XmlNode next)</autodoc>
+ <autodoc>SetNext(self, XmlNode next)</autodoc>
<paramlist>
<param name="next" type="XmlNode" default=""/>
</paramlist>
</method>
<method name="SetChildren" type="" overloaded="no">
- <autodoc>SetChildren(XmlNode child)</autodoc>
+ <autodoc>SetChildren(self, XmlNode child)</autodoc>
<paramlist>
<param name="child" type="XmlNode" default=""/>
</paramlist>
</method>
<method name="SetProperties" type="" overloaded="no">
- <autodoc>SetProperties(XmlProperty prop)</autodoc>
+ <autodoc>SetProperties(self, XmlProperty prop)</autodoc>
<paramlist>
<param name="prop" type="XmlProperty" default=""/>
</paramlist>
<class name="XmlDocument" oldname="wxXmlDocument" module="xrc">
<baseclass name="Object"/>
<constructor name="XmlDocument" overloaded="no">
- <autodoc>__init__(String filename, String encoding=UTF8String) -> XmlDocument</autodoc>
+ <autodoc>__init__(self, String filename, String encoding=UTF8String) -> XmlDocument</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
<param name="encoding" type="String" default="wxPyUTF8String"/>
<autodoc>EmptyXmlDocument() -> XmlDocument</autodoc>
</constructor>
<destructor name="~wxXmlDocument" overloaded="no">
- <autodoc>__del__()</autodoc>
+ <autodoc>__del__(self)</autodoc>
</destructor>
<method name="Load" type="bool" overloaded="no">
- <autodoc>Load(String filename, String encoding=UTF8String) -> bool</autodoc>
+ <autodoc>Load(self, String filename, String encoding=UTF8String) -> bool</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
<param name="encoding" type="String" default="wxPyUTF8String"/>
</paramlist>
</method>
<method name="LoadFromStream" type="bool" overloaded="no">
- <autodoc>LoadFromStream(InputStream stream, String encoding=UTF8String) -> bool</autodoc>
+ <autodoc>LoadFromStream(self, InputStream stream, String encoding=UTF8String) -> bool</autodoc>
<paramlist>
<param name="stream" type="wxInputStream" default=""/>
<param name="encoding" type="String" default="wxPyUTF8String"/>
</paramlist>
</method>
<method name="Save" type="bool" overloaded="no">
- <autodoc>Save(String filename) -> bool</autodoc>
+ <autodoc>Save(self, String filename) -> bool</autodoc>
<paramlist>
<param name="filename" type="String" default=""/>
</paramlist>
</method>
<method name="SaveToStream" type="bool" overloaded="no">
- <autodoc>SaveToStream(OutputStream stream) -> bool</autodoc>
+ <autodoc>SaveToStream(self, OutputStream stream) -> bool</autodoc>
<paramlist>
<param name="stream" type="OutputStream" default=""/>
</paramlist>
</method>
<method name="IsOk" type="bool" overloaded="no">
- <autodoc>IsOk() -> bool</autodoc>
+ <autodoc>IsOk(self) -> bool</autodoc>
</method>
<method name="GetRoot" type="XmlNode" overloaded="no">
- <autodoc>GetRoot() -> XmlNode</autodoc>
+ <autodoc>GetRoot(self) -> XmlNode</autodoc>
</method>
<method name="GetVersion" type="String" overloaded="no">
- <autodoc>GetVersion() -> String</autodoc>
+ <autodoc>GetVersion(self) -> String</autodoc>
</method>
<method name="GetFileEncoding" type="String" overloaded="no">
- <autodoc>GetFileEncoding() -> String</autodoc>
+ <autodoc>GetFileEncoding(self) -> String</autodoc>
</method>
<method name="SetRoot" type="" overloaded="no">
- <autodoc>SetRoot(XmlNode node)</autodoc>
+ <autodoc>SetRoot(self, XmlNode node)</autodoc>
<paramlist>
<param name="node" type="XmlNode" default=""/>
</paramlist>
</method>
<method name="SetVersion" type="" overloaded="no">
- <autodoc>SetVersion(String version)</autodoc>
+ <autodoc>SetVersion(self, String version)</autodoc>
<paramlist>
<param name="version" type="String" default=""/>
</paramlist>
</method>
<method name="SetFileEncoding" type="" overloaded="no">
- <autodoc>SetFileEncoding(String encoding)</autodoc>
+ <autodoc>SetFileEncoding(self, String encoding)</autodoc>
<paramlist>
<param name="encoding" type="String" default=""/>
</paramlist>
<class name="XmlResourceHandler" oldname="wxPyXmlResourceHandler" module="xrc">
<baseclass name="Object"/>
<constructor name="wxPyXmlResourceHandler" overloaded="no">
- <autodoc>__init__() -> XmlResourceHandler</autodoc>
+ <autodoc>__init__(self) -> XmlResourceHandler</autodoc>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="CreateResource" type="Object" overloaded="no">
- <autodoc>CreateResource(XmlNode node, Object parent, Object instance) -> Object</autodoc>
+ <autodoc>CreateResource(self, XmlNode node, Object parent, Object instance) -> Object</autodoc>
<paramlist>
<param name="node" type="XmlNode" default=""/>
<param name="parent" type="Object" default=""/>
</paramlist>
</method>
<method name="SetParentResource" type="" overloaded="no">
- <autodoc>SetParentResource(XmlResource res)</autodoc>
+ <autodoc>SetParentResource(self, XmlResource res)</autodoc>
<paramlist>
<param name="res" type="XmlResource" default=""/>
</paramlist>
</method>
<method name="GetResource" type="XmlResource" overloaded="no">
- <autodoc>GetResource() -> XmlResource</autodoc>
+ <autodoc>GetResource(self) -> XmlResource</autodoc>
</method>
<method name="GetNode" type="XmlNode" overloaded="no">
- <autodoc>GetNode() -> XmlNode</autodoc>
+ <autodoc>GetNode(self) -> XmlNode</autodoc>
</method>
<method name="GetClass" type="String" overloaded="no">
- <autodoc>GetClass() -> String</autodoc>
+ <autodoc>GetClass(self) -> String</autodoc>
</method>
<method name="GetParent" type="Object" overloaded="no">
- <autodoc>GetParent() -> Object</autodoc>
+ <autodoc>GetParent(self) -> Object</autodoc>
</method>
<method name="GetInstance" type="Object" overloaded="no">
- <autodoc>GetInstance() -> Object</autodoc>
+ <autodoc>GetInstance(self) -> Object</autodoc>
</method>
<method name="GetParentAsWindow" type="Window" overloaded="no">
- <autodoc>GetParentAsWindow() -> Window</autodoc>
+ <autodoc>GetParentAsWindow(self) -> Window</autodoc>
</method>
<method name="GetInstanceAsWindow" type="Window" overloaded="no">
- <autodoc>GetInstanceAsWindow() -> Window</autodoc>
+ <autodoc>GetInstanceAsWindow(self) -> Window</autodoc>
</method>
<method name="IsOfClass" type="bool" overloaded="no">
- <autodoc>IsOfClass(XmlNode node, String classname) -> bool</autodoc>
+ <autodoc>IsOfClass(self, XmlNode node, String classname) -> bool</autodoc>
<paramlist>
<param name="node" type="XmlNode" default=""/>
<param name="classname" type="String" default=""/>
</paramlist>
</method>
<method name="GetNodeContent" type="String" overloaded="no">
- <autodoc>GetNodeContent(XmlNode node) -> String</autodoc>
+ <autodoc>GetNodeContent(self, XmlNode node) -> String</autodoc>
<paramlist>
<param name="node" type="XmlNode" default=""/>
</paramlist>
</method>
<method name="HasParam" type="bool" overloaded="no">
- <autodoc>HasParam(String param) -> bool</autodoc>
+ <autodoc>HasParam(self, String param) -> bool</autodoc>
<paramlist>
<param name="param" type="String" default=""/>
</paramlist>
</method>
<method name="GetParamNode" type="XmlNode" overloaded="no">
- <autodoc>GetParamNode(String param) -> XmlNode</autodoc>
+ <autodoc>GetParamNode(self, String param) -> XmlNode</autodoc>
<paramlist>
<param name="param" type="String" default=""/>
</paramlist>
</method>
<method name="GetParamValue" type="String" overloaded="no">
- <autodoc>GetParamValue(String param) -> String</autodoc>
+ <autodoc>GetParamValue(self, String param) -> String</autodoc>
<paramlist>
<param name="param" type="String" default=""/>
</paramlist>
</method>
<method name="AddStyle" type="" overloaded="no">
- <autodoc>AddStyle(String name, int value)</autodoc>
+ <autodoc>AddStyle(self, String name, int value)</autodoc>
<paramlist>
<param name="name" type="String" default=""/>
<param name="value" type="int" default=""/>
</paramlist>
</method>
<method name="AddWindowStyles" type="" overloaded="no">
- <autodoc>AddWindowStyles()</autodoc>
+ <autodoc>AddWindowStyles(self)</autodoc>
</method>
<method name="GetStyle" type="int" overloaded="no">
- <autodoc>GetStyle(String param=StyleString, int defaults=0) -> int</autodoc>
+ <autodoc>GetStyle(self, String param=StyleString, int defaults=0) -> int</autodoc>
<paramlist>
<param name="param" type="String" default="wxPyStyleString"/>
<param name="defaults" type="int" default="0"/>
</paramlist>
</method>
<method name="GetText" type="String" overloaded="no">
- <autodoc>GetText(String param, bool translate=True) -> String</autodoc>
+ <autodoc>GetText(self, String param, bool translate=True) -> String</autodoc>
<paramlist>
<param name="param" type="String" default=""/>
<param name="translate" type="bool" default="True"/>
</paramlist>
</method>
<method name="GetID" type="int" overloaded="no">
- <autodoc>GetID() -> int</autodoc>
+ <autodoc>GetID(self) -> int</autodoc>
</method>
<method name="GetName" type="String" overloaded="no">
- <autodoc>GetName() -> String</autodoc>
+ <autodoc>GetName(self) -> String</autodoc>
</method>
<method name="GetBool" type="bool" overloaded="no">
- <autodoc>GetBool(String param, bool defaultv=False) -> bool</autodoc>
+ <autodoc>GetBool(self, String param, bool defaultv=False) -> bool</autodoc>
<paramlist>
<param name="param" type="String" default=""/>
<param name="defaultv" type="bool" default="False"/>
</paramlist>
</method>
<method name="GetLong" type="long" overloaded="no">
- <autodoc>GetLong(String param, long defaultv=0) -> long</autodoc>
+ <autodoc>GetLong(self, String param, long defaultv=0) -> long</autodoc>
<paramlist>
<param name="param" type="String" default=""/>
<param name="defaultv" type="long" default="0"/>
</paramlist>
</method>
<method name="GetColour" type="Colour" overloaded="no">
- <autodoc>GetColour(String param) -> Colour</autodoc>
+ <autodoc>GetColour(self, String param) -> Colour</autodoc>
<paramlist>
<param name="param" type="String" default=""/>
</paramlist>
</method>
<method name="GetSize" type="Size" overloaded="no">
- <autodoc>GetSize(String param=SizeString) -> Size</autodoc>
+ <autodoc>GetSize(self, String param=SizeString) -> Size</autodoc>
<paramlist>
<param name="param" type="String" default="wxPySizeString"/>
</paramlist>
</method>
<method name="GetPosition" type="Point" overloaded="no">
- <autodoc>GetPosition(String param=PosString) -> Point</autodoc>
+ <autodoc>GetPosition(self, String param=PosString) -> Point</autodoc>
<paramlist>
<param name="param" type="String" default="wxPyPosString"/>
</paramlist>
</method>
<method name="GetDimension" type="int" overloaded="no">
- <autodoc>GetDimension(String param, int defaultv=0) -> int</autodoc>
+ <autodoc>GetDimension(self, String param, int defaultv=0) -> int</autodoc>
<paramlist>
<param name="param" type="String" default=""/>
<param name="defaultv" type="int" default="0"/>
</paramlist>
</method>
<method name="GetBitmap" type="Bitmap" overloaded="no">
- <autodoc>GetBitmap(String param=BitmapString, wxArtClient defaultArtClient=wxART_OTHER,
+ <autodoc>GetBitmap(self, String param=BitmapString, wxArtClient defaultArtClient=wxART_OTHER,
Size size=DefaultSize) -> Bitmap</autodoc>
<paramlist>
<param name="param" type="String" default="wxPyBitmapString"/>
</paramlist>
</method>
<method name="GetIcon" type="Icon" overloaded="no">
- <autodoc>GetIcon(String param=IconString, wxArtClient defaultArtClient=wxART_OTHER,
+ <autodoc>GetIcon(self, String param=IconString, wxArtClient defaultArtClient=wxART_OTHER,
Size size=DefaultSize) -> Icon</autodoc>
<paramlist>
<param name="param" type="String" default="wxPyIconString"/>
</paramlist>
</method>
<method name="GetFont" type="Font" overloaded="no">
- <autodoc>GetFont(String param=FontString) -> Font</autodoc>
+ <autodoc>GetFont(self, String param=FontString) -> Font</autodoc>
<paramlist>
<param name="param" type="String" default="wxPyFontString"/>
</paramlist>
</method>
<method name="SetupWindow" type="" overloaded="no">
- <autodoc>SetupWindow(Window wnd)</autodoc>
+ <autodoc>SetupWindow(self, Window wnd)</autodoc>
<paramlist>
<param name="wnd" type="Window" default=""/>
</paramlist>
</method>
<method name="CreateChildren" type="" overloaded="no">
- <autodoc>CreateChildren(Object parent, bool this_hnd_only=False)</autodoc>
+ <autodoc>CreateChildren(self, Object parent, bool this_hnd_only=False)</autodoc>
<paramlist>
<param name="parent" type="Object" default=""/>
<param name="this_hnd_only" type="bool" default="False"/>
</paramlist>
</method>
<method name="CreateChildrenPrivately" type="" overloaded="no">
- <autodoc>CreateChildrenPrivately(Object parent, XmlNode rootnode=None)</autodoc>
+ <autodoc>CreateChildrenPrivately(self, Object parent, XmlNode rootnode=None)</autodoc>
<paramlist>
<param name="parent" type="Object" default=""/>
<param name="rootnode" type="XmlNode" default="NULL"/>
</paramlist>
</method>
<method name="CreateResFromNode" type="Object" overloaded="no">
- <autodoc>CreateResFromNode(XmlNode node, Object parent, Object instance=None) -> Object</autodoc>
+ <autodoc>CreateResFromNode(self, XmlNode node, Object parent, Object instance=None) -> Object</autodoc>
<paramlist>
<param name="node" type="XmlNode" default=""/>
<param name="parent" type="Object" default=""/>
</paramlist>
</method>
<method name="GetCurFileSystem" type="FileSystem" overloaded="no">
- <autodoc>GetCurFileSystem() -> FileSystem</autodoc>
+ <autodoc>GetCurFileSystem(self) -> FileSystem</autodoc>
</method>
</class>
<pythoncode>#----------------------------------------------------------------------------
</pythoncode>
</module>
<module name="gizmos">
- <import name="windows"/>
- <import name="controls"/>
- <pythoncode> wx = core </pythoncode>
+ <import name="_windows"/>
+ <import name="_controls"/>
+ <pythoncode> wx = _core </pythoncode>
+ <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode>
<class name="DynamicSashSplitEvent" oldname="wxDynamicSashSplitEvent" module="gizmos">
<baseclass name="CommandEvent"/>
<constructor name="DynamicSashSplitEvent" overloaded="no">
- <autodoc>__init__(Object target) -> DynamicSashSplitEvent</autodoc>
+ <autodoc>__init__(self, Object target) -> DynamicSashSplitEvent</autodoc>
<paramlist>
<param name="target" type="Object" default=""/>
</paramlist>
<class name="DynamicSashUnifyEvent" oldname="wxDynamicSashUnifyEvent" module="gizmos">
<baseclass name="CommandEvent"/>
<constructor name="DynamicSashUnifyEvent" overloaded="no">
- <autodoc>__init__(Object target) -> DynamicSashUnifyEvent</autodoc>
+ <autodoc>__init__(self, Object target) -> DynamicSashUnifyEvent</autodoc>
<paramlist>
<param name="target" type="Object" default=""/>
</paramlist>
<class name="DynamicSashWindow" oldname="wxDynamicSashWindow" module="gizmos">
<baseclass name="Window"/>
<constructor name="DynamicSashWindow" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER,
String name=DynamicSashNameStr) -> DynamicSashWindow</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER"/>
<autodoc>PreDynamicSashWindow() -> DynamicSashWindow</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER,
String name=DynamicSashNameStr) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
+ <param name="id" type="int" default="-1"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER"/>
</paramlist>
</method>
<method name="GetHScrollBar" type="ScrollBar" overloaded="no">
- <autodoc>GetHScrollBar(Window child) -> ScrollBar</autodoc>
+ <autodoc>GetHScrollBar(self, Window child) -> ScrollBar</autodoc>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
</method>
<method name="GetVScrollBar" type="ScrollBar" overloaded="no">
- <autodoc>GetVScrollBar(Window child) -> ScrollBar</autodoc>
+ <autodoc>GetVScrollBar(self, Window child) -> ScrollBar</autodoc>
<paramlist>
<param name="child" type="Window" default=""/>
</paramlist>
<class name="EditableListBox" oldname="wxEditableListBox" module="gizmos">
<baseclass name="Panel"/>
<constructor name="EditableListBox" overloaded="no">
- <autodoc>__init__(Window parent, int id, String label, Point pos=DefaultPosition,
- Size size=DefaultSize, long style=wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE,
+ <autodoc>__init__(self, Window parent, int id=-1, String label=EmptyString,
+ Point pos=DefaultPosition, Size size=DefaultSize,
+ long style=wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE,
String name=EditableListBoxNameStr) -> EditableListBox</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
- <param name="id" type="int" default=""/>
- <param name="label" type="String" default=""/>
+ <param name="id" type="int" default="-1"/>
+ <param name="label" type="String" default="wxPyEmptyString"/>
<param name="pos" type="Point" default="wxDefaultPosition"/>
<param name="size" type="Size" default="wxDefaultSize"/>
<param name="style" type="long" default="wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE"/>
</paramlist>
</constructor>
<method name="SetStrings" type="" overloaded="no">
- <autodoc>SetStrings(wxArrayString strings)</autodoc>
+ <autodoc>SetStrings(self, wxArrayString strings)</autodoc>
<paramlist>
<param name="strings" type="wxArrayString" default=""/>
</paramlist>
</method>
<method name="GetStrings" type="PyObject" overloaded="no">
- <autodoc>GetStrings() -> PyObject</autodoc>
+ <autodoc>GetStrings(self) -> PyObject</autodoc>
</method>
<method name="GetListCtrl" type="wxListCtrl" overloaded="no">
- <autodoc>GetListCtrl() -> wxListCtrl</autodoc>
+ <autodoc>GetListCtrl(self) -> wxListCtrl</autodoc>
</method>
<method name="GetDelButton" type="BitmapButton" overloaded="no">
- <autodoc>GetDelButton() -> BitmapButton</autodoc>
+ <autodoc>GetDelButton(self) -> BitmapButton</autodoc>
</method>
<method name="GetNewButton" type="BitmapButton" overloaded="no">
- <autodoc>GetNewButton() -> BitmapButton</autodoc>
+ <autodoc>GetNewButton(self) -> BitmapButton</autodoc>
</method>
<method name="GetUpButton" type="BitmapButton" overloaded="no">
- <autodoc>GetUpButton() -> BitmapButton</autodoc>
+ <autodoc>GetUpButton(self) -> BitmapButton</autodoc>
</method>
<method name="GetDownButton" type="BitmapButton" overloaded="no">
- <autodoc>GetDownButton() -> BitmapButton</autodoc>
+ <autodoc>GetDownButton(self) -> BitmapButton</autodoc>
</method>
<method name="GetEditButton" type="BitmapButton" overloaded="no">
- <autodoc>GetEditButton() -> BitmapButton</autodoc>
+ <autodoc>GetEditButton(self) -> BitmapButton</autodoc>
</method>
</class>
<class name="RemotelyScrolledTreeCtrl" oldname="wxRemotelyScrolledTreeCtrl" module="gizmos">
<baseclass name="TreeCtrl"/>
<constructor name="RemotelyScrolledTreeCtrl" overloaded="no">
- <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
+ <autodoc>__init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
long style=TR_HAS_BUTTONS) -> RemotelyScrolledTreeCtrl</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</constructor>
<method name="HideVScrollbar" type="" overloaded="no">
- <autodoc>HideVScrollbar()</autodoc>
+ <autodoc>HideVScrollbar(self)</autodoc>
</method>
<method name="AdjustRemoteScrollbars" type="" overloaded="no">
- <autodoc>AdjustRemoteScrollbars()</autodoc>
+ <autodoc>AdjustRemoteScrollbars(self)</autodoc>
</method>
<method name="GetScrolledWindow" type="ScrolledWindow" overloaded="no">
- <autodoc>GetScrolledWindow() -> ScrolledWindow</autodoc>
+ <autodoc>GetScrolledWindow(self) -> ScrolledWindow</autodoc>
</method>
<method name="ScrollToLine" type="" overloaded="no">
- <autodoc>ScrollToLine(int posHoriz, int posVert)</autodoc>
+ <autodoc>ScrollToLine(self, int posHoriz, int posVert)</autodoc>
<paramlist>
<param name="posHoriz" type="int" default=""/>
<param name="posVert" type="int" default=""/>
</paramlist>
</method>
<method name="SetCompanionWindow" type="" overloaded="no">
- <autodoc>SetCompanionWindow(Window companion)</autodoc>
+ <autodoc>SetCompanionWindow(self, Window companion)</autodoc>
<paramlist>
<param name="companion" type="Window" default=""/>
</paramlist>
</method>
<method name="GetCompanionWindow" type="Window" overloaded="no">
- <autodoc>GetCompanionWindow() -> Window</autodoc>
+ <autodoc>GetCompanionWindow(self) -> Window</autodoc>
</method>
</class>
<class name="TreeCompanionWindow" oldname="wxPyTreeCompanionWindow" module="gizmos">
<baseclass name="Window"/>
<constructor name="wxPyTreeCompanionWindow" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0) -> TreeCompanionWindow</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</constructor>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetTreeCtrl" type="RemotelyScrolledTreeCtrl" overloaded="no">
- <autodoc>GetTreeCtrl() -> RemotelyScrolledTreeCtrl</autodoc>
+ <autodoc>GetTreeCtrl(self) -> RemotelyScrolledTreeCtrl</autodoc>
</method>
<method name="SetTreeCtrl" type="" overloaded="no">
- <autodoc>SetTreeCtrl(RemotelyScrolledTreeCtrl treeCtrl)</autodoc>
+ <autodoc>SetTreeCtrl(self, RemotelyScrolledTreeCtrl treeCtrl)</autodoc>
<paramlist>
<param name="treeCtrl" type="RemotelyScrolledTreeCtrl" default=""/>
</paramlist>
<class name="ThinSplitterWindow" oldname="wxThinSplitterWindow" module="gizmos">
<baseclass name="SplitterWindow"/>
<constructor name="ThinSplitterWindow" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=wxSP_3D|wxCLIP_CHILDREN) -> ThinSplitterWindow</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<class name="SplitterScrolledWindow" oldname="wxSplitterScrolledWindow" module="gizmos">
<baseclass name="ScrolledWindow"/>
<constructor name="SplitterScrolledWindow" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0) -> SplitterScrolledWindow</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<class name="LEDNumberCtrl" oldname="wxLEDNumberCtrl" module="gizmos">
<baseclass name="Control"/>
<constructor name="LEDNumberCtrl" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -> LEDNumberCtrl</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
<autodoc>PreLEDNumberCtrl() -> LEDNumberCtrl</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -> bool</autodoc>
<paramlist>
<param name="parent" type="Window" default=""/>
</paramlist>
</method>
<method name="GetAlignment" type="wxLEDValueAlign" overloaded="no">
- <autodoc>GetAlignment() -> int</autodoc>
+ <autodoc>GetAlignment(self) -> int</autodoc>
</method>
<method name="GetDrawFaded" type="bool" overloaded="no">
- <autodoc>GetDrawFaded() -> bool</autodoc>
+ <autodoc>GetDrawFaded(self) -> bool</autodoc>
</method>
<method name="GetValue" type="String" overloaded="no">
- <autodoc>GetValue() -> String</autodoc>
+ <autodoc>GetValue(self) -> String</autodoc>
</method>
<method name="SetAlignment" type="" overloaded="no">
- <autodoc>SetAlignment(int Alignment, bool Redraw=true)</autodoc>
+ <autodoc>SetAlignment(self, int Alignment, bool Redraw=true)</autodoc>
<paramlist>
<param name="Alignment" type="wxLEDValueAlign" default=""/>
<param name="Redraw" type="bool" default="true"/>
</paramlist>
</method>
<method name="SetDrawFaded" type="" overloaded="no">
- <autodoc>SetDrawFaded(bool DrawFaded, bool Redraw=true)</autodoc>
+ <autodoc>SetDrawFaded(self, bool DrawFaded, bool Redraw=true)</autodoc>
<paramlist>
<param name="DrawFaded" type="bool" default=""/>
<param name="Redraw" type="bool" default="true"/>
</paramlist>
</method>
<method name="SetValue" type="" overloaded="no">
- <autodoc>SetValue(String Value, bool Redraw=true)</autodoc>
+ <autodoc>SetValue(self, String Value, bool Redraw=true)</autodoc>
<paramlist>
<param name="Value" type="String" default=""/>
<param name="Redraw" type="bool" default="true"/>
<class name="TreeListColumnInfo" oldname="wxTreeListColumnInfo" module="gizmos">
<baseclass name="Object"/>
<constructor name="TreeListColumnInfo" overloaded="no">
- <autodoc>__init__(String text=EmptyString, int image=-1, size_t width=100,
- int alignment=TL_ALIGN_LEFT) -> TreeListColumnInfo</autodoc>
+ <autodoc>__init__(self, String text=EmptyString, int image=-1, size_t width=100,
+ bool shown=True, int alignment=TL_ALIGN_LEFT) -> TreeListColumnInfo</autodoc>
<paramlist>
<param name="text" type="String" default="wxPyEmptyString"/>
<param name="image" type="int" default="-1"/>
<param name="width" type="size_t" default="100"/>
+ <param name="shown" type="bool" default="True"/>
<param name="alignment" type="wxTreeListColumnAlign" default="wxTL_ALIGN_LEFT"/>
</paramlist>
</constructor>
+ <method name="GetShown" type="bool" overloaded="no">
+ <autodoc>GetShown(self) -> bool</autodoc>
+ </method>
<method name="GetAlignment" type="wxTreeListColumnAlign" overloaded="no">
- <autodoc>GetAlignment() -> int</autodoc>
+ <autodoc>GetAlignment(self) -> int</autodoc>
</method>
<method name="GetText" type="String" overloaded="no">
- <autodoc>GetText() -> String</autodoc>
+ <autodoc>GetText(self) -> String</autodoc>
</method>
<method name="GetImage" type="int" overloaded="no">
- <autodoc>GetImage() -> int</autodoc>
+ <autodoc>GetImage(self) -> int</autodoc>
</method>
<method name="GetSelectedImage" type="int" overloaded="no">
- <autodoc>GetSelectedImage() -> int</autodoc>
+ <autodoc>GetSelectedImage(self) -> int</autodoc>
</method>
<method name="GetWidth" type="size_t" overloaded="no">
- <autodoc>GetWidth() -> size_t</autodoc>
+ <autodoc>GetWidth(self) -> size_t</autodoc>
+ </method>
+ <method name="SetShown" type="" overloaded="no">
+ <autodoc>SetShown(self, bool shown)</autodoc>
+ <paramlist>
+ <param name="shown" type="bool" default=""/>
+ </paramlist>
</method>
<method name="SetAlignment" type="" overloaded="no">
- <autodoc>SetAlignment(int alignment)</autodoc>
+ <autodoc>SetAlignment(self, int alignment)</autodoc>
<paramlist>
<param name="alignment" type="wxTreeListColumnAlign" default=""/>
</paramlist>
</method>
<method name="SetText" type="" overloaded="no">
- <autodoc>SetText(String text)</autodoc>
+ <autodoc>SetText(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SetImage" type="" overloaded="no">
- <autodoc>SetImage(int image)</autodoc>
+ <autodoc>SetImage(self, int image)</autodoc>
<paramlist>
<param name="image" type="int" default=""/>
</paramlist>
</method>
<method name="SetSelectedImage" type="" overloaded="no">
- <autodoc>SetSelectedImage(int image)</autodoc>
+ <autodoc>SetSelectedImage(self, int image)</autodoc>
<paramlist>
<param name="image" type="int" default=""/>
</paramlist>
</method>
<method name="SetWidth" type="" overloaded="no">
- <autodoc>SetWidth(size_t with)</autodoc>
+ <autodoc>SetWidth(self, size_t with)</autodoc>
<paramlist>
<param name="with" type="size_t" default=""/>
</paramlist>
<class name="TreeListCtrl" oldname="wxPyTreeListCtrl" module="gizmos">
<baseclass name="Control"/>
<constructor name="wxPyTreeListCtrl" overloaded="no">
- <autodoc>__init__(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
Validator validator=DefaultValidator,
String name=TreeListCtrlNameStr) -> TreeListCtrl</autodoc>
<autodoc>PreTreeListCtrl() -> TreeListCtrl</autodoc>
</constructor>
<method name="Create" type="bool" overloaded="no">
- <autodoc>Create(Window parent, int id=-1, Point pos=DefaultPosition,
+ <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
Validator validator=DefaultValidator,
String name=TreeListCtrlNameStr) -> bool</autodoc>
</paramlist>
</method>
<method name="_setCallbackInfo" type="" overloaded="no">
- <autodoc>_setCallbackInfo(PyObject self, PyObject _class)</autodoc>
+ <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc>
<paramlist>
<param name="self" type="PyObject" default=""/>
<param name="_class" type="PyObject" default=""/>
</paramlist>
</method>
<method name="GetCount" type="size_t" overloaded="no">
- <autodoc>GetCount() -> size_t</autodoc>
+ <autodoc>GetCount(self) -> size_t</autodoc>
</method>
<method name="GetIndent" type="unsigned int" overloaded="no">
- <autodoc>GetIndent() -> unsigned int</autodoc>
+ <autodoc>GetIndent(self) -> unsigned int</autodoc>
</method>
<method name="SetIndent" type="" overloaded="no">
- <autodoc>SetIndent(unsigned int indent)</autodoc>
+ <autodoc>SetIndent(self, unsigned int indent)</autodoc>
<paramlist>
<param name="indent" type="unsigned int" default=""/>
</paramlist>
</method>
- <method name="GetSpacing" type="unsigned int" overloaded="no">
- <autodoc>GetSpacing() -> unsigned int</autodoc>
- </method>
- <method name="SetSpacing" type="" overloaded="no">
- <autodoc>SetSpacing(unsigned int spacing)</autodoc>
- <paramlist>
- <param name="spacing" type="unsigned int" default=""/>
- </paramlist>
- </method>
<method name="GetLineSpacing" type="unsigned int" overloaded="no">
- <autodoc>GetLineSpacing() -> unsigned int</autodoc>
+ <autodoc>GetLineSpacing(self) -> unsigned int</autodoc>
</method>
<method name="SetLineSpacing" type="" overloaded="no">
- <autodoc>SetLineSpacing(unsigned int spacing)</autodoc>
+ <autodoc>SetLineSpacing(self, unsigned int spacing)</autodoc>
<paramlist>
<param name="spacing" type="unsigned int" default=""/>
</paramlist>
</method>
<method name="GetImageList" type="ImageList" overloaded="no">
- <autodoc>GetImageList() -> ImageList</autodoc>
+ <autodoc>GetImageList(self) -> ImageList</autodoc>
</method>
<method name="GetStateImageList" type="ImageList" overloaded="no">
- <autodoc>GetStateImageList() -> ImageList</autodoc>
+ <autodoc>GetStateImageList(self) -> ImageList</autodoc>
</method>
<method name="GetButtonsImageList" type="ImageList" overloaded="no">
- <autodoc>GetButtonsImageList() -> ImageList</autodoc>
+ <autodoc>GetButtonsImageList(self) -> ImageList</autodoc>
</method>
<method name="SetImageList" type="" overloaded="no">
- <autodoc>SetImageList(ImageList imageList)</autodoc>
+ <autodoc>SetImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="SetStateImageList" type="" overloaded="no">
- <autodoc>SetStateImageList(ImageList imageList)</autodoc>
+ <autodoc>SetStateImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="SetButtonsImageList" type="" overloaded="no">
- <autodoc>SetButtonsImageList(ImageList imageList)</autodoc>
+ <autodoc>SetButtonsImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="AssignImageList" type="" overloaded="no">
- <autodoc>AssignImageList(ImageList imageList)</autodoc>
+ <autodoc>AssignImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="AssignStateImageList" type="" overloaded="no">
- <autodoc>AssignStateImageList(ImageList imageList)</autodoc>
+ <autodoc>AssignStateImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="AssignButtonsImageList" type="" overloaded="no">
- <autodoc>AssignButtonsImageList(ImageList imageList)</autodoc>
+ <autodoc>AssignButtonsImageList(self, ImageList imageList)</autodoc>
<paramlist>
<param name="imageList" type="ImageList" default=""/>
</paramlist>
</method>
<method name="AddColumn" type="" overloaded="no">
- <autodoc>AddColumn(String text)</autodoc>
+ <autodoc>AddColumn(self, String text)</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="AddColumnInfo" type="" overloaded="no">
- <autodoc>AddColumnInfo(TreeListColumnInfo col)</autodoc>
+ <autodoc>AddColumnInfo(self, TreeListColumnInfo col)</autodoc>
<paramlist>
<param name="col" type="TreeListColumnInfo" default=""/>
</paramlist>
</method>
<method name="InsertColumn" type="" overloaded="no">
- <autodoc>InsertColumn(size_t before, String text)</autodoc>
+ <autodoc>InsertColumn(self, size_t before, String text)</autodoc>
<paramlist>
<param name="before" type="size_t" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="InsertColumnInfo" type="" overloaded="no">
- <autodoc>InsertColumnInfo(size_t before, TreeListColumnInfo col)</autodoc>
+ <autodoc>InsertColumnInfo(self, size_t before, TreeListColumnInfo col)</autodoc>
<paramlist>
<param name="before" type="size_t" default=""/>
<param name="col" type="TreeListColumnInfo" default=""/>
</paramlist>
</method>
<method name="RemoveColumn" type="" overloaded="no">
- <autodoc>RemoveColumn(size_t column)</autodoc>
+ <autodoc>RemoveColumn(self, size_t column)</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
</paramlist>
</method>
<method name="GetColumnCount" type="size_t" overloaded="no">
- <autodoc>GetColumnCount() -> size_t</autodoc>
+ <autodoc>GetColumnCount(self) -> size_t</autodoc>
</method>
<method name="SetColumnWidth" type="" overloaded="no">
- <autodoc>SetColumnWidth(size_t column, size_t width)</autodoc>
+ <autodoc>SetColumnWidth(self, size_t column, size_t width)</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
<param name="width" type="size_t" default=""/>
</paramlist>
</method>
<method name="GetColumnWidth" type="int" overloaded="no">
- <autodoc>GetColumnWidth(size_t column) -> int</autodoc>
+ <autodoc>GetColumnWidth(self, size_t column) -> int</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetMainColumn" type="" overloaded="no">
- <autodoc>SetMainColumn(size_t column)</autodoc>
+ <autodoc>SetMainColumn(self, size_t column)</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
</paramlist>
</method>
<method name="GetMainColumn" type="size_t" overloaded="no">
- <autodoc>GetMainColumn() -> size_t</autodoc>
+ <autodoc>GetMainColumn(self) -> size_t</autodoc>
</method>
<method name="SetColumnText" type="" overloaded="no">
- <autodoc>SetColumnText(size_t column, String text)</autodoc>
+ <autodoc>SetColumnText(self, size_t column, String text)</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="GetColumnText" type="String" overloaded="no">
- <autodoc>GetColumnText(size_t column) -> String</autodoc>
+ <autodoc>GetColumnText(self, size_t column) -> String</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetColumn" type="" overloaded="no">
- <autodoc>SetColumn(size_t column, TreeListColumnInfo info)</autodoc>
+ <autodoc>SetColumn(self, size_t column, TreeListColumnInfo info)</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
<param name="info" type="TreeListColumnInfo" default=""/>
</paramlist>
</method>
<method name="GetColumn" type="TreeListColumnInfo" overloaded="no">
- <autodoc>GetColumn(size_t column) -> TreeListColumnInfo</autodoc>
+ <autodoc>GetColumn(self, size_t column) -> TreeListColumnInfo</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetColumnAlignment" type="" overloaded="no">
- <autodoc>SetColumnAlignment(size_t column, int align)</autodoc>
+ <autodoc>SetColumnAlignment(self, size_t column, int align)</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
<param name="align" type="wxTreeListColumnAlign" default=""/>
</paramlist>
</method>
<method name="GetColumnAlignment" type="wxTreeListColumnAlign" overloaded="no">
- <autodoc>GetColumnAlignment(size_t column) -> int</autodoc>
+ <autodoc>GetColumnAlignment(self, size_t column) -> int</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
</paramlist>
</method>
<method name="SetColumnImage" type="" overloaded="no">
- <autodoc>SetColumnImage(size_t column, int image)</autodoc>
+ <autodoc>SetColumnImage(self, size_t column, int image)</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
<param name="image" type="int" default=""/>
</paramlist>
</method>
<method name="GetColumnImage" type="int" overloaded="no">
- <autodoc>GetColumnImage(size_t column) -> int</autodoc>
+ <autodoc>GetColumnImage(self, size_t column) -> int</autodoc>
+ <paramlist>
+ <param name="column" type="size_t" default=""/>
+ </paramlist>
+ </method>
+ <method name="ShowColumn" type="" overloaded="no">
+ <autodoc>ShowColumn(self, size_t column, bool shown)</autodoc>
+ <paramlist>
+ <param name="column" type="size_t" default=""/>
+ <param name="shown" type="bool" default=""/>
+ </paramlist>
+ </method>
+ <method name="IsColumnShown" type="bool" overloaded="no">
+ <autodoc>IsColumnShown(self, size_t column) -> bool</autodoc>
<paramlist>
<param name="column" type="size_t" default=""/>
</paramlist>
</method>
<method name="GetItemText" type="String" overloaded="no">
- <autodoc>GetItemText(TreeItemId item, int column=-1) -> String</autodoc>
+ <autodoc>GetItemText(self, TreeItemId item, int column=-1) -> String</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="column" type="int" default="-1"/>
</paramlist>
</method>
<method name="GetItemImage" type="int" overloaded="no">
- <autodoc>GetItemImage(TreeItemId item, int column=-1, int which=TreeItemIcon_Normal) -> int</autodoc>
+ <autodoc>GetItemImage(self, TreeItemId item, int column=-1, int which=TreeItemIcon_Normal) -> int</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="column" type="int" default="-1"/>
</paramlist>
</method>
<method name="SetItemText" type="" overloaded="no">
- <autodoc>SetItemText(TreeItemId item, String text, int column=-1)</autodoc>
+ <autodoc>SetItemText(self, TreeItemId item, String text, int column=-1)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="text" type="String" default=""/>
</paramlist>
</method>
<method name="SetItemImage" type="" overloaded="no">
- <autodoc>SetItemImage(TreeItemId item, int image, int column=-1, int which=TreeItemIcon_Normal)</autodoc>
+ <autodoc>SetItemImage(self, TreeItemId item, int image, int column=-1, int which=TreeItemIcon_Normal)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="image" type="int" default=""/>
</paramlist>
</method>
<method name="GetItemData" type="TreeItemData" overloaded="no">
- <autodoc>GetItemData(TreeItemId item) -> TreeItemData</autodoc>
+ <autodoc>GetItemData(self, TreeItemId item) -> TreeItemData</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="SetItemData" type="" overloaded="no">
- <autodoc>SetItemData(TreeItemId item, TreeItemData data)</autodoc>
+ <autodoc>SetItemData(self, TreeItemId item, TreeItemData data)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="data" type="TreeItemData" default=""/>
</paramlist>
</method>
<method name="GetItemPyData" type="PyObject" overloaded="no">
- <autodoc>GetItemPyData(TreeItemId item) -> PyObject</autodoc>
+ <autodoc>GetItemPyData(self, TreeItemId item) -> PyObject</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="SetItemPyData" type="" overloaded="no">
- <autodoc>SetItemPyData(TreeItemId item, PyObject obj)</autodoc>
+ <autodoc>SetItemPyData(self, TreeItemId item, PyObject obj)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="obj" type="PyObject" default=""/>
</paramlist>
</method>
<method name="SetItemHasChildren" type="" overloaded="no">
- <autodoc>SetItemHasChildren(TreeItemId item, bool has=True)</autodoc>
+ <autodoc>SetItemHasChildren(self, TreeItemId item, bool has=True)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="has" type="bool" default="True"/>
</paramlist>
</method>
<method name="SetItemBold" type="" overloaded="no">
- <autodoc>SetItemBold(TreeItemId item, bool bold=True)</autodoc>
+ <autodoc>SetItemBold(self, TreeItemId item, bool bold=True)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="bold" type="bool" default="True"/>
</paramlist>
</method>
<method name="SetItemTextColour" type="" overloaded="no">
- <autodoc>SetItemTextColour(TreeItemId item, Colour col)</autodoc>
+ <autodoc>SetItemTextColour(self, TreeItemId item, Colour colour)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
- <param name="col" type="Colour" default=""/>
+ <param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetItemBackgroundColour" type="" overloaded="no">
- <autodoc>SetItemBackgroundColour(TreeItemId item, Colour col)</autodoc>
+ <autodoc>SetItemBackgroundColour(self, TreeItemId item, Colour colour)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
- <param name="col" type="Colour" default=""/>
+ <param name="colour" type="Colour" default=""/>
</paramlist>
</method>
<method name="SetItemFont" type="" overloaded="no">
- <autodoc>SetItemFont(TreeItemId item, Font font)</autodoc>
+ <autodoc>SetItemFont(self, TreeItemId item, Font font)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="font" type="Font" default=""/>
</paramlist>
</method>
<method name="GetItemBold" type="bool" overloaded="no">
- <autodoc>GetItemBold(TreeItemId item) -> bool</autodoc>
+ <autodoc>GetItemBold(self, TreeItemId item) -> bool</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetItemTextColour" type="Colour" overloaded="no">
- <autodoc>GetItemTextColour(TreeItemId item) -> Colour</autodoc>
+ <autodoc>GetItemTextColour(self, TreeItemId item) -> Colour</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetItemBackgroundColour" type="Colour" overloaded="no">
- <autodoc>GetItemBackgroundColour(TreeItemId item) -> Colour</autodoc>
+ <autodoc>GetItemBackgroundColour(self, TreeItemId item) -> Colour</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetItemFont" type="Font" overloaded="no">
- <autodoc>GetItemFont(TreeItemId item) -> Font</autodoc>
+ <autodoc>GetItemFont(self, TreeItemId item) -> Font</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="IsVisible" type="bool" overloaded="no">
- <autodoc>IsVisible(TreeItemId item) -> bool</autodoc>
+ <autodoc>IsVisible(self, TreeItemId item) -> bool</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="ItemHasChildren" type="bool" overloaded="no">
- <autodoc>ItemHasChildren(TreeItemId item) -> bool</autodoc>
+ <autodoc>ItemHasChildren(self, TreeItemId item) -> bool</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="IsExpanded" type="bool" overloaded="no">
- <autodoc>IsExpanded(TreeItemId item) -> bool</autodoc>
+ <autodoc>IsExpanded(self, TreeItemId item) -> bool</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="IsSelected" type="bool" overloaded="no">
- <autodoc>IsSelected(TreeItemId item) -> bool</autodoc>
+ <autodoc>IsSelected(self, TreeItemId item) -> bool</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="IsBold" type="bool" overloaded="no">
- <autodoc>IsBold(TreeItemId item) -> bool</autodoc>
+ <autodoc>IsBold(self, TreeItemId item) -> bool</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetChildrenCount" type="size_t" overloaded="no">
- <autodoc>GetChildrenCount(TreeItemId item, bool recursively=True) -> size_t</autodoc>
+ <autodoc>GetChildrenCount(self, TreeItemId item, bool recursively=True) -> size_t</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="recursively" type="bool" default="True"/>
</paramlist>
</method>
<method name="GetRootItem" type="TreeItemId" overloaded="no">
- <autodoc>GetRootItem() -> TreeItemId</autodoc>
+ <autodoc>GetRootItem(self) -> TreeItemId</autodoc>
</method>
<method name="GetSelection" type="TreeItemId" overloaded="no">
- <autodoc>GetSelection() -> TreeItemId</autodoc>
+ <autodoc>GetSelection(self) -> TreeItemId</autodoc>
</method>
<method name="GetSelections" type="PyObject" overloaded="no">
- <autodoc>GetSelections() -> PyObject</autodoc>
+ <autodoc>GetSelections(self) -> PyObject</autodoc>
</method>
<method name="GetItemParent" type="TreeItemId" overloaded="no">
- <autodoc>GetItemParent(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetItemParent(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetFirstChild" type="PyObject" overloaded="no">
- <autodoc>GetFirstChild(TreeItemId item) -> PyObject</autodoc>
+ <autodoc>GetFirstChild(self, TreeItemId item) -> PyObject</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetNextChild" type="PyObject" overloaded="no">
- <autodoc>GetNextChild(TreeItemId item, long cookie) -> PyObject</autodoc>
+ <autodoc>GetNextChild(self, TreeItemId item, void cookie) -> PyObject</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
- <param name="cookie" type="long" default=""/>
+ <param name="cookie" type="" default=""/>
</paramlist>
</method>
<method name="GetLastChild" type="TreeItemId" overloaded="no">
- <autodoc>GetLastChild(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetLastChild(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetNextSibling" type="TreeItemId" overloaded="no">
- <autodoc>GetNextSibling(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetNextSibling(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetPrevSibling" type="TreeItemId" overloaded="no">
- <autodoc>GetPrevSibling(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetPrevSibling(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetFirstVisibleItem" type="TreeItemId" overloaded="no">
- <autodoc>GetFirstVisibleItem() -> TreeItemId</autodoc>
+ <autodoc>GetFirstVisibleItem(self) -> TreeItemId</autodoc>
</method>
<method name="GetNextVisible" type="TreeItemId" overloaded="no">
- <autodoc>GetNextVisible(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetNextVisible(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetPrevVisible" type="TreeItemId" overloaded="no">
- <autodoc>GetPrevVisible(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetPrevVisible(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="GetNext" type="TreeItemId" overloaded="no">
- <autodoc>GetNext(TreeItemId item) -> TreeItemId</autodoc>
+ <autodoc>GetNext(self, TreeItemId item) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="AddRoot" type="TreeItemId" overloaded="no">
- <autodoc>AddRoot(String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc>
+ <autodoc>AddRoot(self, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc>
<paramlist>
<param name="text" type="String" default=""/>
<param name="image" type="int" default="-1"/>
</paramlist>
</method>
<method name="PrependItem" type="TreeItemId" overloaded="no">
- <autodoc>PrependItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1,
+ <autodoc>PrependItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1,
TreeItemData data=None) -> TreeItemId</autodoc>
<paramlist>
<param name="parent" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="InsertItem" type="TreeItemId" overloaded="no">
- <autodoc>InsertItem(TreeItemId parent, TreeItemId idPrevious, String text,
+ <autodoc>InsertItem(self, TreeItemId parent, TreeItemId idPrevious, String text,
int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc>
<paramlist>
<param name="parent" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="InsertItemBefore" type="TreeItemId" overloaded="no">
- <autodoc>InsertItemBefore(TreeItemId parent, size_t index, String text, int image=-1,
+ <autodoc>InsertItemBefore(self, TreeItemId parent, size_t index, String text, int image=-1,
int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc>
<paramlist>
<param name="parent" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="AppendItem" type="TreeItemId" overloaded="no">
- <autodoc>AppendItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1,
+ <autodoc>AppendItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1,
TreeItemData data=None) -> TreeItemId</autodoc>
<paramlist>
<param name="parent" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="Delete" type="" overloaded="no">
- <autodoc>Delete(TreeItemId item)</autodoc>
+ <autodoc>Delete(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="DeleteChildren" type="" overloaded="no">
- <autodoc>DeleteChildren(TreeItemId item)</autodoc>
+ <autodoc>DeleteChildren(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="DeleteAllItems" type="" overloaded="no">
- <autodoc>DeleteAllItems()</autodoc>
+ <autodoc>DeleteAllItems(self)</autodoc>
</method>
<method name="Expand" type="" overloaded="no">
- <autodoc>Expand(TreeItemId item)</autodoc>
+ <autodoc>Expand(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="ExpandAll" type="" overloaded="no">
- <autodoc>ExpandAll(TreeItemId item)</autodoc>
+ <autodoc>ExpandAll(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="Collapse" type="" overloaded="no">
- <autodoc>Collapse(TreeItemId item)</autodoc>
+ <autodoc>Collapse(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="CollapseAndReset" type="" overloaded="no">
- <autodoc>CollapseAndReset(TreeItemId item)</autodoc>
+ <autodoc>CollapseAndReset(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="Toggle" type="" overloaded="no">
- <autodoc>Toggle(TreeItemId item)</autodoc>
+ <autodoc>Toggle(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="Unselect" type="" overloaded="no">
- <autodoc>Unselect()</autodoc>
+ <autodoc>Unselect(self)</autodoc>
</method>
<method name="UnselectAll" type="" overloaded="no">
- <autodoc>UnselectAll()</autodoc>
+ <autodoc>UnselectAll(self)</autodoc>
</method>
<method name="SelectItem" type="" overloaded="no">
- <autodoc>SelectItem(TreeItemId item, bool unselect_others=True, bool extended_select=False)</autodoc>
+ <autodoc>SelectItem(self, TreeItemId item, bool unselect_others=True, bool extended_select=False)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="unselect_others" type="bool" default="True"/>
<param name="extended_select" type="bool" default="False"/>
</paramlist>
</method>
+ <method name="SelectAll" type="" overloaded="no">
+ <autodoc>SelectAll(self, bool extended_select=False)</autodoc>
+ <paramlist>
+ <param name="extended_select" type="bool" default="False"/>
+ </paramlist>
+ </method>
<method name="EnsureVisible" type="" overloaded="no">
- <autodoc>EnsureVisible(TreeItemId item)</autodoc>
+ <autodoc>EnsureVisible(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="ScrollTo" type="" overloaded="no">
- <autodoc>ScrollTo(TreeItemId item)</autodoc>
+ <autodoc>ScrollTo(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="HitTest" type="TreeItemId" overloaded="no">
- <autodoc>HitTest(Point point, int OUTPUT, int OUTPUT) -> TreeItemId</autodoc>
+ <autodoc>HitTest(self, Point point, int OUTPUT, int OUTPUT) -> TreeItemId</autodoc>
<paramlist>
<param name="point" type="Point" default=""/>
<param name="OUTPUT" type="int" default=""/>
</paramlist>
</method>
<method name="GetBoundingRect" type="PyObject" overloaded="no">
- <autodoc>GetBoundingRect(TreeItemId item, bool textOnly=False) -> PyObject</autodoc>
+ <autodoc>GetBoundingRect(self, TreeItemId item, bool textOnly=False) -> PyObject</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
<param name="textOnly" type="bool" default="False"/>
</paramlist>
</method>
<method name="EditLabel" type="" overloaded="no">
- <autodoc>EditLabel(TreeItemId item)</autodoc>
+ <autodoc>EditLabel(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="Edit" type="" overloaded="no">
- <autodoc>Edit(TreeItemId item)</autodoc>
+ <autodoc>Edit(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
<method name="SortChildren" type="" overloaded="no">
- <autodoc>SortChildren(TreeItemId item)</autodoc>
- <paramlist>
- <param name="item" type="TreeItemId" default=""/>
- </paramlist>
- </method>
- <method name="GetItemSelectedImage" type="int" overloaded="no">
- <autodoc>GetItemSelectedImage(TreeItemId item) -> int</autodoc>
+ <autodoc>SortChildren(self, TreeItemId item)</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
</paramlist>
</method>
- <method name="SetItemSelectedImage" type="" overloaded="no">
- <autodoc>SetItemSelectedImage(TreeItemId item, int image)</autodoc>
+ <method name="FindItem" type="TreeItemId" overloaded="no">
+ <autodoc>FindItem(self, TreeItemId item, String str, int flags=0) -> TreeItemId</autodoc>
<paramlist>
<param name="item" type="TreeItemId" default=""/>
- <param name="image" type="int" default=""/>
+ <param name="str" type="String" default=""/>
+ <param name="flags" type="int" default="0"/>
</paramlist>
</method>
<method name="GetHeaderWindow" type="Window" overloaded="no">
- <autodoc>GetHeaderWindow() -> Window</autodoc>
+ <autodoc>GetHeaderWindow(self) -> Window</autodoc>
</method>
<method name="GetMainWindow" type="Window" overloaded="no">
- <autodoc>GetMainWindow() -> Window</autodoc>
+ <autodoc>GetMainWindow(self) -> Window</autodoc>
</method>
</class>
</module>
projects / wxWidgets.git / commitdiff
