X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/368d20e8bebb90042834b24dd193c1a3305ee9a3..a8cb1a4947bbbf5e18ce52448f4c3bb4cff4daee:/wxPython/docs/xml/wxPython-metadata.xml diff --git a/wxPython/docs/xml/wxPython-metadata.xml b/wxPython/docs/xml/wxPython-metadata.xml index 82f5edf3df..eb25717942 100644 --- a/wxPython/docs/xml/wxPython-metadata.xml +++ b/wxPython/docs/xml/wxPython-metadata.xml @@ -1,28 +1,49 @@ - + #// 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__] + + + +#---------------------------------------------------------------------------- + +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 + + +#---------------------------------------------------------------------------- #--------------------------------------------------------------------------- - + The base class for most wx objects, although in wxPython not much functionality is needed nor exposed. - GetClassName() -> String - Returns the class name of the C++ object using wxRTTI. + GetClassName(self) -> String + Returns the class name of the C++ class using wxRTTI. - Destroy() + Destroy(self) Deletes the C++ object this Python object is a proxy for. @@ -32,13 +53,13 @@ much functionality is needed nor exposed. #--------------------------------------------------------------------------- - - 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. + + 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. - __init__(int w=0, int h=0) -> Size + __init__(self, int w=0, int h=0) -> Size Creates a size object. @@ -46,40 +67,40 @@ instead. - __del__() + __del__(self) - __eq__(Size sz) -> bool + __eq__(self, Size sz) -> bool Test for equality of wx.Size objects. - __ne__(Size sz) -> bool + __ne__(self, Size sz) -> bool Test for inequality. - __add__(Size sz) -> Size + __add__(self, Size sz) -> Size Add sz's proprties to this and return the result. - __sub__(Size sz) -> Size + __sub__(self, Size sz) -> Size Subtract sz's properties from this and return the result. - IncTo(Size sz) + IncTo(self, Size sz) Increments this object so that both of its dimensions are not less than the corresponding dimensions of the size. @@ -87,7 +108,7 @@ than the corresponding dimensions of the size. - DecTo(Size sz) + DecTo(self, Size sz) Decrements this object so that both of its dimensions are not greater than the corresponding dimensions of the size. @@ -95,7 +116,7 @@ than the corresponding dimensions of the size. - Set(int w, int h) + Set(self, int w, int h) Set both width and height. @@ -103,22 +124,34 @@ than the corresponding dimensions of the size. - SetWidth(int w) + SetWidth(self, int w) - SetHeight(int h) + SetHeight(self, int h) - GetWidth() -> int + GetWidth(self) -> int - GetHeight() -> int + GetHeight(self) -> int + + + IsFullySpecified(self) -> bool + Returns True if both components of the size are non-default values. + + + SetDefaults(self, Size size) + Combine this size with the other one replacing the default components +of this object (i.e. equal to -1) with those of the other. + + + Get() -> (width,height) @@ -128,12 +161,12 @@ than the corresponding dimensions of the size. #--------------------------------------------------------------------------- - - 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. + + 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. - __init__(double x=0.0, double y=0.0) -> RealPoint + __init__(self, double x=0.0, double y=0.0) -> RealPoint Create a wx.RealPoint object @@ -141,40 +174,40 @@ accept a (x,y) tuple. - __del__() + __del__(self) - __eq__(RealPoint pt) -> bool + __eq__(self, RealPoint pt) -> bool Test for equality of wx.RealPoint objects. - __ne__(RealPoint pt) -> bool + __ne__(self, RealPoint pt) -> bool Test for inequality of wx.RealPoint objects. - __add__(RealPoint pt) -> RealPoint + __add__(self, RealPoint pt) -> RealPoint Add pt's proprties to this and return the result. - __sub__(RealPoint pt) -> RealPoint + __sub__(self, RealPoint pt) -> RealPoint Subtract pt's proprties from this and return the result - Set(double x, double y) + Set(self, double x, double y) Set both the x and y properties @@ -189,12 +222,12 @@ accept a (x,y) tuple. #--------------------------------------------------------------------------- - - 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. + + 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. - __init__(int x=0, int y=0) -> Point + __init__(self, int x=0, int y=0) -> Point Create a wx.Point object @@ -202,54 +235,54 @@ properties. Most places in wxPython that expect a wx.Point can also accept a - __del__() + __del__(self) - __eq__(Point pt) -> bool + __eq__(self, Point pt) -> bool Test for equality of wx.Point objects. - __ne__(Point pt) -> bool + __ne__(self, Point pt) -> bool Test for inequality of wx.Point objects. - __add__(Point pt) -> Point + __add__(self, Point pt) -> Point Add pt's proprties to this and return the result. - __sub__(Point pt) -> Point + __sub__(self, Point pt) -> Point Subtract pt's proprties from this and return the result - __iadd__(Point pt) -> Point + __iadd__(self, Point pt) -> Point Add pt to this object. - __isub__(Point pt) -> Point + __isub__(self, Point pt) -> Point Subtract pt from this object. - Set(long x, long y) + Set(self, long x, long y) Set both the x and y properties @@ -264,12 +297,12 @@ properties. Most places in wxPython that expect a wx.Point can also accept a #--------------------------------------------------------------------------- - - 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. + + 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. - __init__(int x=0, int y=0, int width=0, int height=0) -> Rect + __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect Create a new Rect object. @@ -295,189 +328,190 @@ accept a (x,y,width,height) tuple. - __del__() + __del__(self) - GetX() -> int + GetX(self) -> int - SetX(int x) + SetX(self, int x) - GetY() -> int + GetY(self) -> int - SetY(int y) + SetY(self, int y) - GetWidth() -> int + GetWidth(self) -> int - SetWidth(int w) + SetWidth(self, int w) - GetHeight() -> int + GetHeight(self) -> int - SetHeight(int h) + SetHeight(self, int h) - GetPosition() -> Point + GetPosition(self) -> Point - SetPosition(Point p) + SetPosition(self, Point p) - GetSize() -> Size + GetSize(self) -> Size - SetSize(Size s) + SetSize(self, Size s) - GetTopLeft() -> Point + GetTopLeft(self) -> Point - SetTopLeft(Point p) + SetTopLeft(self, Point p) - GetBottomRight() -> Point + GetBottomRight(self) -> Point - SetBottomRight(Point p) + SetBottomRight(self, Point p) - GetLeft() -> int + GetLeft(self) -> int - GetTop() -> int + GetTop(self) -> int - GetBottom() -> int + GetBottom(self) -> int - GetRight() -> int + GetRight(self) -> int - SetLeft(int left) + SetLeft(self, int left) - SetRight(int right) + SetRight(self, int right) - SetTop(int top) + SetTop(self, int top) - SetBottom(int bottom) + SetBottom(self, int bottom) - Inflate(int dx, int dy) -> Rect - Increase the rectangle size by dx in x direction and dy in y direction. Both -(or one of) parameters may be negative to decrease the rectangle size. + Inflate(self, int dx, int dy) -> Rect + Increase the rectangle size by dx in x direction and dy in y +direction. Both or one of) parameters may be negative to decrease the +rectangle size. - Deflate(int dx, int dy) -> Rect - Decrease the rectangle size by dx in x direction and dy in y direction. Both -(or one of) parameters may be negative to increase the rectngle size. This -method is the opposite of Inflate. + Deflate(self, int dx, int dy) -> Rect + Decrease the rectangle size by dx in x direction and dy in y +direction. Both or one of) parameters may be negative to increase the +rectngle size. This method is the opposite of Inflate. - OffsetXY(int dx, int dy) - 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. + OffsetXY(self, int dx, int dy) + 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. - Offset(Point pt) + Offset(self, Point pt) Same as OffsetXY but uses dx,dy from Point - Intersect(Rect rect) -> Rect + Intersect(self, Rect rect) -> Rect Return the intersectsion of this rectangle and rect. - __add__(Rect rect) -> Rect + __add__(self, Rect rect) -> Rect Add the properties of rect to this rectangle and return the result. - __iadd__(Rect rect) -> Rect + __iadd__(self, Rect rect) -> Rect Add the properties of rect to this rectangle, updating this rectangle. - __eq__(Rect rect) -> bool + __eq__(self, Rect rect) -> bool Test for equality. - __ne__(Rect rect) -> bool + __ne__(self, Rect rect) -> bool Test for inequality. - InsideXY(int x, int y) -> bool + InsideXY(self, int x, int y) -> bool Return True if the point is (not strcitly) inside the rect. @@ -485,14 +519,14 @@ it is moved to the left or top respectively. - Inside(Point pt) -> bool + Inside(self, Point pt) -> bool Return True if the point is (not strcitly) inside the rect. - Intersects(Rect rect) -> bool + Intersects(self, Rect rect) -> bool Returns True if the rectangles have a non empty intersection. @@ -503,7 +537,7 @@ it is moved to the left or top respectively. - Set(int x=0, int y=0, int width=0, int height=0) + Set(self, int x=0, int y=0, int width=0, int height=0) Set all rectangle properties. @@ -528,10 +562,11 @@ it is moved to the left or top respectively. #--------------------------------------------------------------------------- - - wx.Point2Ds represent a point or a vector in a 2d coordinate system with floating point values. + + wx.Point2Ds represent a point or a vector in a 2d coordinate system +with floating point values. - __init__(double x=0.0, double y=0.0) -> Point2D + __init__(self, double x=0.0, double y=0.0) -> Point2D Create a w.Point2D object. @@ -569,84 +604,84 @@ it is moved to the left or top respectively. - GetVectorLength() -> double + GetVectorLength(self) -> double - GetVectorAngle() -> double + GetVectorAngle(self) -> double - SetVectorLength(double length) + SetVectorLength(self, double length) - SetVectorAngle(double degrees) + SetVectorAngle(self, double degrees) - GetDistance(Point2D pt) -> double + GetDistance(self, Point2D pt) -> double - GetDistanceSquare(Point2D pt) -> double + GetDistanceSquare(self, Point2D pt) -> double - GetDotProduct(Point2D vec) -> double + GetDotProduct(self, Point2D vec) -> double - GetCrossProduct(Point2D vec) -> double + GetCrossProduct(self, Point2D vec) -> double - __neg__() -> Point2D + __neg__(self) -> Point2D the reflection of this point - __iadd__(Point2D pt) -> Point2D + __iadd__(self, Point2D pt) -> Point2D - __isub__(Point2D pt) -> Point2D + __isub__(self, Point2D pt) -> Point2D - __imul__(Point2D pt) -> Point2D + __imul__(self, Point2D pt) -> Point2D - __idiv__(Point2D pt) -> Point2D + __idiv__(self, Point2D pt) -> Point2D - __eq__(Point2D pt) -> bool + __eq__(self, Point2D pt) -> bool Test for equality - __ne__(Point2D pt) -> bool + __ne__(self, Point2D pt) -> bool Test for inequality @@ -655,7 +690,7 @@ it is moved to the left or top respectively. - Set(double x=0, double y=0) + Set(self, double x=0, double y=0) @@ -669,85 +704,85 @@ it is moved to the left or top respectively. #--------------------------------------------------------------------------- - + - __init__(PyObject p) -> InputStream + __init__(self, PyObject p) -> InputStream - close() + close(self) - flush() + flush(self) - eof() -> bool + eof(self) -> bool - read(int size=-1) -> PyObject + read(self, int size=-1) -> PyObject - readline(int size=-1) -> PyObject + readline(self, int size=-1) -> PyObject - readlines(int sizehint=-1) -> PyObject + readlines(self, int sizehint=-1) -> PyObject - seek(int offset, int whence=0) + seek(self, int offset, int whence=0) - tell() -> int + tell(self) -> int - Peek() -> char + Peek(self) -> char - GetC() -> char + GetC(self) -> char - LastRead() -> size_t + LastRead(self) -> size_t - CanRead() -> bool + CanRead(self) -> bool - Eof() -> bool + Eof(self) -> bool - Ungetch(char c) -> bool + Ungetch(self, char c) -> bool - SeekI(long pos, int mode=FromStart) -> long + SeekI(self, long pos, int mode=FromStart) -> long - TellI() -> long + TellI(self) -> long - + - write(PyObject obj) + write(self, PyObject obj) @@ -756,10 +791,10 @@ it is moved to the left or top respectively. #--------------------------------------------------------------------------- - + - __init__(InputStream stream, String loc, String mimetype, String anchor, + __init__(self, InputStream stream, String loc, String mimetype, String anchor, DateTime modif) -> FSFile @@ -770,124 +805,124 @@ it is moved to the left or top respectively. - __del__() + __del__(self) - GetStream() -> InputStream + GetStream(self) -> InputStream - GetMimeType() -> String + GetMimeType(self) -> String - GetLocation() -> String + GetLocation(self) -> String - GetAnchor() -> String + GetAnchor(self) -> String - GetModificationTime() -> DateTime + GetModificationTime(self) -> DateTime - - + + - __init__() -> FileSystemHandler + __init__(self) -> FileSystemHandler - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - CanOpen(String location) -> bool + CanOpen(self, String location) -> bool - OpenFile(FileSystem fs, String location) -> FSFile + OpenFile(self, FileSystem fs, String location) -> FSFile - FindFirst(String spec, int flags=0) -> String + FindFirst(self, String spec, int flags=0) -> String - FindNext() -> String + FindNext(self) -> String - GetProtocol(String location) -> String + GetProtocol(self, String location) -> String - GetLeftLocation(String location) -> String + GetLeftLocation(self, String location) -> String - GetAnchor(String location) -> String + GetAnchor(self, String location) -> String - GetRightLocation(String location) -> String + GetRightLocation(self, String location) -> String - GetMimeTypeFromExt(String location) -> String + GetMimeTypeFromExt(self, String location) -> String - + - __init__() -> FileSystem + __init__(self) -> FileSystem - __del__() + __del__(self) - ChangePathTo(String location, bool is_dir=False) + ChangePathTo(self, String location, bool is_dir=False) - GetPath() -> String + GetPath(self) -> String - OpenFile(String location) -> FSFile + OpenFile(self, String location) -> FSFile - FindFirst(String spec, int flags=0) -> String + FindFirst(self, String spec, int flags=0) -> String - FindNext() -> String + FindNext(self) -> String AddHandler(CPPFileSystemHandler handler) @@ -911,52 +946,52 @@ it is moved to the left or top respectively. - + - __init__() -> InternetFSHandler + __init__(self) -> InternetFSHandler - CanOpen(String location) -> bool + CanOpen(self, String location) -> bool - OpenFile(FileSystem fs, String location) -> FSFile + OpenFile(self, FileSystem fs, String location) -> FSFile - + - __init__() -> ZipFSHandler + __init__(self) -> ZipFSHandler - CanOpen(String location) -> bool + CanOpen(self, String location) -> bool - OpenFile(FileSystem fs, String location) -> FSFile + OpenFile(self, FileSystem fs, String location) -> FSFile - FindFirst(String spec, int flags=0) -> String + FindFirst(self, String spec, int flags=0) -> String - FindNext() -> String + FindNext(self) -> String @@ -992,10 +1027,10 @@ def MemoryFSHandler_AddFile(filename, a, b=''): __wxMemoryFSHandler_AddFile_Data(filename, a) else: raise TypeError, 'wx.Image, wx.Bitmap or string expected' - + - __init__() -> MemoryFSHandler + __init__(self) -> MemoryFSHandler RemoveFile(String filename) @@ -1004,80 +1039,80 @@ def MemoryFSHandler_AddFile(filename, a, b=''): - CanOpen(String location) -> bool + CanOpen(self, String location) -> bool - OpenFile(FileSystem fs, String location) -> FSFile + OpenFile(self, FileSystem fs, String location) -> FSFile - FindFirst(String spec, int flags=0) -> String + FindFirst(self, String spec, int flags=0) -> String - FindNext() -> String + FindNext(self) -> String #--------------------------------------------------------------------------- - + - GetName() -> String + GetName(self) -> String - GetExtension() -> String + GetExtension(self) -> String - GetType() -> long + GetType(self) -> long - GetMimeType() -> String + GetMimeType(self) -> String - CanRead(String name) -> bool + CanRead(self, String name) -> bool - SetName(String name) + SetName(self, String name) - SetExtension(String extension) + SetExtension(self, String extension) - SetType(long type) + SetType(self, long type) - SetMimeType(String mimetype) + SetMimeType(self, String mimetype) - + - __init__() -> ImageHistogram + __init__(self) -> ImageHistogram MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long @@ -1090,9 +1125,9 @@ def MemoryFSHandler_AddFile(filename, a, b=''): FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b) - Find first colour that is not used in the image and has higher RGB values than -startR, startG, startB. Returns a tuple consisting of a success flag and rgb -values. + 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. @@ -1103,10 +1138,10 @@ values. - + - __init__(String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image + __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image @@ -1160,42 +1195,42 @@ values. - __del__() + __del__(self) - Create(int width, int height) + Create(self, int width, int height) - Destroy() + Destroy(self) Deletes the C++ object this Python object is a proxy for. - Scale(int width, int height) -> Image + Scale(self, int width, int height) -> Image - ShrinkBy(int xFactor, int yFactor) -> Image + ShrinkBy(self, int xFactor, int yFactor) -> Image - Rescale(int width, int height) -> Image + Rescale(self, int width, int height) -> Image - SetRGB(int x, int y, unsigned char r, unsigned char g, unsigned char b) + SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b) @@ -1205,28 +1240,28 @@ values. - GetRed(int x, int y) -> unsigned char + GetRed(self, int x, int y) -> unsigned char - GetGreen(int x, int y) -> unsigned char + GetGreen(self, int x, int y) -> unsigned char - GetBlue(int x, int y) -> unsigned char + GetBlue(self, int x, int y) -> unsigned char - SetAlpha(int x, int y, unsigned char alpha) + SetAlpha(self, int x, int y, unsigned char alpha) @@ -1234,20 +1269,20 @@ values. - GetAlpha(int x, int y) -> unsigned char + GetAlpha(self, int x, int y) -> unsigned char - HasAlpha() -> bool + HasAlpha(self) -> bool FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b) - Find first colour that is not used in the image and has higher RGB values than -startR, startG, startB. Returns a tuple consisting of a success flag and rgb -values. + 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. @@ -1257,8 +1292,21 @@ values. + + ConvertAlphaToMask(self, byte threshold=128) -> bool + If the image has alpha channel, this method converts it to mask. All pixels +with alpha value less than ``threshold`` are replaced with mask colour and the +alpha channel is removed. Mask colour is chosen automatically using +`FindFirstUnusedColour`. + +If the image image doesn't have alpha channel, ConvertAlphaToMask does +nothing. + + + + - SetMaskFromImage(Image mask, byte mr, byte mg, byte mb) -> bool + SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool @@ -1280,7 +1328,7 @@ values. - LoadFile(String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool + LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool @@ -1288,7 +1336,7 @@ values. - LoadMimeFile(String name, String mimetype, int index=-1) -> bool + LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool @@ -1296,14 +1344,14 @@ values. - SaveFile(String name, int type) -> bool + SaveFile(self, String name, int type) -> bool - SaveMimeFile(String name, String mimetype) -> bool + SaveMimeFile(self, String name, String mimetype) -> bool @@ -1316,7 +1364,7 @@ values. - LoadStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool + LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool @@ -1324,7 +1372,7 @@ values. - LoadMimeStream(InputStream stream, String mimetype, int index=-1) -> bool + LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool @@ -1332,25 +1380,28 @@ values. - Ok() -> bool + Ok(self) -> bool - GetWidth() -> int + GetWidth(self) -> int - GetHeight() -> int + GetHeight(self) -> int + + + GetSize(self) -> Size - GetSubImage(Rect rect) -> Image + GetSubImage(self, Rect rect) -> Image - Copy() -> Image + Copy(self) -> Image - Paste(Image image, int x, int y) + Paste(self, Image image, int x, int y) @@ -1358,43 +1409,43 @@ values. - GetData() -> PyObject + GetData(self) -> PyObject - SetData(PyObject data) + SetData(self, PyObject data) - GetDataBuffer() -> PyObject + GetDataBuffer(self) -> PyObject - SetDataBuffer(PyObject data) + SetDataBuffer(self, PyObject data) - GetAlphaData() -> PyObject + GetAlphaData(self) -> PyObject - SetAlphaData(PyObject data) + SetAlphaData(self, PyObject data) - GetAlphaBuffer() -> PyObject + GetAlphaBuffer(self) -> PyObject - SetAlphaBuffer(PyObject data) + SetAlphaBuffer(self, PyObject data) - SetMaskColour(unsigned char r, unsigned char g, unsigned char b) + SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b) @@ -1402,25 +1453,25 @@ values. - GetMaskRed() -> unsigned char + GetMaskRed(self) -> unsigned char - GetMaskGreen() -> unsigned char + GetMaskGreen(self) -> unsigned char - GetMaskBlue() -> unsigned char + GetMaskBlue(self) -> unsigned char - SetMask(bool mask=True) + SetMask(self, bool mask=True) - HasMask() -> bool + HasMask(self) -> bool - Rotate(double angle, Point centre_of_rotation, bool interpolating=True, + Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True, Point offset_after_rotation=None) -> Image @@ -1430,19 +1481,19 @@ values. - Rotate90(bool clockwise=True) -> Image + Rotate90(self, bool clockwise=True) -> Image - Mirror(bool horizontally=True) -> Image + Mirror(self, bool horizontally=True) -> Image - Replace(unsigned char r1, unsigned char g1, unsigned char b1, + Replace(self, unsigned char r1, unsigned char g1, unsigned char b1, unsigned char r2, unsigned char g2, unsigned char b2) @@ -1454,7 +1505,7 @@ values. - ConvertToMono(unsigned char r, unsigned char g, unsigned char b) -> Image + ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image @@ -1462,45 +1513,45 @@ values. - SetOption(String name, String value) + SetOption(self, String name, String value) - SetOptionInt(String name, int value) + SetOptionInt(self, String name, int value) - GetOption(String name) -> String + GetOption(self, String name) -> String - GetOptionInt(String name) -> int + GetOptionInt(self, String name) -> int - HasOption(String name) -> bool + HasOption(self, String name) -> bool - CountColours(unsigned long stopafter=(unsigned long) -1) -> unsigned long + CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long - ComputeHistogram(ImageHistogram h) -> unsigned long + ComputeHistogram(self, ImageHistogram h) -> unsigned long @@ -1527,10 +1578,10 @@ values. GetImageExtWildcard() -> String - ConvertToBitmap() -> Bitmap + ConvertToBitmap(self) -> Bitmap - ConvertToMonoBitmap(unsigned char red, unsigned char green, unsigned char blue) -> Bitmap + ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap @@ -1538,127 +1589,148 @@ values. - - InitAllImageHandlers() - - + + 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 + + - __init__() -> BMPHandler + __init__(self) -> BMPHandler - + - __init__() -> ICOHandler + __init__(self) -> ICOHandler - + - __init__() -> CURHandler + __init__(self) -> CURHandler - + - __init__() -> ANIHandler + __init__(self) -> ANIHandler - + - __init__() -> PNGHandler + __init__(self) -> PNGHandler - + - __init__() -> GIFHandler + __init__(self) -> GIFHandler - + - __init__() -> PCXHandler + __init__(self) -> PCXHandler - + - __init__() -> JPEGHandler + __init__(self) -> JPEGHandler - + - __init__() -> PNMHandler + __init__(self) -> PNMHandler - + - __init__() -> XPMHandler + __init__(self) -> XPMHandler - + - __init__() -> TIFFHandler + __init__(self) -> TIFFHandler + + Performs quantization, or colour reduction, on a wxImage. + + Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool + Reduce the colours in the source image and put the result into the +destination image, setting the palette in the destination if +needed. Both images may be the same, to overwrite the source image. +:todo: Create a version that returns the wx.Palette used. + + + + + + + + #--------------------------------------------------------------------------- - + - __init__() -> EvtHandler + __init__(self) -> EvtHandler - GetNextHandler() -> EvtHandler + GetNextHandler(self) -> EvtHandler - GetPreviousHandler() -> EvtHandler + GetPreviousHandler(self) -> EvtHandler - SetNextHandler(EvtHandler handler) + SetNextHandler(self, EvtHandler handler) - SetPreviousHandler(EvtHandler handler) + SetPreviousHandler(self, EvtHandler handler) - GetEvtHandlerEnabled() -> bool + GetEvtHandlerEnabled(self) -> bool - SetEvtHandlerEnabled(bool enabled) + SetEvtHandlerEnabled(self, bool enabled) - ProcessEvent(Event event) -> bool + ProcessEvent(self, Event event) -> bool - AddPendingEvent(Event event) + AddPendingEvent(self, Event event) - ProcessPendingEvents() + ProcessPendingEvents(self) - Connect(int id, int lastId, int eventType, PyObject func) + Connect(self, int id, int lastId, int eventType, PyObject func) @@ -1667,7 +1739,7 @@ values. - Disconnect(int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool + Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool @@ -1675,7 +1747,7 @@ values. - _setOORInfo(PyObject _self) + _setOORInfo(self, PyObject _self) @@ -1706,6 +1778,14 @@ class PyEventBinder(object): 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): """ @@ -1928,181 +2008,181 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __del__() + __del__(self) - SetEventType(wxEventType typ) + SetEventType(self, wxEventType typ) - GetEventType() -> wxEventType + GetEventType(self) -> wxEventType - GetEventObject() -> Object + GetEventObject(self) -> Object - SetEventObject(Object obj) + SetEventObject(self, Object obj) - GetTimestamp() -> long + GetTimestamp(self) -> long - SetTimestamp(long ts=0) + SetTimestamp(self, long ts=0) - GetId() -> int + GetId(self) -> int - SetId(int Id) + SetId(self, int Id) - IsCommandEvent() -> bool + IsCommandEvent(self) -> bool - Skip(bool skip=True) + Skip(self, bool skip=True) - GetSkipped() -> bool + GetSkipped(self) -> bool - ShouldPropagate() -> bool + ShouldPropagate(self) -> bool - StopPropagation() -> int + StopPropagation(self) -> int - ResumePropagation(int propagationLevel) + ResumePropagation(self, int propagationLevel) - Clone() -> Event + Clone(self) -> Event #--------------------------------------------------------------------------- - + - __init__(Event event) -> PropagationDisabler + __init__(self, Event event) -> PropagationDisabler - __del__() + __del__(self) - + - __init__(Event event) -> PropagateOnce + __init__(self, Event event) -> PropagateOnce - __del__() + __del__(self) #--------------------------------------------------------------------------- - + - __init__(wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent + __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent - GetSelection() -> int + GetSelection(self) -> int - SetString(String s) + SetString(self, String s) - GetString() -> String + GetString(self) -> String - IsChecked() -> bool + IsChecked(self) -> bool - IsSelection() -> bool + IsSelection(self) -> bool - SetExtraLong(long extraLong) + SetExtraLong(self, long extraLong) - GetExtraLong() -> long + GetExtraLong(self) -> long - SetInt(int i) + SetInt(self, int i) - GetInt() -> long + GetInt(self) -> long - Clone() -> Event + Clone(self) -> Event #--------------------------------------------------------------------------- - + - __init__(wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent + __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent - Veto() + Veto(self) - Allow() + Allow(self) - IsAllowed() -> bool + IsAllowed(self) -> bool #--------------------------------------------------------------------------- - + - __init__(wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0, + __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0, int orient=0) -> ScrollEvent @@ -2112,19 +2192,19 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) - GetOrientation() -> int + GetOrientation(self) -> int - GetPosition() -> int + GetPosition(self) -> int - SetOrientation(int orient) + SetOrientation(self, int orient) - SetPosition(int pos) + SetPosition(self, int pos) @@ -2133,10 +2213,10 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__(wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent + __init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent @@ -2144,19 +2224,19 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) - GetOrientation() -> int + GetOrientation(self) -> int - GetPosition() -> int + GetPosition(self) -> int - SetOrientation(int orient) + SetOrientation(self, int orient) - SetPosition(int pos) + SetPosition(self, int pos) @@ -2165,145 +2245,157 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__(wxEventType mouseType=wxEVT_NULL) -> MouseEvent + __init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent - IsButton() -> bool + IsButton(self) -> bool - ButtonDown(int but=MOUSE_BTN_ANY) -> bool + ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool - ButtonDClick(int but=MOUSE_BTN_ANY) -> bool + ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool - ButtonUp(int but=MOUSE_BTN_ANY) -> bool + ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool - Button(int but) -> bool + Button(self, int but) -> bool - ButtonIsDown(int but) -> bool + ButtonIsDown(self, int but) -> bool - GetButton() -> int + GetButton(self) -> int - ControlDown() -> bool + ControlDown(self) -> bool - MetaDown() -> bool + MetaDown(self) -> bool - AltDown() -> bool + AltDown(self) -> bool - ShiftDown() -> bool + ShiftDown(self) -> bool + + + CmdDown(self) -> bool + "Cmd" is a pseudo key which is the same as Control for PC and Unix +platforms but the special "Apple" (a.k.a as "Command") key on +Macs: it makes often sense to use it instead of, say, `ControlDown` +because Cmd key is used for the same thing under Mac as Ctrl +elsewhere. The Ctrl still exists, it's just not used for this +purpose. So for non-Mac platforms this is the same as `ControlDown` +and Macs this is the same as `MetaDown`. - LeftDown() -> bool + LeftDown(self) -> bool - MiddleDown() -> bool + MiddleDown(self) -> bool - RightDown() -> bool + RightDown(self) -> bool - LeftUp() -> bool + LeftUp(self) -> bool - MiddleUp() -> bool + MiddleUp(self) -> bool - RightUp() -> bool + RightUp(self) -> bool - LeftDClick() -> bool + LeftDClick(self) -> bool - MiddleDClick() -> bool + MiddleDClick(self) -> bool - RightDClick() -> bool + RightDClick(self) -> bool - LeftIsDown() -> bool + LeftIsDown(self) -> bool - MiddleIsDown() -> bool + MiddleIsDown(self) -> bool - RightIsDown() -> bool + RightIsDown(self) -> bool - Dragging() -> bool + Dragging(self) -> bool - Moving() -> bool + Moving(self) -> bool - Entering() -> bool + Entering(self) -> bool - Leaving() -> bool + Leaving(self) -> bool - GetPosition() -> Point - Returns the position of the mouse in window coordinates when the event happened. + GetPosition(self) -> Point + Returns the position of the mouse in window coordinates when the event +happened. GetPositionTuple() -> (x,y) - Returns the position of the mouse in window coordinates when the event happened. + Returns the position of the mouse in window coordinates when the event +happened. - GetLogicalPosition(DC dc) -> Point + GetLogicalPosition(self, DC dc) -> Point - GetX() -> int + GetX(self) -> int - GetY() -> int + GetY(self) -> int - GetWheelRotation() -> int + GetWheelRotation(self) -> int - GetWheelDelta() -> int + GetWheelDelta(self) -> int - GetLinesPerAction() -> int + GetLinesPerAction(self) -> int - IsPageScroll() -> bool + IsPageScroll(self) -> bool @@ -2321,74 +2413,84 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__(int x=0, int y=0) -> SetCursorEvent + __init__(self, int x=0, int y=0) -> SetCursorEvent - GetX() -> int + GetX(self) -> int - GetY() -> int + GetY(self) -> int - SetCursor(Cursor cursor) + SetCursor(self, Cursor cursor) - GetCursor() -> Cursor + GetCursor(self) -> Cursor - HasCursor() -> bool + HasCursor(self) -> bool #--------------------------------------------------------------------------- - + - __init__(wxEventType keyType=wxEVT_NULL) -> KeyEvent + __init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent - ControlDown() -> bool + ControlDown(self) -> bool - MetaDown() -> bool + MetaDown(self) -> bool - AltDown() -> bool + AltDown(self) -> bool - ShiftDown() -> bool + ShiftDown(self) -> bool + + + CmdDown(self) -> bool + "Cmd" is a pseudo key which is the same as Control for PC and Unix +platforms but the special "Apple" (a.k.a as "Command") key on +Macs: it makes often sense to use it instead of, say, `ControlDown` +because Cmd key is used for the same thing under Mac as Ctrl +elsewhere. The Ctrl still exists, it's just not used for this +purpose. So for non-Mac platforms this is the same as `ControlDown` +and Macs this is the same as `MetaDown`. - HasModifiers() -> bool + HasModifiers(self) -> bool - GetKeyCode() -> int + GetKeyCode(self) -> int - - GetUniChar() -> int + + GetUnicodeKey(self) -> int - GetRawKeyCode() -> unsigned int + GetRawKeyCode(self) -> unsigned int - GetRawKeyFlags() -> unsigned int + GetRawKeyFlags(self) -> unsigned int - GetPosition() -> Point + GetPosition(self) -> Point Find the position of the event. @@ -2400,10 +2502,10 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) - GetX() -> int + GetX(self) -> int - GetY() -> int + GetY(self) -> int @@ -2419,29 +2521,29 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__(Size sz=DefaultSize, int winid=0) -> SizeEvent + __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent - GetSize() -> Size + GetSize(self) -> Size - GetRect() -> Rect + GetRect(self) -> Rect - SetRect(Rect rect) + SetRect(self, Rect rect) - SetSize(Size size) + SetSize(self, Size size) @@ -2452,29 +2554,29 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__(Point pos=DefaultPosition, int winid=0) -> MoveEvent + __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent - GetPosition() -> Point + GetPosition(self) -> Point - GetRect() -> Rect + GetRect(self) -> Rect - SetRect(Rect rect) + SetRect(self, Rect rect) - SetPosition(Point pos) + SetPosition(self, Point pos) @@ -2485,19 +2587,19 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__(int Id=0) -> PaintEvent + __init__(self, int Id=0) -> PaintEvent - + - __init__(int winid=0) -> NcPaintEvent + __init__(self, int winid=0) -> NcPaintEvent @@ -2506,36 +2608,36 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__(int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent + __init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent - GetDC() -> DC + GetDC(self) -> DC #--------------------------------------------------------------------------- - + - __init__(wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent + __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent - GetWindow() -> Window + GetWindow(self) -> Window - SetWindow(Window win) + SetWindow(self, Window win) @@ -2544,25 +2646,25 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__(Window win=None) -> ChildFocusEvent + __init__(self, Window win=None) -> ChildFocusEvent - GetWindow() -> Window + GetWindow(self) -> Window #--------------------------------------------------------------------------- - + - __init__(wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent + __init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent @@ -2570,16 +2672,16 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) - GetActive() -> bool + GetActive(self) -> bool #--------------------------------------------------------------------------- - + - __init__(int Id=0) -> InitDialogEvent + __init__(self, int Id=0) -> InitDialogEvent @@ -2588,10 +2690,10 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__(wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent + __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent @@ -2599,100 +2701,100 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) - GetMenuId() -> int + GetMenuId(self) -> int - IsPopup() -> bool + IsPopup(self) -> bool - GetMenu() -> Menu + GetMenu(self) -> Menu #--------------------------------------------------------------------------- - + - __init__(wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent + __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent - SetLoggingOff(bool logOff) + SetLoggingOff(self, bool logOff) - GetLoggingOff() -> bool + GetLoggingOff(self) -> bool - Veto(bool veto=True) + Veto(self, bool veto=True) - SetCanVeto(bool canVeto) + SetCanVeto(self, bool canVeto) - CanVeto() -> bool + CanVeto(self) -> bool - GetVeto() -> bool + GetVeto(self) -> bool #--------------------------------------------------------------------------- - + - __init__(int winid=0, bool show=False) -> ShowEvent + __init__(self, int winid=0, bool show=False) -> ShowEvent - SetShow(bool show) + SetShow(self, bool show) - GetShow() -> bool + GetShow(self) -> bool #--------------------------------------------------------------------------- - + - __init__(int id=0, bool iconized=True) -> IconizeEvent + __init__(self, int id=0, bool iconized=True) -> IconizeEvent - Iconized() -> bool + Iconized(self) -> bool #--------------------------------------------------------------------------- - + - __init__(int id=0) -> MaximizeEvent + __init__(self, int id=0) -> MaximizeEvent @@ -2701,61 +2803,61 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - GetPosition() -> Point + GetPosition(self) -> Point - GetNumberOfFiles() -> int + GetNumberOfFiles(self) -> int - GetFiles() -> PyObject + GetFiles(self) -> PyObject #--------------------------------------------------------------------------- - + - __init__(int commandId=0) -> UpdateUIEvent + __init__(self, int commandId=0) -> UpdateUIEvent - GetChecked() -> bool + GetChecked(self) -> bool - GetEnabled() -> bool + GetEnabled(self) -> bool - GetText() -> String + GetText(self) -> String - GetSetText() -> bool + GetSetText(self) -> bool - GetSetChecked() -> bool + GetSetChecked(self) -> bool - GetSetEnabled() -> bool + GetSetEnabled(self) -> bool - Check(bool check) + Check(self, bool check) - Enable(bool enable) + Enable(self, bool enable) - SetText(String text) + SetText(self, String text) @@ -2791,110 +2893,116 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__() -> SysColourChangedEvent + __init__(self) -> SysColourChangedEvent #--------------------------------------------------------------------------- - + - __init__(int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent + __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent - GetCapturedWindow() -> Window + GetCapturedWindow(self) -> Window #--------------------------------------------------------------------------- - + - __init__() -> DisplayChangedEvent + __init__(self) -> DisplayChangedEvent #--------------------------------------------------------------------------- - + - __init__(int id=0) -> PaletteChangedEvent + __init__(self, int id=0) -> PaletteChangedEvent - SetChangedWindow(Window win) + SetChangedWindow(self, Window win) - GetChangedWindow() -> Window + GetChangedWindow(self) -> Window #--------------------------------------------------------------------------- - + - __init__(int winid=0) -> QueryNewPaletteEvent + __init__(self, int winid=0) -> QueryNewPaletteEvent - SetPaletteRealized(bool realized) + SetPaletteRealized(self, bool realized) - GetPaletteRealized() -> bool + GetPaletteRealized(self) -> bool #--------------------------------------------------------------------------- - + - __init__() -> NavigationKeyEvent + __init__(self) -> NavigationKeyEvent - GetDirection() -> bool + GetDirection(self) -> bool - SetDirection(bool bForward) + SetDirection(self, bool forward) - + - IsWindowChange() -> bool + IsWindowChange(self) -> bool - SetWindowChange(bool bIs) + SetWindowChange(self, bool ischange) - + + + + + SetFlags(self, long flags) + + - GetCurrentFocus() -> Window + GetCurrentFocus(self) -> Window - SetCurrentFocus(Window win) + SetCurrentFocus(self, Window win) @@ -2903,37 +3011,37 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__(Window win=None) -> WindowCreateEvent + __init__(self, Window win=None) -> WindowCreateEvent - GetWindow() -> Window + GetWindow(self) -> Window - + - __init__(Window win=None) -> WindowDestroyEvent + __init__(self, Window win=None) -> WindowDestroyEvent - GetWindow() -> Window + GetWindow(self) -> Window #--------------------------------------------------------------------------- - + - __init__(wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent + __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent @@ -2941,10 +3049,10 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) - GetPosition() -> Point + GetPosition(self) -> Point - SetPosition(Point pos) + SetPosition(self, Point pos) @@ -2953,19 +3061,19 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__() -> IdleEvent + __init__(self) -> IdleEvent - RequestMore(bool needMore=True) + RequestMore(self, bool needMore=True) - MoreRequested() -> bool + MoreRequested(self) -> bool SetMode(int mode) @@ -2986,245 +3094,257 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) #--------------------------------------------------------------------------- - + - __init__(int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent + __init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent - __del__() + __del__(self) - SetSelf(PyObject self) + SetSelf(self, PyObject self) - GetSelf() -> PyObject + GetSelf(self) -> PyObject - + - __init__(wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent + __init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent - __del__() + __del__(self) - SetSelf(PyObject self) + SetSelf(self, PyObject self) - GetSelf() -> PyObject + GetSelf(self) -> PyObject #--------------------------------------------------------------------------- - + + The ``wx.PyApp`` class is an *implementation detail*, please use the +`wx.App` class (or some other derived class) instead. - __init__() -> PyApp + __init__(self) -> PyApp Create a new application object, starting the bootstrap process. - __del__() + __del__(self) - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - GetAppName() -> String + GetAppName(self) -> String Get the application name. - SetAppName(String name) - Set the application name. This value may be used automatically -by wx.Config and such. + SetAppName(self, String name) + Set the application name. This value may be used automatically by +`wx.Config` and such. - GetClassName() -> String + GetClassName(self) -> String Get the application's class name. - SetClassName(String name) - Set the application's class name. This value may be used for X-resources if -applicable for the platform + SetClassName(self, String name) + Set the application's class name. This value may be used for +X-resources if applicable for the platform - GetVendorName() -> String + GetVendorName(self) -> String Get the application's vendor name. - SetVendorName(String name) - Set the application's vendor name. This value may be used automatically -by wx.Config and such. + SetVendorName(self, String name) + Set the application's vendor name. This value may be used +automatically by `wx.Config` and such. - GetTraits() -> wxAppTraits - 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 + GetTraits(self) -> wxAppTraits + 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. - ProcessPendingEvents() - 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. + ProcessPendingEvents(self) + 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. - Yield(bool onlyIfNeeded=False) -> bool - 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! + Yield(self, bool onlyIfNeeded=False) -> bool + 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` - WakeUpIdle() - Make sure that idle events are sent again + WakeUpIdle(self) + Make sure that idle events are sent again. +:see: `wx.WakeUpIdle` - MainLoop() -> int - Execute the main GUI loop, the function returns when the loop ends. + MainLoop(self) -> int + Execute the main GUI loop, the function doesn't normally return until +all top level windows have been closed and destroyed. - Exit() - Exit the main loop thus terminating the application. + Exit(self) + Exit the main loop thus terminating the application. +:see: `wx.Exit` - ExitMainLoop() - Exit the main GUI loop during the next iteration (i.e. it does not -stop the program immediately!) + ExitMainLoop(self) + Exit the main GUI loop during the next iteration of the main +loop, (i.e. it does not stop the program immediately!) - Pending() -> bool + Pending(self) -> bool Returns True if there are unprocessed events in the event queue. - Dispatch() -> bool + Dispatch(self) -> bool Process the first event in the event queue (blocks until an event appears if there are none currently) - ProcessIdle() -> bool - 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. + ProcessIdle(self) -> bool + 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. - SendIdleEvents(Window win, IdleEvent event) -> bool - Send idle event to window and all subwindows. Returns True if more idle time -is requested. + SendIdleEvents(self, Window win, IdleEvent event) -> bool + Send idle event to window and all subwindows. Returns True if more +idle time is requested. - IsActive() -> bool + IsActive(self) -> bool Return True if our app has focus. - SetTopWindow(Window win) - Set the "main" top level window + SetTopWindow(self, Window win) + Set the *main* top level window - GetTopWindow() -> Window - 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) + GetTopWindow(self) -> Window + 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) - SetExitOnFrameDelete(bool flag) - 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. - + SetExitOnFrameDelete(self, bool flag) + 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. - GetExitOnFrameDelete() -> bool + GetExitOnFrameDelete(self) -> bool Get the current exit behaviour setting. - SetUseBestVisual(bool flag) - 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.) + SetUseBestVisual(self, bool flag) + 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.) - GetUseBestVisual() -> bool + GetUseBestVisual(self) -> bool Get current UseBestVisual setting. - SetPrintMode(int mode) + SetPrintMode(self, int mode) - GetPrintMode() -> int + GetPrintMode(self) -> int - SetAssertMode(int mode) - 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 + SetAssertMode(self, int mode) + 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 + ========================= ======================================= + - GetAssertMode() -> int + GetAssertMode(self) -> int Get the current OnAssert behaviour setting. @@ -3273,13 +3393,13 @@ may be or'd together: - _BootstrapApp() + _BootstrapApp(self) For internal use only GetComCtl32Version() -> int - 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. + 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. @@ -3299,12 +3419,13 @@ wasn't found at all. Raises an exception on non-Windows platforms. SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool - 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. + 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. +:Returns: the result of the call to `wx.Yield`. @@ -3312,11 +3433,13 @@ Returns the result of the call to wx.Yield. WakeUpIdle() - Cause the message queue to become empty again, so idle events will be sent. + Cause the message queue to become empty again, so idle events will be +sent. PostEvent(EvtHandler dest, Event event) - Send an event to a window or other wx.EvtHandler to be processed later. + Send an event to a window or other wx.EvtHandler to be processed +later. @@ -3324,9 +3447,10 @@ Returns the result of the call to wx.Yield. App_CleanUp() - For internal use only, it is used to cleanup after wxWindows when Python shuts down. + For internal use only, it is used to cleanup after wxWidgets when +Python shuts down. - + GetApp() -> PyApp Return a reference to the current wx.App object. @@ -3343,6 +3467,8 @@ class PyOnDemandOutputWindow: def __init__(self, title = "wxPython: stdout/stderr"): self.frame = None self.title = title + self.pos = wx.DefaultPosition + self.size = (450, 300) self.parent = None def SetParent(self, parent): @@ -3351,12 +3477,11 @@ class PyOnDemandOutputWindow: def CreateOutputWindow(self, st): - self.frame = wx.Frame(self.parent, -1, self.title, - style=wx.DEFAULT_FRAME_STYLE | wx.NO_FULL_REPAINT_ON_RESIZE) + self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size, + style=wx.DEFAULT_FRAME_STYLE) self.text = wx.TextCtrl(self.frame, -1, "", - style = wx.TE_MULTILINE | wx.TE_READONLY) + style=wx.TE_MULTILINE|wx.TE_READONLY) self.text.AppendText(st) - self.frame.SetSize((450, 300)) self.frame.Show(True) EVT_CLOSE(self.frame, self.OnCloseWindow) @@ -3392,6 +3517,10 @@ class PyOnDemandOutputWindow: wx.CallAfter(self.frame.Close) + def flush(self): + pass + + #---------------------------------------------------------------------- @@ -3399,12 +3528,61 @@ _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__') 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__": @@ -3416,6 +3594,8 @@ This program needs access to the screen. Please run with 'pythonw', not 'python', and only when you are logged in on the main display of your Mac.""" _sys.exit(1) + except SystemExit: + raise except: pass @@ -3428,11 +3608,12 @@ your Mac.""" # 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 @@ -3478,19 +3659,35 @@ your Mac.""" _sys.stdout, _sys.stderr = self.saveStdio - -# 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 + def SetOutputWindowAttributes(self, title=None, pos=None, size=None): + """ + Set the title, position and/or size of the output window if + the stdio has been redirected. This should be called before + any output would cause the output window to be created. + """ + if self.stdioWin: + if title is not None: + self.stdioWin.title = title + if pos is not None: + self.stdioWin.pos = pos + if size is not None: + self.stdioWin.size = size + + + + +# 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 #---------------------------------------------------------------------------- @@ -3498,16 +3695,28 @@ class PySimpleApp(wx.App): """ 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() - def __init__(self, redirect=False, filename=None, useBestVisual=False): - wx.App.__init__(self, redirect, filename, useBestVisual) + :see: `wx.App` + """ + + 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)): @@ -3519,30 +3728,27 @@ class PyWidgetTester(wx.App): 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) #---------------------------------------------------------------------------- @@ -3550,63 +3756,98 @@ _sys.__wxPythonCleanup = __wxPyCleanup() #--------------------------------------------------------------------------- - + + 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` - __init__(int flags=0, int keyCode=0, int cmd=0, MenuItem item=None) -> AcceleratorEntry + __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry + Construct a wx.AcceleratorEntry. + :param flags: A bitmask of wx.ACCEL_ALT, wx.ACCEL_SHIFT, + wx.ACCEL_CTRL or wx.ACCEL_NORMAL used to specify + which modifier keys are held down. + :param keyCode: The keycode to be detected + :param cmdID: The menu or control command ID to use for the + accellerator event. + - - + - __del__() + __del__(self) - Set(int flags, int keyCode, int cmd, MenuItem item=None) + Set(self, int flags, int keyCode, int cmd) + (Re)set the attributes of a wx.AcceleratorEntry. +:see `__init__` - - - - - SetMenuItem(MenuItem item) - - - - GetMenuItem() -> MenuItem - - GetFlags() -> int + GetFlags(self) -> int + Get the AcceleratorEntry's flags. - GetKeyCode() -> int + GetKeyCode(self) -> int + Get the AcceleratorEntry's keycode. - GetCommand() -> int + GetCommand(self) -> int + Get the AcceleratorEntry's command ID. - + + 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. + +The object ``wx.NullAcceleratorTable`` is defined to be a table with +no data, and is the initial accelerator table for a window. + +An accelerator takes precedence over normal processing and can be a +convenient way to program some event handling. For example, you can +use an accelerator table to make a hotkey generate an event no matter +which window within a frame has the focus. + +Foe example:: + + aTable = wx.AcceleratorTable([(wx.ACCEL_ALT, ord('X'), exitID), + (wx.ACCEL_CTRL, ord('H'), helpID), + (wx.ACCEL_CTRL, ord('F'), findID), + (wx.ACCEL_NORMAL, wx.WXK_F3, findnextID) + ]) + self.SetAcceleratorTable(aTable) + + +:see: `wx.AcceleratorEntry`, `wx.Window.SetAcceleratorTable` + __init__(entries) -> AcceleratorTable - Construct an AcceleratorTable from a list of AcceleratorEntry items or -3-tuples (flags, keyCode, cmdID) + Construct an AcceleratorTable from a list of `wx.AcceleratorEntry` +items or or of 3-tuples (flags, keyCode, cmdID) + +:see: `wx.AcceleratorEntry` - __del__() + __del__(self) - Ok() -> bool + Ok(self) -> bool @@ -3618,91 +3859,106 @@ _sys.__wxPythonCleanup = __wxPyCleanup() #--------------------------------------------------------------------------- - - -wx.Window is the base class for all windows and represents any visible + + struct containing all the visual attributes of a control + + __init__(self) -> VisualAttributes + struct containing all the visual attributes of a control + + + __del__(self) + + + + + + + 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. - - - 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, + +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 @@ -3710,7 +3966,7 @@ appear on screen themselves. them recursively descend into all subwindows. - wx.WS_EX_BLOCK_EVENTS: wx.CommandEvents and the objects of the + 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 @@ -3730,7 +3986,7 @@ appear on screen themselves. lead to a crash if the parent is destroyed before the child. - wx.WS_EX_PROCESS_IDLE: This window should always process idle + 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. @@ -3739,16 +3995,17 @@ appear on screen themselves. update events, even if the mode set by wxUpdateUIEvent::SetMode is wxUPDATE_UI_PROCESS_SPECIFIED. + ============================= ===================================== - + - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=PanelNameStr) -> Window + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window Construct and show a generic Window. - + @@ -3760,12 +4017,12 @@ appear on screen themselves. Precreate a Window for 2-phase creation. - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=PanelNameStr) -> bool + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool Create the GUI part of the Window for 2-phase creation mode. - + @@ -3773,12 +4030,11 @@ appear on screen themselves. - Close(bool force=False) -> bool + Close(self, bool force=False) -> bool 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. @@ -3802,7 +4058,7 @@ instead. - Destroy() -> bool + Destroy(self) -> bool 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 @@ -3813,68 +4069,77 @@ Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion. - DestroyChildren() -> bool - Destroys all children of a window. Called automatically by the destructor. + DestroyChildren(self) -> bool + Destroys all children of a window. Called automatically by the +destructor. - IsBeingDeleted() -> bool + IsBeingDeleted(self) -> bool Is the window in the process of being deleted? - SetTitle(String title) + SetTitle(self, String title) Sets the window's title. Applicable only to frames and dialogs. - GetTitle() -> String + GetTitle(self) -> String Gets the window's title. Applicable only to frames and dialogs. - SetLabel(String label) + SetLabel(self, String label) Set the text which the window shows in its label if applicable. - GetLabel() -> String - 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. + GetLabel(self) -> String + 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. - SetName(String name) - 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 + SetName(self, String name) + 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 - GetName() -> String - 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. + GetName(self) -> String + 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. - SetWindowVariant(int variant) - Sets the variant of the window/font size to use for this window, -if the platform supports variants, (for example, wxMac.) + SetWindowVariant(self, int variant) + Sets the variant of the window/font size to use for this window, if +the platform supports variants, for example, wxMac. +Variant values are: + + ======================== ======================================= + wx.WINDOW_VARIANT_NORMAL Normal size + wx.WINDOW_VARIANT_SMALL Smaller size (about 25 % smaller than normal) + wx.WINDOW_VARIANT_MINI Mini size (about 33 % smaller than normal) + wx.WINDOW_VARIANT_LARGE Large size (about 25 % larger than normal) + ======================== ======================================= + - GetWindowVariant() -> int + GetWindowVariant(self) -> int - SetId(int winid) + SetId(self, int winid) 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 @@ -3884,7 +4149,7 @@ creation and should not be modified subsequently. - GetId() -> int + GetId(self) -> int 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 @@ -3897,7 +4162,7 @@ generated. NextControlId(int winid) -> int Get the id of the control following the one with the given -(autogenerated) id +autogenerated) id @@ -3905,20 +4170,20 @@ generated. PrevControlId(int winid) -> int Get the id of the control preceding the one with the given -(autogenerated) id +autogenerated) id - SetSize(Size size) + SetSize(self, Size size) Sets the size of the window in pixels. - SetDimensions(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) + SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) 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 @@ -3935,7 +4200,7 @@ default values. - SetRect(Rect rect, int sizeFlags=SIZE_AUTO) + SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO) Sets the position and size of the window in pixels using a wx.Rect. @@ -3943,7 +4208,7 @@ default values. - SetSizeWH(int width, int height) + SetSizeWH(self, int width, int height) Sets the size of the window in pixels. @@ -3951,7 +4216,7 @@ default values. - Move(Point pt, int flags=SIZE_USE_EXISTING) + Move(self, Point pt, int flags=SIZE_USE_EXISTING) Moves the window to the given position. @@ -3959,7 +4224,7 @@ default values. - MoveXY(int x, int y, int flags=SIZE_USE_EXISTING) + MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING) Moves the window to the given position. @@ -3967,18 +4232,26 @@ default values. + + SetBestFittingSize(self, Size size=DefaultSize) + A 'Smart' SetSize that will fill in default size components with the +window's *best size* values. Also set's the minsize for use with sizers. + + + + - Raise() + Raise(self) Raises the window to the top of the window hierarchy if it is a managed window (dialog or frame). - Lower() + Lower(self) Lowers the window to the bottom of the window hierarchy if it is a managed window (dialog or frame). - SetClientSize(Size size) + SetClientSize(self, Size size) 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 @@ -3989,7 +4262,7 @@ around panel items, for example. - SetClientSizeWH(int width, int height) + SetClientSizeWH(self, int width, int height) 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 @@ -4001,7 +4274,7 @@ around panel items, for example. - SetClientRect(Rect rect) + SetClientRect(self, Rect rect) 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 @@ -4012,7 +4285,7 @@ around panel items, for example. - GetPosition() -> Point + GetPosition(self) -> Point Get the window's position. @@ -4024,7 +4297,7 @@ around panel items, for example. - GetSize() -> Size + GetSize(self) -> Size Get the window size. @@ -4036,11 +4309,11 @@ around panel items, for example. - GetRect() -> Rect + GetRect(self) -> Rect Returns the size and position of the window as a wx.Rect object. - GetClientSize() -> Size + GetClientSize(self) -> Size 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. @@ -4056,39 +4329,51 @@ title bar, border, scrollbars, etc. - GetClientAreaOrigin() -> Point + GetClientAreaOrigin(self) -> Point 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...) - GetClientRect() -> Rect - Get the client area position and size as a wx.Rect object. + GetClientRect(self) -> Rect + Get the client area position and size as a `wx.Rect` object. - GetBestSize() -> Size - 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. + GetBestSize(self) -> Size + 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. GetBestSizeTuple() -> (width, height) - 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. + 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. + + InvalidateBestSize(self) + Reset the cached best size value so it will be recalculated the next +time it is needed. + + + GetBestFittingSize(self) -> Size + This function will merge the window's best size into the window's +minimum size, giving priority to the min size components, and returns +the results. + + - GetAdjustedBestSize() -> Size + GetAdjustedBestSize(self) -> Size 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 @@ -4097,7 +4382,7 @@ should currently be drawn at, not the minimal size it can possibly tolerate. - Center(int direction=BOTH) + Center(self, int direction=BOTH) 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 @@ -4109,21 +4394,21 @@ relative to the screen. - CenterOnScreen(int dir=BOTH) + CenterOnScreen(self, int dir=BOTH) Center on screen (only works for top level windows) - CenterOnParent(int dir=BOTH) + CenterOnParent(self, int dir=BOTH) Center with respect to the the parent window - Fit() + Fit(self) 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 @@ -4133,7 +4418,7 @@ its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit. - FitInside() + FitInside(self) 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 @@ -4141,13 +4426,19 @@ windows without an interior sizer. This function similarly won't do anything if there are no subwindows. - SetSizeHints(int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, + SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1) Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user -will not be able to size the window outside the given bounds. The -resizing increments are only significant under Motif or Xt. +will not be able to size the window outside the given bounds (if it is +a top-level window.) Sizers will also inspect the minimum window size +and will use that value if set when calculating layout. + +The resizing increments are only significant under Motif or Xt. + +:see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize` + @@ -4157,8 +4448,27 @@ resizing increments are only significant under Motif or Xt. + + SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize) + Allows specification of minimum and maximum window sizes, and window +size increments. If a pair of values is not set (or set to -1), the +default values will be used. If this function is called, the user +will not be able to size the window outside the given bounds (if it is +a top-level window.) Sizers will also inspect the minimum window size +and will use that value if set when calculating layout. + +The resizing increments are only significant under Motif or Xt. + +:see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize` + + + + + + + - SetVirtualSizeHints(int minW, int minH, int maxW=-1, int maxH=-1) + SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1) 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 @@ -4170,23 +4480,53 @@ the virtual area of the window outside the given bounds. + + SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize) + Allows specification of minimum and maximum virtual window sizes. If a +pair of values is not set (or set to -1), the default values will be +used. If this function is called, the user will not be able to size +the virtual area of the window outside the given bounds. + + + + + + + GetMaxSize(self) -> Size + + + GetMinSize(self) -> Size + + + SetMinSize(self, Size minSize) + A more convenient method than `SetSizeHints` for setting just the +min size. + + + + + + SetMaxSize(self, Size maxSize) + A more convenient method than `SetSizeHints` for setting just the +max size. + + + + - GetMinWidth() -> int + GetMinWidth(self) -> int - GetMinHeight() -> int + GetMinHeight(self) -> int - GetMaxWidth() -> int + GetMaxWidth(self) -> int - GetMaxHeight() -> int - - - GetMaxSize() -> Size + GetMaxHeight(self) -> int - SetVirtualSize(Size size) + SetVirtualSize(self, Size size) 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. @@ -4195,7 +4535,7 @@ windows it is more or less independent of the screen window size. - SetVirtualSizeWH(int w, int h) + SetVirtualSizeWH(self, int w, int h) 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. @@ -4205,7 +4545,7 @@ windows it is more or less independent of the screen window size. - GetVirtualSize() -> Size + GetVirtualSize(self) -> Size 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. @@ -4221,12 +4561,12 @@ windows it is more or less independent of the screen window size. - GetBestVirtualSize() -> Size + GetBestVirtualSize(self) -> Size Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means) - Show(bool show=True) -> bool + Show(self, bool show=True) -> bool 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 @@ -4237,11 +4577,11 @@ because it already was in the requested state. - Hide() -> bool + Hide(self) -> bool Equivalent to calling Show(False). - Enable(bool enable=True) -> bool + Enable(self, bool enable=True) -> bool 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 @@ -4252,45 +4592,46 @@ window had already been in the specified state. - Disable() -> bool + Disable(self) -> bool Disables the window, same as Enable(false). - IsShown() -> bool + IsShown(self) -> bool Returns true if the window is shown, false if it has been hidden. - IsEnabled() -> bool + IsEnabled(self) -> bool Returns true if the window is enabled for input, false otherwise. - SetWindowStyleFlag(long style) + SetWindowStyleFlag(self, long style) 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. +changed after the window creation and that Refresh() might need to be +called after changing the others for the change to take place +immediately. - GetWindowStyleFlag() -> long + GetWindowStyleFlag(self) -> long Gets the window style that was passed to the constructor or Create method. - HasFlag(int flag) -> bool + HasFlag(self, int flag) -> bool Test if the given style is set for this window. - IsRetained() -> bool + IsRetained(self) -> bool Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms. - SetExtraStyle(long exStyle) + SetExtraStyle(self, long exStyle) 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() @@ -4299,11 +4640,11 @@ SetWindowStyleFlag() - GetExtraStyle() -> long + GetExtraStyle(self) -> long Returns the extra style bits for the window. - MakeModal(bool modal=True) + MakeModal(self, bool modal=True) Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect. @@ -4312,7 +4653,7 @@ effect. - SetThemeEnabled(bool enableTheme) + SetThemeEnabled(self, bool enableTheme) 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 @@ -4327,15 +4668,15 @@ by default so that the default look and feel is simulated best. - GetThemeEnabled() -> bool + GetThemeEnabled(self) -> bool Return the themeEnabled flag. - SetFocus() + SetFocus(self) Set's the focus to this window, allowing it to receive keyboard input. - SetFocusFromKbd() + SetFocusFromKbd(self) Set focus to this window as the result of a keyboard action. Normally only called internally. @@ -4345,57 +4686,103 @@ only called internally. or None. - AcceptsFocus() -> bool + AcceptsFocus(self) -> bool Can this window have focus? - AcceptsFocusFromKeyboard() -> bool + AcceptsFocusFromKeyboard(self) -> bool 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. - GetDefaultItem() -> Window + GetDefaultItem(self) -> Window 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. - SetDefaultItem(Window child) -> Window + SetDefaultItem(self, Window child) -> Window Set this child as default, return the old default. - SetTmpDefaultItem(Window win) + SetTmpDefaultItem(self, Window win) Set this child as temporary default + + Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool + Does keyboard navigation from this window to another, by sending a +`wx.NavigationKeyEvent`. + + :param flags: A combination of the ``IsForward`` or ``IsBackward`` + and the ``WinChange`` values in the `wx.NavigationKeyEvent` + class, which determine if the navigation should be in forward + or reverse order, and if it should be able to cross parent + window boundaries, such as between notebook pages or MDI child + frames. Typically the status of the Shift key (for forward or + backward) or the Control key (for WinChange) would be used to + determine how to set the flags. + +One situation in which you may wish to call this method is from a text +control custom keypress handler to do the default navigation behaviour +for the tab key, since the standard default behaviour for a multiline +text control with the wx.TE_PROCESS_TAB style is to insert a tab and +not navigate to the next control. + + + + + + MoveAfterInTabOrder(self, Window win) + Moves this window in the tab navigation order after the specified +sibling window. This means that when the user presses the TAB key on +that other window, the focus switches to this window. + +The default tab order is the same as creation order. This function +and `MoveBeforeInTabOrder` allow to change it after creating all the +windows. + + + + + + + MoveBeforeInTabOrder(self, Window win) + Same as `MoveAfterInTabOrder` except that it inserts this window just +before win instead of putting it right after it. + + + + - GetChildren() -> PyObject + GetChildren(self) -> PyObject 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. - GetParent() -> Window + GetParent(self) -> Window Returns the parent window of this window, or None if there isn't one. - GetGrandParent() -> Window - Returns the parent of the parent of this window, or None if there isn't one. + GetGrandParent(self) -> Window + Returns the parent of the parent of this window, or None if there +isn't one. - IsTopLevel() -> bool + IsTopLevel(self) -> bool 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). - Reparent(Window newParent) -> bool + Reparent(self, Window newParent) -> bool 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 @@ -4406,7 +4793,7 @@ oldParent) - AddChild(Window child) + AddChild(self, Window child) Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer. @@ -4414,7 +4801,7 @@ functions so should not be required by the application programmer. - RemoveChild(Window child) + RemoveChild(self, Window child) Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer. @@ -4423,33 +4810,33 @@ programmer. - FindWindowById(long winid) -> Window + FindWindowById(self, long winid) -> Window Find a chld of this window by window ID - FindWindowByName(String name) -> Window + FindWindowByName(self, String name) -> Window Find a child of this window by name - GetEventHandler() -> EvtHandler + GetEventHandler(self) -> EvtHandler Returns the event handler for this window. By default, the window is its own event handler. - SetEventHandler(EvtHandler handler) + SetEventHandler(self, EvtHandler handler) Sets the event handler for this window. An event handler is an object that is capable of processing the events sent to a window. By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes. -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. @@ -4457,7 +4844,7 @@ handler is handed to the next one in the chain. - PushEventHandler(EvtHandler handler) + PushEventHandler(self, EvtHandler handler) 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 @@ -4467,14 +4854,14 @@ window classes. wx.Window.PushEventHandler allows an application to set up a chain of event handlers, where an event not handled by one event handler is -handed to the next one in the chain. Use wx.Window.PopEventHandler to +handed to the next one in the chain. Use `wx.Window.PopEventHandler` to remove the event handler. - PopEventHandler(bool deleteHandler=False) -> EvtHandler + PopEventHandler(self, bool deleteHandler=False) -> EvtHandler Removes and returns the top-most event handler on the event handler stack. If deleteHandler is True then the wx.EvtHandler object will be destroyed after it is popped. @@ -4483,18 +4870,18 @@ destroyed after it is popped. - RemoveEventHandler(EvtHandler handler) -> bool - Find the given handler in the event handler chain and remove (but -not delete) it from the event handler chain, return True if it was -found 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.) + RemoveEventHandler(self, EvtHandler handler) -> bool + Find the given handler in the event handler chain and remove (but not +delete) it from the event handler chain, return True if it was found +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.) - SetValidator(Validator validator) + SetValidator(self, Validator validator) Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type. @@ -4503,23 +4890,49 @@ type. - GetValidator() -> Validator + GetValidator(self) -> Validator Returns a pointer to the current validator for the window, or None if there is none. + + + Validate(self) -> bool + 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. + + + TransferDataToWindow(self) -> bool + 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. + + + TransferDataFromWindow(self) -> bool + 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. + + + InitDialog(self) + Sends an EVT_INIT_DIALOG event, whose handler usually transfers data +to the dialog via validators. - SetAcceleratorTable(AcceleratorTable accel) + SetAcceleratorTable(self, AcceleratorTable accel) Sets the accelerator table for this window. - GetAcceleratorTable() -> AcceleratorTable + GetAcceleratorTable(self) -> AcceleratorTable Gets the accelerator table for this window. - RegisterHotKey(int hotkeyId, int modifiers, int keycode) -> bool + RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool 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 @@ -4534,14 +4947,14 @@ hotkey was registered successfully. - UnregisterHotKey(int hotkeyId) -> bool + UnregisterHotKey(self, int hotkeyId) -> bool Unregisters a system wide hotkey. - ConvertDialogPointToPixels(Point pt) -> Point + ConvertDialogPointToPixels(self, Point pt) -> Point 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 @@ -4553,7 +4966,7 @@ then divided by 8. - ConvertDialogSizeToPixels(Size sz) -> Size + ConvertDialogSizeToPixels(self, Size sz) -> Size 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 @@ -4565,7 +4978,7 @@ then divided by 8. - DLG_PNT(Point pt) -> Point + DLG_PNT(self, Point pt) -> Point 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 @@ -4577,7 +4990,7 @@ then divided by 8. - DLG_SZE(Size sz) -> Size + DLG_SZE(self, Size sz) -> Size 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 @@ -4589,19 +5002,19 @@ then divided by 8. - ConvertPixelPointToDialog(Point pt) -> Point + ConvertPixelPointToDialog(self, Point pt) -> Point - ConvertPixelSizeToDialog(Size sz) -> Size + ConvertPixelSizeToDialog(self, Size sz) -> Size - WarpPointer(int x, int y) + WarpPointer(self, int x, int y) Moves the pointer to the given position on the window. NOTE: This function is not supported under Mac because Apple Human @@ -4612,7 +5025,7 @@ Interface Guidelines forbid moving the mouse cursor programmatically. - CaptureMouse() + CaptureMouse(self) Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture. @@ -4623,7 +5036,7 @@ there were no previous window. In particular, this means that you must release the mouse as many times as you capture it. - ReleaseMouse() + ReleaseMouse(self) Releases mouse input captured with wx.Window.CaptureMouse. @@ -4631,11 +5044,11 @@ release the mouse as many times as you capture it. Returns the window which currently captures the mouse or None - HasCapture() -> bool + HasCapture(self) -> bool Returns true if this window has the current mouse capture. - Refresh(bool eraseBackground=True, Rect rect=None) + Refresh(self, bool eraseBackground=True, Rect rect=None) 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. @@ -4645,7 +5058,7 @@ to the window. - RefreshRect(Rect rect) + RefreshRect(self, Rect rect) 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. @@ -4653,7 +5066,7 @@ be repainted. This is the same as Refresh but has a nicer syntax. - Update() + Update(self) 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 @@ -4663,16 +5076,17 @@ first if you want to immediately redraw the window (or some portion of it) unconditionally. - ClearBackground() + ClearBackground(self) Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated. - Freeze() - 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. + Freeze(self) + 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 @@ -4681,13 +5095,13 @@ for all controls so it is mostly just a hint to wxWindows and not a mandatory directive. - Thaw() + Thaw(self) 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. +Freeze/Thaw may be nested, so Thaw must be called the same number of +times that Freeze was before the window will be updated. - PrepareDC(DC dc) + PrepareDC(self, DC dc) Call this function to prepare the device context for drawing a scrolled image. It sets the device origin according to the current scroll position. @@ -4696,16 +5110,16 @@ scroll position. - GetUpdateRegion() -> Region + GetUpdateRegion(self) -> Region Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler. - GetUpdateClientRect() -> Rect + GetUpdateClientRect(self) -> Rect Get the update rectangle region bounding box in client coords. - IsExposed(int x, int y, int w=1, int h=1) -> bool + IsExposed(self, int x, int y, int w=1, int h=1) -> bool 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 @@ -4718,7 +5132,7 @@ exposed. - IsExposedPoint(Point pt) -> bool + IsExposedPoint(self, Point pt) -> bool 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 @@ -4728,7 +5142,7 @@ exposed. - IsExposedRect(Rect rect) -> bool + IsExposedRect(self, Rect rect) -> bool 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 @@ -4737,27 +5151,58 @@ exposed. + + GetDefaultAttributes(self) -> VisualAttributes + 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. + + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + - SetBackgroundColour(Colour colour) -> bool + SetBackgroundColour(self, Colour colour) -> bool Sets the background colour of the window. Returns True if the colour was changed. The background colour is usually painted by the default EVT_ERASE_BACKGROUND event handler function under Windows and -automatically under GTK. +automatically under GTK. Using `wx.NullColour` will reset the window +to the default background colour. -Note that setting the background colour does not cause an immediate -refresh, so you may wish to call ClearBackground or Refresh after +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. -Use this function with care under GTK+ as the new appearance of the -window might not look equally well when used with themes, i.e GTK+'s -ability to change its look as the user wishes with run-time loadable -modules. +Using this function will disable attempts to use themes for this +window, if the system supports them. Use with care since usually the +themes represent the appearance chosen by the user to be used for all +applications on the system. + + + + + + SetOwnBackgroundColour(self, Colour colour) - SetForegroundColour(Colour colour) -> bool + SetForegroundColour(self, Colour colour) -> bool 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 @@ -4766,18 +5211,52 @@ not be used at all. + + SetOwnForegroundColour(self, Colour colour) + + + + - GetBackgroundColour() -> Colour + GetBackgroundColour(self) -> Colour Returns the background colour of the window. - GetForegroundColour() -> Colour + GetForegroundColour(self) -> Colour 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. + + + SetBackgroundStyle(self, int style) -> bool + Returns the background style of the window. The background style +indicates how the background of the window is drawn. + + ====================== ======================================== + wx.BG_STYLE_SYSTEM The background colour or pattern should + be determined by the system + wx.BG_STYLE_COLOUR The background should be a solid colour + wx.BG_STYLE_CUSTOM The background will be implemented by the + application. + ====================== ======================================== + +On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of +a custom background, such as a tiled bitmap. Currently the style has +no effect on other platforms. + +:see: `GetBackgroundStyle`, `SetBackgroundColour` + + + + + + GetBackgroundStyle(self) -> int + Returns the background style of the window. + +:see: `SetBackgroundStyle` - SetCursor(Cursor cursor) -> bool + SetCursor(self, Cursor cursor) -> bool Sets the window's cursor. Notice that the window cursor also sets it for the children of the window implicitly. @@ -4788,37 +5267,43 @@ be reset back to default. - GetCursor() -> Cursor + GetCursor(self) -> Cursor Return the cursor associated with this window. - SetFont(Font font) -> bool + SetFont(self, Font font) -> bool Sets the font for this window. + + SetOwnFont(self, Font font) + + + + - GetFont() -> Font + GetFont(self) -> Font Returns the default font used for this window. - SetCaret(Caret caret) + SetCaret(self, Caret caret) Sets the caret associated with the window. - GetCaret() -> Caret + GetCaret(self) -> Caret Returns the caret associated with the window. - GetCharHeight() -> int + GetCharHeight(self) -> int Get the (average) character size for the current font. - GetCharWidth() -> int + GetCharWidth(self) -> int Get the (average) character size for the current font. @@ -4861,21 +5346,21 @@ current or specified font. - ClientToScreen(Point pt) -> Point + ClientToScreen(self, Point pt) -> Point Converts to screen coordinates from coordinates relative to this window. - ScreenToClient(Point pt) -> Point + ScreenToClient(self, Point pt) -> Point Converts from screen to client window coordinates. - HitTestXY(int x, int y) -> int + HitTestXY(self, int x, int y) -> int Test where the given (in client coords) point lies @@ -4883,7 +5368,7 @@ current or specified font. - HitTest(Point pt) -> int + HitTest(self, Point pt) -> int Test where the given (in client coords) point lies @@ -4900,12 +5385,12 @@ reasonable. - GetBorder(long flags) -> int -GetBorder() -> int + GetBorder(self, long flags) -> int +GetBorder(self) -> int Get border for the flags of this window - UpdateWindowUI(long flags=UPDATE_UI_NONE) + UpdateWindowUI(self, long flags=UPDATE_UI_NONE) 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 @@ -4916,19 +5401,20 @@ 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. +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): @@ -4939,67 +5425,69 @@ UpdateWindowUI from an idle function. - PopupMenuXY(Menu menu, int x, int y) -> bool - Pops up the given menu at the specified coordinates, relative to this -window, and returns control when the user has dismissed the menu. If a -menu item is selected, the corresponding menu event is generated and -will be processed as usual. + PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool + Pops up the given menu at the specified coordinates, relative to this window, +and returns control when the user has dismissed the menu. If a menu item is +selected, the corresponding menu event is generated and will be processed as +usual. If the default position is given then the current position of the +mouse cursor will be used. - - + + - PopupMenu(Menu menu, Point pos) -> bool - Pops up the given menu at the specified coordinates, relative to this -window, and returns control when the user has dismissed the menu. If a -menu item is selected, the corresponding menu event is generated and -will be processed as usual. + PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool + Pops up the given menu at the specified coordinates, relative to this window, +and returns control when the user has dismissed the menu. If a menu item is +selected, the corresponding menu event is generated and will be processed as +usual. If the default position is given then the current position of the +mouse cursor will be used. - + - GetHandle() -> long + GetHandle(self) -> long 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. - HasScrollbar(int orient) -> bool + HasScrollbar(self, int orient) -> bool Does the window have the scrollbar for this orientation? - SetScrollbar(int orientation, int pos, int thumbvisible, int range, + SetScrollbar(self, int orientation, int position, int thumbSize, int range, bool refresh=True) Sets the scrollbar properties of a built-in scrollbar. + :param orientation: Determines the scrollbar whose page size is to + be set. May be wx.HORIZONTAL or wx.VERTICAL. - 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. + :param position: The position of the scrollbar in scroll units. - thumbSize: The size of the thumb, or visible portion of the + :param thumbSize: The size of the thumb, or visible portion of the scrollbar, in scroll units. - range: The maximum position of the scrollbar. + :param range: The maximum position of the scrollbar. - refresh: True to redraw the scrollbar, false otherwise. + :param refresh: True to redraw the scrollbar, false otherwise. + - - + + - SetScrollPos(int orientation, int pos, bool refresh=True) + SetScrollPos(self, int orientation, int pos, bool refresh=True) Sets the position of one of the built-in scrollbars. @@ -5008,41 +5496,40 @@ toplevel parent of the window. - GetScrollPos(int orientation) -> int + GetScrollPos(self, int orientation) -> int Returns the built-in scrollbar position. - GetScrollThumb(int orientation) -> int + GetScrollThumb(self, int orientation) -> int Returns the built-in scrollbar thumb size. - GetScrollRange(int orientation) -> int + GetScrollRange(self, int orientation) -> int Returns the built-in scrollbar range. - ScrollWindow(int dx, int dy, Rect rect=None) + ScrollWindow(self, int dx, int dy, Rect rect=None) 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. + :param dx: Amount to scroll horizontally. - dx: Amount to scroll horizontally. + :param dy: Amount to scroll vertically. - 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 + :param 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. @@ -5051,7 +5538,7 @@ it is rarely required to call this function from a user program. - ScrollLines(int lines) -> bool + ScrollLines(self, int lines) -> bool 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 @@ -5061,8 +5548,8 @@ already on top/bottom and nothing was done. - ScrollPages(int pages) -> bool - If the platform and window class supports it, scrolls the window by + ScrollPages(self, int pages) -> bool + 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. @@ -5071,23 +5558,23 @@ already on top/bottom and nothing was done. - LineUp() -> bool + LineUp(self) -> bool This is just a wrapper for ScrollLines(-1). - LineDown() -> bool + LineDown(self) -> bool This is just a wrapper for ScrollLines(1). - PageUp() -> bool + PageUp(self) -> bool This is just a wrapper for ScrollPages(-1). - PageDown() -> bool + PageDown(self) -> bool This is just a wrapper for ScrollPages(1). - SetHelpText(String text) + SetHelpText(self, String text) 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. @@ -5096,7 +5583,7 @@ wxHelpProvider implementation, and not in the window object itself. - SetHelpTextForId(String text) + SetHelpTextForId(self, String text) Associate this help text with all windows with the same id as this one. @@ -5104,31 +5591,31 @@ one. - GetHelpText() -> String + GetHelpText(self) -> String 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. - SetToolTipString(String tip) + SetToolTipString(self, String tip) Attach a tooltip to the window. - SetToolTip(ToolTip tip) + SetToolTip(self, ToolTip tip) Attach a tooltip to the window. - GetToolTip() -> ToolTip + GetToolTip(self) -> ToolTip get the associated tooltip or None if none - SetDropTarget(DropTarget dropTarget) + SetDropTarget(self, DropTarget dropTarget) Associates a drop target with this window. If the window already has a drop target, it is deleted. @@ -5136,11 +5623,11 @@ a drop target, it is deleted. - GetDropTarget() -> DropTarget + GetDropTarget(self) -> DropTarget Returns the associated drop target, which may be None. - SetConstraints(LayoutConstraints constraints) + SetConstraints(self, LayoutConstraints constraints) 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 @@ -5156,12 +5643,12 @@ effect. - GetConstraints() -> LayoutConstraints + GetConstraints(self) -> LayoutConstraints Returns a pointer to the window's layout constraints, or None if there are none. - SetAutoLayout(bool autoLayout) + SetAutoLayout(self, bool autoLayout) Determines whether the Layout function will be called automatically when the window is resized. It is called implicitly by SetSizer but if you use SetConstraints you should call it manually or otherwise the @@ -5171,18 +5658,18 @@ window layout won't be correctly updated when its size changes. - GetAutoLayout() -> bool + GetAutoLayout(self) -> bool Returns the current autoLayout setting - Layout() -> bool + Layout(self) -> bool 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. - SetSizer(Sizer sizer, bool deleteOld=True) + SetSizer(self, Sizer sizer, bool deleteOld=True) 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 @@ -5195,7 +5682,7 @@ non-NoneL and False otherwise. - SetSizerAndFit(Sizer sizer, bool deleteOld=True) + SetSizerAndFit(self, Sizer sizer, bool deleteOld=True) The same as SetSizer, except it also sets the size hints for the window based on the sizer's minimum size. @@ -5204,12 +5691,12 @@ window based on the sizer's minimum size. - GetSizer() -> Sizer + GetSizer(self) -> Sizer Return the sizer associated with the window by a previous call to SetSizer or None if there isn't one. - SetContainingSizer(Sizer sizer) + SetContainingSizer(self, Sizer sizer) 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. @@ -5218,9 +5705,45 @@ the window can remove itself from the sizer when it is destroyed. - GetContainingSizer() -> Sizer + GetContainingSizer(self) -> Sizer Return the sizer that this window is a member of, if any, otherwise None. + + InheritAttributes(self) + 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 +SetOwnFont) and if the corresponding attribute hadn't been +explicitly set for this window itself, then this window takes the same +value as used by the parent. In addition, if the window overrides +ShouldInheritColours to return false, the colours will not be changed +no matter what and only the font might. + +This rather complicated logic is necessary in order to accommodate 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. + + + + ShouldInheritColours(self) -> bool + 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. + def DLG_PNT(win, point_or_x, y=None): @@ -5290,31 +5813,31 @@ hierarchy. The search is recursive in both cases. #--------------------------------------------------------------------------- - + - __init__() -> Validator + __init__(self) -> Validator - Clone() -> Validator + Clone(self) -> Validator - Validate(Window parent) -> bool + Validate(self, Window parent) -> bool - TransferToWindow() -> bool + TransferToWindow(self) -> bool - TransferFromWindow() -> bool + TransferFromWindow(self) -> bool - GetWindow() -> Window + GetWindow(self) -> Window - SetWindow(Window window) + SetWindow(self, Window window) @@ -5329,13 +5852,13 @@ hierarchy. The search is recursive in both cases. - + - __init__() -> PyValidator + __init__(self) -> PyValidator - _setCallbackInfo(PyObject self, PyObject _class, int incref=True) + _setCallbackInfo(self, PyObject self, PyObject _class, int incref=True) @@ -5346,17 +5869,17 @@ hierarchy. The search is recursive in both cases. #--------------------------------------------------------------------------- - + - __init__(String title=EmptyString, long style=0) -> Menu + __init__(self, String title=EmptyString, long style=0) -> Menu - Append(int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem + Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem @@ -5365,10 +5888,10 @@ hierarchy. The search is recursive in both cases. - AppendSeparator() -> MenuItem + AppendSeparator(self) -> MenuItem - AppendCheckItem(int id, String text, String help=EmptyString) -> MenuItem + AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem @@ -5376,7 +5899,7 @@ hierarchy. The search is recursive in both cases. - AppendRadioItem(int id, String text, String help=EmptyString) -> MenuItem + AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem @@ -5384,7 +5907,7 @@ hierarchy. The search is recursive in both cases. - AppendMenu(int id, String text, Menu submenu, String help=EmptyString) -> MenuItem + AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem @@ -5393,23 +5916,23 @@ hierarchy. The search is recursive in both cases. - AppendItem(MenuItem item) -> MenuItem + AppendItem(self, MenuItem item) -> MenuItem - Break() + Break(self) - InsertItem(size_t pos, MenuItem item) -> MenuItem + InsertItem(self, size_t pos, MenuItem item) -> MenuItem - Insert(size_t pos, int id, String text, String help=EmptyString, + Insert(self, size_t pos, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem @@ -5420,13 +5943,13 @@ hierarchy. The search is recursive in both cases. - InsertSeparator(size_t pos) -> MenuItem + InsertSeparator(self, size_t pos) -> MenuItem - InsertCheckItem(size_t pos, int id, String text, String help=EmptyString) -> MenuItem + InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem @@ -5435,7 +5958,7 @@ hierarchy. The search is recursive in both cases. - InsertRadioItem(size_t pos, int id, String text, String help=EmptyString) -> MenuItem + InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem @@ -5444,7 +5967,7 @@ hierarchy. The search is recursive in both cases. - InsertMenu(size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem + InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem @@ -5454,13 +5977,13 @@ hierarchy. The search is recursive in both cases. - PrependItem(MenuItem item) -> MenuItem + PrependItem(self, MenuItem item) -> MenuItem - Prepend(int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem + Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem @@ -5469,10 +5992,10 @@ hierarchy. The search is recursive in both cases. - PrependSeparator() -> MenuItem + PrependSeparator(self) -> MenuItem - PrependCheckItem(int id, String text, String help=EmptyString) -> MenuItem + PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem @@ -5480,7 +6003,7 @@ hierarchy. The search is recursive in both cases. - PrependRadioItem(int id, String text, String help=EmptyString) -> MenuItem + PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem @@ -5488,7 +6011,7 @@ hierarchy. The search is recursive in both cases. - PrependMenu(int id, String text, Menu submenu, String help=EmptyString) -> MenuItem + PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem @@ -5497,204 +6020,204 @@ hierarchy. The search is recursive in both cases. - Remove(int id) -> MenuItem + Remove(self, int id) -> MenuItem - RemoveItem(MenuItem item) -> MenuItem + RemoveItem(self, MenuItem item) -> MenuItem - Delete(int id) -> bool + Delete(self, int id) -> bool - DeleteItem(MenuItem item) -> bool + DeleteItem(self, MenuItem item) -> bool - Destroy() + Destroy(self) Deletes the C++ object this Python object is a proxy for. - DestroyId(int id) -> bool + DestroyId(self, int id) -> bool Deletes the C++ object this Python object is a proxy for. - DestroyItem(MenuItem item) -> bool + DestroyItem(self, MenuItem item) -> bool Deletes the C++ object this Python object is a proxy for. - GetMenuItemCount() -> size_t + GetMenuItemCount(self) -> size_t - GetMenuItems() -> PyObject + GetMenuItems(self) -> PyObject - FindItem(String item) -> int + FindItem(self, String item) -> int - FindItemById(int id) -> MenuItem + FindItemById(self, int id) -> MenuItem - FindItemByPosition(size_t position) -> MenuItem + FindItemByPosition(self, size_t position) -> MenuItem - Enable(int id, bool enable) + Enable(self, int id, bool enable) - IsEnabled(int id) -> bool + IsEnabled(self, int id) -> bool - Check(int id, bool check) + Check(self, int id, bool check) - IsChecked(int id) -> bool + IsChecked(self, int id) -> bool - SetLabel(int id, String label) + SetLabel(self, int id, String label) - GetLabel(int id) -> String + GetLabel(self, int id) -> String - SetHelpString(int id, String helpString) + SetHelpString(self, int id, String helpString) - GetHelpString(int id) -> String + GetHelpString(self, int id) -> String - SetTitle(String title) + SetTitle(self, String title) - GetTitle() -> String + GetTitle(self) -> String - SetEventHandler(EvtHandler handler) + SetEventHandler(self, EvtHandler handler) - GetEventHandler() -> EvtHandler + GetEventHandler(self) -> EvtHandler - SetInvokingWindow(Window win) + SetInvokingWindow(self, Window win) - GetInvokingWindow() -> Window + GetInvokingWindow(self) -> Window - GetStyle() -> long + GetStyle(self) -> long - UpdateUI(EvtHandler source=None) + UpdateUI(self, EvtHandler source=None) - GetMenuBar() -> MenuBar + GetMenuBar(self) -> MenuBar - Attach(wxMenuBarBase menubar) + Attach(self, wxMenuBarBase menubar) - Detach() + Detach(self) - IsAttached() -> bool + IsAttached(self) -> bool - SetParent(Menu parent) + SetParent(self, Menu parent) - GetParent() -> Menu + GetParent(self) -> Menu #--------------------------------------------------------------------------- - + - __init__(long style=0) -> MenuBar + __init__(self, long style=0) -> MenuBar - Append(Menu menu, String title) -> bool + Append(self, Menu menu, String title) -> bool - Insert(size_t pos, Menu menu, String title) -> bool + Insert(self, size_t pos, Menu menu, String title) -> bool @@ -5702,16 +6225,16 @@ hierarchy. The search is recursive in both cases. - GetMenuCount() -> size_t + GetMenuCount(self) -> size_t - GetMenu(size_t pos) -> Menu + GetMenu(self, size_t pos) -> Menu - Replace(size_t pos, Menu menu, String title) -> Menu + Replace(self, size_t pos, Menu menu, String title) -> Menu @@ -5719,136 +6242,136 @@ hierarchy. The search is recursive in both cases. - Remove(size_t pos) -> Menu + Remove(self, size_t pos) -> Menu - EnableTop(size_t pos, bool enable) + EnableTop(self, size_t pos, bool enable) - IsEnabledTop(size_t pos) -> bool + IsEnabledTop(self, size_t pos) -> bool - SetLabelTop(size_t pos, String label) + SetLabelTop(self, size_t pos, String label) - GetLabelTop(size_t pos) -> String + GetLabelTop(self, size_t pos) -> String - FindMenuItem(String menu, String item) -> int + FindMenuItem(self, String menu, String item) -> int - FindItemById(int id) -> MenuItem + FindItemById(self, int id) -> MenuItem - FindMenu(String title) -> int + FindMenu(self, String title) -> int - Enable(int id, bool enable) + Enable(self, int id, bool enable) - Check(int id, bool check) + Check(self, int id, bool check) - IsChecked(int id) -> bool + IsChecked(self, int id) -> bool - IsEnabled(int id) -> bool + IsEnabled(self, int id) -> bool - SetLabel(int id, String label) + SetLabel(self, int id, String label) - GetLabel(int id) -> String + GetLabel(self, int id) -> String - SetHelpString(int id, String helpString) + SetHelpString(self, int id, String helpString) - GetHelpString(int id) -> String + GetHelpString(self, int id) -> String - GetFrame() -> wxFrame + GetFrame(self) -> wxFrame - IsAttached() -> bool + IsAttached(self) -> bool - Attach(wxFrame frame) + Attach(self, wxFrame frame) - Detach() + Detach(self) #--------------------------------------------------------------------------- - + - __init__(Menu parentMenu=None, int id=ID_SEPARATOR, String text=EmptyString, + __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString, String help=EmptyString, int kind=ITEM_NORMAL, Menu subMenu=None) -> MenuItem - + @@ -5856,37 +6379,37 @@ hierarchy. The search is recursive in both cases. - GetMenu() -> Menu + GetMenu(self) -> Menu - SetMenu(Menu menu) + SetMenu(self, Menu menu) - SetId(int id) + SetId(self, int id) - GetId() -> int + GetId(self) -> int - IsSeparator() -> bool + IsSeparator(self) -> bool - SetText(String str) + SetText(self, String str) - GetLabel() -> String + GetLabel(self) -> String - GetText() -> String + GetText(self) -> String GetLabelFromText(String text) -> String @@ -5895,64 +6418,70 @@ hierarchy. The search is recursive in both cases. - GetKind() -> int + GetKind(self) -> int + + + SetKind(self, int kind) + + + - SetCheckable(bool checkable) + SetCheckable(self, bool checkable) - IsCheckable() -> bool + IsCheckable(self) -> bool - IsSubMenu() -> bool + IsSubMenu(self) -> bool - SetSubMenu(Menu menu) + SetSubMenu(self, Menu menu) - GetSubMenu() -> Menu + GetSubMenu(self) -> Menu - Enable(bool enable=True) + Enable(self, bool enable=True) - IsEnabled() -> bool + IsEnabled(self) -> bool - Check(bool check=True) + Check(self, bool check=True) - IsChecked() -> bool + IsChecked(self) -> bool - Toggle() + Toggle(self) - SetHelp(String str) + SetHelp(self, String str) - GetHelp() -> String + GetHelp(self) -> String - GetAccel() -> AcceleratorEntry + GetAccel(self) -> AcceleratorEntry - SetAccel(AcceleratorEntry accel) + SetAccel(self, AcceleratorEntry accel) @@ -5961,33 +6490,33 @@ hierarchy. The search is recursive in both cases. GetDefaultMarginWidth() -> int - SetBitmap(Bitmap bitmap) + SetBitmap(self, Bitmap bitmap) - GetBitmap() -> Bitmap + GetBitmap(self) -> Bitmap #--------------------------------------------------------------------------- - + 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. +A control is generally a small window which processes user input +and/or displays one or more item of data. - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, Validator validator=DefaultValidator, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, String name=ControlNameStr) -> Control - Create a Control. Normally you should only call this from a -subclass' __init__ as a plain old wx.Control is not very useful. + Create a Control. Normally you should only call this from a subclass' +__init__ as a plain old wx.Control is not very useful. - + @@ -6000,13 +6529,13 @@ subclass' __init__ as a plain old wx.Control is not very useful. Precreate a Control control for 2-phase creation - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, Validator validator=DefaultValidator, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, String name=ControlNameStr) -> bool Do the 2nd phase and create the GUI control. - + @@ -6015,65 +6544,83 @@ subclass' __init__ as a plain old wx.Control is not very useful. - Command(CommandEvent event) - Simulates the effect of the user issuing a command to the -item. See wxCommandEvent. + Command(self, CommandEvent event) + Simulates the effect of the user issuing a command to the item. + +:see: `wx.CommandEvent` + - GetLabel() -> String + GetLabel(self) -> String Return a control's text. - SetLabel(String label) + SetLabel(self, String label) Sets the item's text. + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + 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. - Append(String item, PyObject clientData=None) -> int - 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). + Append(self, String item, PyObject clientData=None) -> int + 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). - AppendItems(wxArrayString strings) - Apend several items at once to the control. Notice that calling -this method may be much faster than appending the items one by -one if you need to add a lot of items. + AppendItems(self, List strings) + Apend several items at once to the control. Notice that calling this +method may be much faster than appending the items one by one if you +need to add a lot of items. - Insert(String item, int pos, PyObject clientData=None) -> int - Insert an item into the control before the item at the pos index, + Insert(self, String item, int pos, PyObject clientData=None) -> int + Insert an item into the control before the item at the ``pos`` index, optionally associating some data object with the item. @@ -6082,39 +6629,39 @@ optionally associating some data object with the item. - Clear() + Clear(self) Removes all items from the control. - Delete(int n) - 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. + Delete(self, int n) + Deletes the item at the zero-based index 'n' from the control. Note +that it is an error (signalled by a `wx.PyAssertionError` exception if +enabled) to remove an item with the index negative or greater or equal +than the number of items in the control. - GetCount() -> int + GetCount(self) -> int Returns the number of items in the control. - IsEmpty() -> bool + IsEmpty(self) -> bool Returns True if the control is empty or False if it has some items. - GetString(int n) -> String + GetString(self, int n) -> String Returns the label of the item with the given index. - GetStrings() -> wxArrayString + GetStrings(self) -> wxArrayString - SetString(int n, String s) + SetString(self, int n, String s) Sets the label for the given item. @@ -6122,38 +6669,40 @@ or greater or equal than the number of items in the control. - FindString(String s) -> int + FindString(self, String s) -> int 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. +zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not +found. - Select(int n) + Select(self, int n) Sets the item at index 'n' to be the selected item. - GetSelection() -> int - Returns the index of the selected item or wx.NOT_FOUND if no item is selected. + GetSelection(self) -> int + Returns the index of the selected item or ``wx.NOT_FOUND`` if no item +is selected. - GetStringSelection() -> String - Returns the label of the selected item or an empty string if no item is selected. + GetStringSelection(self) -> String + Returns the label of the selected item or an empty string if no item +is selected. - GetClientData(int n) -> PyObject + GetClientData(self, int n) -> PyObject Returns the client data associated with the given item, (if any.) - SetClientData(int n, PyObject clientData) + SetClientData(self, int n, PyObject clientData) Associate the given client data with the item at position n. @@ -6164,196 +6713,389 @@ was not found. #--------------------------------------------------------------------------- - - 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. + + 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. #--------------------------------------------------------------------------- - + + 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` - __init__() -> SizerItem + __init__(self) -> SizerItem + Constructs an empty wx.SizerItem. Either a window, sizer or spacer +size will need to be set before this item can be used in a Sizer. + +You will probably never need to create a wx.SizerItem directly as they +are created automatically when the sizer's Add, Insert or Prepend +methods are called. + +:see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer` - - SizerItemSpacer(int width, int height, int proportion, int flag, int border, - Object userData) -> SizerItem + + SizerItemWindow(Window window, int proportion, int flag, int border, + PyObject userData=None) -> SizerItem + Constructs a `wx.SizerItem` for tracking a window. - - + - + - - SizerItemWindow(Window window, int proportion, int flag, int border, - Object userData) -> SizerItem + + SizerItemSpacer(int width, int height, int proportion, int flag, int border, + PyObject userData=None) -> SizerItem + Constructs a `wx.SizerItem` for tracking a spacer. - + + - + SizerItemSizer(Sizer sizer, int proportion, int flag, int border, - Object userData) -> SizerItem + PyObject userData=None) -> SizerItem + Constructs a `wx.SizerItem` for tracking a subsizer - + - DeleteWindows() + DeleteWindows(self) + Destroy the window or the windows in a subsizer, depending on the type +of item. - DetachSizer() + DetachSizer(self) + Enable deleting the SizerItem without destroying the contained sizer. - GetSize() -> Size + GetSize(self) -> Size + Get the current size of the item, as set in the last Layout. - CalcMin() -> Size + CalcMin(self) -> Size + Calculates the minimum desired size for the item, including any space +needed by borders. - SetDimension(Point pos, Size size) + SetDimension(self, Point pos, Size size) + Set the position and size of the space allocated for this item by the +sizer, and adjust the position and size of the item (window or +subsizer) to be within that space taking alignment and borders into +account. - GetMinSize() -> Size + GetMinSize(self) -> Size + Get the minimum size needed for the item. + + + GetMinSizeWithBorder(self) -> Size + Get the minimum size needed for the item with space for the borders +added, if needed. - SetInitSize(int x, int y) + SetInitSize(self, int x, int y) - SetRatioWH(int width, int height) + SetRatioWH(self, int width, int height) + Set the ratio item attribute. - SetRatioSize(Size size) + SetRatioSize(self, Size size) + Set the ratio item attribute. - SetRatio(float ratio) + SetRatio(self, float ratio) + Set the ratio item attribute. - GetRatio() -> float + GetRatio(self) -> float + Set the ratio item attribute. - IsWindow() -> bool + IsWindow(self) -> bool + Is this sizer item a window? - IsSizer() -> bool + IsSizer(self) -> bool + Is this sizer item a subsizer? - IsSpacer() -> bool + IsSpacer(self) -> bool + Is this sizer item a spacer? - SetProportion(int proportion) + SetProportion(self, int proportion) + Set the proportion value for this item. - GetProportion() -> int + GetProportion(self) -> int + Get the proportion value for this item. - SetFlag(int flag) + SetFlag(self, int flag) + Set the flag value for this item. - GetFlag() -> int + GetFlag(self) -> int + Get the flag value for this item. - SetBorder(int border) + SetBorder(self, int border) + Set the border value for this item. - GetBorder() -> int + GetBorder(self) -> int + Get the border value for this item. - GetWindow() -> Window + GetWindow(self) -> Window + Get the window (if any) that is managed by this sizer item. - SetWindow(Window window) + SetWindow(self, Window window) + Set the window to be managed by this sizer item. - GetSizer() -> Sizer + GetSizer(self) -> Sizer + Get the subsizer (if any) that is managed by this sizer item. - SetSizer(Sizer sizer) + SetSizer(self, Sizer sizer) + Set the subsizer to be managed by this sizer item. - GetSpacer() -> Size + GetSpacer(self) -> Size + Get the size of the spacer managed by this sizer item. - SetSpacer(Size size) + SetSpacer(self, Size size) + Set the size of the spacer to be managed by this sizer item. - Show(bool show) + Show(self, bool show) + Set the show item attribute, which sizers use to determine if the item +is to be made part of the layout or not. If the item is tracking a +window then it is shown or hidden as needed. - IsShown() -> bool + IsShown(self) -> bool + Is the item to be shown in the layout? - GetPosition() -> Point + GetPosition(self) -> Point + Returns the current position of the item, as set in the last Layout. - GetUserData() -> PyObject - - - + GetUserData(self) -> PyObject + Returns the userData associated with this sizer item, or None if there +isn't any. + + + + 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. + +:note: If you wish to create a custom sizer class in wxPython you + should derive the class from `wx.PySizer` in order to get + Python-aware capabilities for the various virtual methods. + +:see: `wx.SizerItem` + +:todo: More dscriptive text here along with some pictures... + + - _setOORInfo(PyObject _self) + _setOORInfo(self, PyObject _self) - Add(PyObject item, int proportion=0, int flag=0, int border=0, + Add(self, item, int proportion=0, int flag=0, int border=0, PyObject userData=None) + Appends a child item to the sizer. + + :param item: The item can be one of three kinds of objects: + + - **window**: A `wx.Window` to be managed by the sizer. Its + minimal size (either set explicitly by the user or + calculated internally when constructed with wx.DefaultSize) + is interpreted as the minimal size to use when laying out + item in the sizer. This is particularly useful in + connection with `wx.Window.SetSizeHints`. + + - **sizer**: The (child-)sizer to be added to the sizer. This + allows placing a child sizer in a sizer and thus to create + hierarchies of sizers (typically a vertical box as the top + sizer and several horizontal boxes on the level beneath). + + - **size**: A `wx.Size` or a 2-element sequence of integers + that represents the width and height of a spacer to be added + to the sizer. Adding spacers to sizers gives more + flexibility in the design of dialogs; imagine for example a + horizontal box with two buttons at the bottom of a dialog: + you might want to insert a space between the two buttons and + make that space stretchable using the *proportion* value and + the result will be that the left button will be aligned with + the left side of the dialog and the right button with the + right side - the space in between will shrink and grow with + the dialog. + + :param proportion: Although the meaning of this parameter is + undefined in wx.Sizer, it is used in `wx.BoxSizer` to indicate + if a child of a sizer can change its size in the main + orientation of the wx.BoxSizer - where 0 stands for not + changeable and a value of more than zero is interpreted + relative (a proportion of the total) to the value of other + children of the same wx.BoxSizer. For example, you might have + a horizontal wx.BoxSizer with three children, two of which are + supposed to change their size with the sizer. Then the two + stretchable windows should each be given *proportion* value of + 1 to make them grow and shrink equally with the sizer's + horizontal dimension. But if one of them had a *proportion* + value of 2 then it would get a double share of the space + available after the fixed size items are positioned. + + :param flag: This parameter can be used to set a number of flags + which can be combined using the binary OR operator ``|``. Two + main behaviours are defined using these flags. One is the + border around a window: the *border* parameter determines the + border width whereas the flags given here determine which + side(s) of the item that the border will be added. The other + flags determine how the sizer item behaves when the space + allotted to the sizer changes, and is somewhat dependent on + the specific kind of sizer used. + + +----------------------------+------------------------------------------+ + |- wx.TOP |These flags are used to specify | + |- wx.BOTTOM |which side(s) of the sizer item that | + |- wx.LEFT |the *border* width will apply to. | + |- wx.RIGHT | | + |- wx.ALL | | + | | | + +----------------------------+------------------------------------------+ + |- wx.EXAPAND |The item will be expanded to fill | + | |the space allotted to the item. | + +----------------------------+------------------------------------------+ + |- wx.SHAPED |The item will be expanded as much as | + | |possible while also maintaining its | + | |aspect ratio | + +----------------------------+------------------------------------------+ + |- wx.FIXED_MINSIZE |Normally wx.Sizers will use | + | |`wx.Window.GetMinSize` or | + | |`wx.Window.GetBestSize` to determine what | + | |the minimal size of window items should | + | |be, and will use that size to calculate | + | |the layout. This allows layouts to adjust | + | |when an item changes and it's best size | + | |becomes different. If you would rather | + | |have a window item stay the size it | + | |started with then use wx.FIXED_MINSIZE. | + +----------------------------+------------------------------------------+ + |- wx.ALIGN_CENTER |The wx.ALIGN flags allow you to specify | + |- wx.ALIGN_LEFT |the alignment of the item within the space| + |- wx.ALIGN_RIGHT |allotted to it by the sizer, ajusted for | + |- wx.ALIGN_TOP |the border if any. | + |- wx.ALIGN_BOTTOM | | + |- wx.ALIGN_CENTER_VERTICAL | | + |- wx.ALIGN_CENTER_HORIZONTAL| | + +----------------------------+------------------------------------------+ + + + :param border: Determines the border width, if the *flag* + parameter is set to include any border flag. + + :param userData: Allows an extra object to be attached to the + sizer item, for use in derived classes when sizing information + is more complex than the *proportion* and *flag* will allow for. + @@ -6363,8 +7105,10 @@ controls that have items. - Insert(int before, PyObject item, int proportion=0, int flag=0, - int border=0, PyObject userData=None) + Insert(self, int before, item, int proportion=0, int flag=0, int border=0, + PyObject userData=None) + 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. @@ -6375,8 +7119,10 @@ controls that have items. - Prepend(PyObject item, int proportion=0, int flag=0, int border=0, + Prepend(self, item, int proportion=0, int flag=0, int border=0, PyObject userData=None) + 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. @@ -6386,39 +7132,69 @@ controls that have items. - Remove(PyObject item) -> bool + Remove(self, item) -> bool + Removes an item from the sizer and destroys it. This method does not +cause any layout or resizing to take place, call `Layout` to update +the layout on screen after removing a child from the sizer. The +*item* parameter can be either a window, a sizer, or the zero-based +index of an item to remove. Returns True if the child item was found +and removed. + +:note: For historical reasons calling this method with a `wx.Window` + parameter is depreacted, as it will not be able to destroy the + window since it is owned by its parent. You should use `Detach` + instead. + + + + + + + Detach(self, item) -> bool + Detaches an item from the sizer without destroying it. This method +does not cause any layout or resizing to take place, call `Layout` to +do so. The *item* parameter can be either a window, a sizer, or the +zero-based index of the item to be detached. Returns True if the child item +was found and detached. - _SetItemMinSize(PyObject item, Size size) + _SetItemMinSize(self, PyObject item, Size size) - AddItem(SizerItem item) + AddItem(self, SizerItem item) + Adds a `wx.SizerItem` to the sizer. - InsertItem(size_t index, SizerItem item) + InsertItem(self, int index, SizerItem item) + Inserts a `wx.SizerItem` to the sizer at the position given by *index*. - PrependItem(SizerItem item) + PrependItem(self, SizerItem item) + Prepends a `wx.SizerItem` to the sizer. - SetDimension(int x, int y, int width, int height) + SetDimension(self, int x, int y, int width, int height) + Call this to force the sizer to take the given dimension and thus +force the items owned by the sizer to resize themselves according to +the rules defined by the parameter in the `Add`, `Insert` or `Prepend` +methods. @@ -6427,98 +7203,193 @@ controls that have items. - SetMinSize(Size size) + SetMinSize(self, Size size) + Call this to give the sizer a minimal size. Normally, the sizer will +calculate its minimal size based purely on how much space its children +need. After calling this method `GetMinSize` will return either the +minimal size as requested by its children or the minimal size set +here, depending on which is bigger. - GetSize() -> Size + GetSize(self) -> Size + Returns the current size of the space managed by the sizer. - GetPosition() -> Point + GetPosition(self) -> Point + Returns the current position of the sizer's managed space. - GetMinSize() -> Size + GetMinSize(self) -> Size + Returns the minimal size of the sizer. This is either the combined +minimal size of all the children and their borders or the minimal size +set by SetMinSize, depending on which is bigger. - RecalcSizes() + RecalcSizes(self) + Using the sizes calculated by `CalcMin` reposition and resize all the +items managed by this sizer. You should not need to call this directly as +it is called by `Layout`. - CalcMin() -> Size + CalcMin(self) -> Size + This method is where the sizer will do the actual calculation of its +children's minimal sizes. You should not need to call this directly as +it is called by `Layout`. - Layout() + Layout(self) + This method will force the recalculation and layout of the items +controlled by the sizer using the current space allocated to the +sizer. Normally this is called automatically from the owning window's +EVT_SIZE handler, but it is also useful to call it from user code when +one of the items in a sizer change size, or items are added or +removed. - Fit(Window window) -> Size + Fit(self, Window window) -> Size + Tell the sizer to resize the *window* to match the sizer's minimal +size. This is commonly done in the constructor of the window itself in +order to set its initial size to match the needs of the children as +determined by the sizer. Returns the new size. + +For a top level window this is the total window size, not the client size. - FitInside(Window window) + FitInside(self, Window window) + Tell the sizer to resize the *virtual size* of the *window* to match the +sizer's minimal size. This will not alter the on screen size of the +window, but may cause the addition/removal/alteration of scrollbars +required to view the virtual area in windows which manage it. + +:see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints` + - SetSizeHints(Window window) + SetSizeHints(self, Window window) + Tell the sizer to set (and `Fit`) the minimal size of the *window* to +match the sizer's minimal size. This is commonly done in the +constructor of the window itself if the window is resizable (as are +many dialogs under Unix and frames on probably all platforms) in order +to prevent the window from being sized smaller than the minimal size +required by the sizer. - SetVirtualSizeHints(Window window) + SetVirtualSizeHints(self, Window window) + Tell the sizer to set the minimal size of the window virtual area to +match the sizer's minimal size. For windows with managed scrollbars +this will set them appropriately. + +:see: `wx.ScrolledWindow.SetScrollbars` + - Clear(bool delete_windows=False) + Clear(self, bool deleteWindows=False) + Clear all items from the sizer, optionally destroying the window items +as well. - + - DeleteWindows() + DeleteWindows(self) + Destroy all windows managed by the sizer. - GetChildren() -> PyObject + GetChildren(sefl) -> list + Returns a list of all the `wx.SizerItem` objects managed by the sizer. - Show(PyObject item, bool show=True) + Show(self, item, bool show=True) + 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. - - Hide(PyObject item) - - - - - IsShown(PyObject item) -> bool + IsShown(self, item) + 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. - ShowItems(bool show) + ShowItems(self, bool show) + Recursively call `wx.Window.Show` on all sizer items. - - + + 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` + + + - __init__() -> PySizer + __init__(self) -> PySizer + Creates a wx.PySizer. Must be called from the __init__ in the derived +class. - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) @@ -6528,59 +7399,101 @@ controls that have items. #--------------------------------------------------------------------------- - + + 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. + +It is the unique feature of a box sizer, that it can grow in both +directions (height and width) but can distribute its growth in the +main direction (horizontal for a row) *unevenly* among its children. +This is determined by the proportion parameter give to items when they +are added to the sizer. It is interpreted as a weight factor, i.e. it +can be zero, indicating that the window may not be resized at all, or +above zero. If several windows have a value above zero, the value is +interpreted relative to the sum of all weight factors of the sizer, so +when adding two windows with a value of 1, they will both get resized +equally and each will receive half of the available space after the +fixed size items have been sized. If the items have unequal +proportion settings then they will receive a coresondingly unequal +allotment of the free space. + +:see: `wx.StaticBoxSizer` + - __init__(int orient=HORIZONTAL) -> BoxSizer + __init__(self, int orient=HORIZONTAL) -> BoxSizer + Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL`` +or ``wx.HORIZONTAL`` for creating either a column sizer or a row +sizer. - GetOrientation() -> int + GetOrientation(self) -> int + Returns the current orientation of the sizer. - SetOrientation(int orient) + SetOrientation(self, int orient) + Resets the orientation of the sizer. - - RecalcSizes() - - - CalcMin() -> Size - #--------------------------------------------------------------------------- - + + 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. - __init__(wxStaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer + __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer + Constructor. It takes an associated static box and the orientation +*orient* as parameters - orient can be either of ``wx.VERTICAL`` or +``wx.HORIZONTAL``. - GetStaticBox() -> wxStaticBox - - - RecalcSizes() - - - CalcMin() -> Size + GetStaticBox(self) -> StaticBox + Returns the static box associated with this sizer. #--------------------------------------------------------------------------- - + + 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`. + - __init__(int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer + __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer + 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. @@ -6588,56 +7501,77 @@ controls that have items. - - RecalcSizes() - - - CalcMin() -> Size - - SetCols(int cols) + SetCols(self, int cols) + Sets the number of columns in the sizer. - SetRows(int rows) + SetRows(self, int rows) + Sets the number of rows in the sizer. - SetVGap(int gap) + SetVGap(self, int gap) + Sets the vertical gap (in pixels) between the cells in the sizer. - SetHGap(int gap) + SetHGap(self, int gap) + Sets the horizontal gap (in pixels) between cells in the sizer - GetCols() -> int + GetCols(self) -> int + Returns the number of columns in the sizer. - GetRows() -> int + GetRows(self) -> int + Returns the number of rows in the sizer. - GetVGap() -> int + GetVGap(self) -> int + Returns the vertical gap (in pixels) between the cells in the sizer. - GetHGap() -> int + GetHGap(self) -> int + Returns the horizontal gap (in pixels) between cells in the sizer. #--------------------------------------------------------------------------- - + + 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. + + - __init__(int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer + __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer + Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the +number of columns and rows in the sizer - if either of the parameters +is zero, it will be calculated to from the total number of children in +the sizer, thus making the sizer grow dynamically. *vgap* and *hgap* +define extra space between all children. @@ -6645,196 +7579,279 @@ controls that have items. - - RecalcSizes() - - - CalcMin() -> Size - - AddGrowableRow(size_t idx, int proportion=0) + AddGrowableRow(self, size_t idx, int proportion=0) + Specifies that row *idx* (starting from zero) should be grown if there +is extra space available to the sizer. + +The *proportion* parameter has the same meaning as the stretch factor +for the box sizers except that if all proportions are 0, then all +columns are resized equally (instead of not being resized at all). - RemoveGrowableRow(size_t idx) + RemoveGrowableRow(self, size_t idx) + Specifies that row *idx* is no longer growable. - AddGrowableCol(size_t idx, int proportion=0) + AddGrowableCol(self, size_t idx, int proportion=0) + Specifies that column *idx* (starting from zero) should be grown if +there is extra space available to the sizer. + +The *proportion* parameter has the same meaning as the stretch factor +for the box sizers except that if all proportions are 0, then all +columns are resized equally (instead of not being resized at all). - RemoveGrowableCol(size_t idx) + RemoveGrowableCol(self, size_t idx) + Specifies that column *idx* is no longer growable. - SetFlexibleDirection(int direction) + SetFlexibleDirection(self, int direction) + Specifies whether the sizer should flexibly resize its columns, rows, +or both. Argument *direction* can be one of the following values. Any +other value is ignored. + + ============== ======================================= + wx.VERTICAL Rows are flexibly sized. + wx.HORIZONTAL Columns are flexibly sized. + wx.BOTH Both rows and columns are flexibly sized + (this is the default value). + ============== ======================================= + +Note that this method does not trigger relayout. + - GetFlexibleDirection() -> int + GetFlexibleDirection(self) -> int + Returns a value that specifies whether the sizer +flexibly resizes its columns, rows, or both (default). + +:see: `SetFlexibleDirection` - SetNonFlexibleGrowMode(int mode) + SetNonFlexibleGrowMode(self, int mode) + Specifies how the sizer should grow in the non-flexible direction if +there is one (so `SetFlexibleDirection` must have been called +previously). Argument *mode* can be one of the following values: + + ========================== ================================================= + wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction. + wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with + `AddGrowableCol` and `AddGrowableRow`. In this + case equal sizing applies to minimum sizes of + columns or rows (this is the default value). + wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in + the non flexible direction, whether they are + growable or not in the flexbile direction. + ========================== ================================================= + +Note that this method does not trigger relayout. + + - GetNonFlexibleGrowMode() -> int + GetNonFlexibleGrowMode(self) -> int + Returns the value that specifies how the sizer grows in the +non-flexible direction if there is one. + +:see: `SetNonFlexibleGrowMode` - GetRowHeights() -> wxArrayInt + GetRowHeights(self) -> list + Returns a list of integers representing the heights of each of the +rows in the sizer. - GetColWidths() -> wxArrayInt + GetColWidths(self) -> list + Returns a list of integers representing the widths of each of the +columns in the sizer. #--------------------------------------------------------------------------- - + + 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. - __init__(int row=0, int col=0) -> GBPosition + __init__(self, int row=0, int col=0) -> GBPosition + This class represents the position of an item in a virtual grid of +rows and columns managed by a `wx.GridBagSizer`. wxPython has +typemaps that will automatically convert from a 2-element sequence of +integers to a wx.GBPosition, so you can use the more pythonic +representation of the position nearly transparently in Python code. - GetRow() -> int + GetRow(self) -> int - GetCol() -> int + GetCol(self) -> int - SetRow(int row) + SetRow(self, int row) - SetCol(int col) + SetCol(self, int col) - __eq__(GBPosition other) -> bool + __eq__(self, GBPosition other) -> bool - __ne__(GBPosition other) -> bool + __ne__(self, GBPosition other) -> bool - Set(int row=0, int col=0) + Set(self, int row=0, int col=0) - Get() -> PyObject + Get(self) -> PyObject - + + 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. + - __init__(int rowspan=1, int colspan=1) -> GBSpan + __init__(self, int rowspan=1, int colspan=1) -> GBSpan + Construct a new wxGBSpan, optionally setting the rowspan and +colspan. The default is (1,1). (Meaning that the item occupies one +cell in each direction. - GetRowspan() -> int + GetRowspan(self) -> int - GetColspan() -> int + GetColspan(self) -> int - SetRowspan(int rowspan) + SetRowspan(self, int rowspan) - SetColspan(int colspan) + SetColspan(self, int colspan) - __eq__(GBSpan other) -> bool + __eq__(self, GBSpan other) -> bool - __ne__(GBSpan other) -> bool + __ne__(self, GBSpan other) -> bool - Set(int rowspan=1, int colspan=1) + Set(self, int rowspan=1, int colspan=1) - Get() -> PyObject + Get(self) -> PyObject - + + 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. + - __init__() -> GBSizerItem + __init__(self) -> GBSizerItem + Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer +size will need to be set, as well as a position and span before this +item can be used in a Sizer. + +You will probably never need to create a wx.GBSizerItem directly as they +are created automatically when the sizer's Add method is called. GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag, - int border, Object userData) -> GBSizerItem + int border, PyObject userData=None) -> GBSizerItem + Construct a `wx.GBSizerItem` for a window. - + GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag, - int border, Object userData) -> GBSizerItem + int border, PyObject userData=None) -> GBSizerItem + Construct a `wx.GBSizerItem` for a sizer - + GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span, - int flag, int border, Object userData) -> GBSizerItem + int flag, int border, PyObject userData=None) -> GBSizerItem + Construct a `wx.GBSizerItem` for a spacer. @@ -6842,69 +7859,97 @@ controls that have items. - + - GetPos() -> GBPosition + GetPos(self) -> GBPosition + Get the grid position of the item - GetSpan() -> GBSpan + GetSpan(self) -> GBSpan + Get the row and column spanning of the item - SetPos(GBPosition pos) -> bool + SetPos(self, GBPosition pos) -> bool + If the item is already a member of a sizer then first ensure that +there is no other item that would intersect with this one at the new +position, then set the new position. Returns True if the change is +successful and after the next Layout() the item will be moved. - SetSpan(GBSpan span) -> bool + SetSpan(self, GBSpan span) -> bool + If the item is already a member of a sizer then first ensure that +there is no other item that would intersect with this one with its new +spanning size, then set the new spanning. Returns True if the change +is successful and after the next Layout() the item will be resized. + - + + Intersects(self, GBSizerItem other) -> bool + Returns True if this item and the other item instersect. - - Intersects(GBSizerItem other) -> bool -Intersects(GBPosition pos, GBSpan span) -> bool + + IntersectsPos(self, GBPosition pos, GBSpan span) -> bool + Returns True if the given pos/span would intersect with this item. - - GetEndPos(int row, int col) - - - - + + GetEndPos(self) -> GBPosition + Get the row and column of the endpoint of this item. - GetGBSizer() -> GridBagSizer + GetGBSizer(self) -> GridBagSizer + Get the sizer this item is a member of. - SetGBSizer(GridBagSizer sizer) + SetGBSizer(self, GridBagSizer sizer) + Set the sizer this item is a member of. - + + 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. + - __init__(int vgap=0, int hgap=0) -> GridBagSizer + __init__(self, int vgap=0, int hgap=0) -> GridBagSizer + Constructor, with optional parameters to specify the gap between the +rows and columns. - Add(PyObject item, GBPosition pos, GBSpan span=DefaultSpan, - int flag=0, int border=0, PyObject userData=None) -> bool + Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0, +int border=0, userData=None) + 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. + @@ -6915,143 +7960,216 @@ Intersects(GBPosition pos, GBSpan span) -> bool - AddItem(GBSizerItem item) -> bool + Add(self, GBSizerItem item) -> bool + 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. - GetEmptyCellSize() -> Size + GetEmptyCellSize(self) -> Size + Get the size used for cells in the grid with no item. - SetEmptyCellSize(Size sz) + SetEmptyCellSize(self, Size sz) + Set the size used for cells in the grid with no item. + 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. + 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. - GetItemPosition(Window window) -> GBPosition -GetItemPosition(Sizer sizer) -> GBPosition -GetItemPosition(size_t index) -> GBPosition + GetItemPosition(self, item) -> GBPosition + +Get the grid position of the specified *item* where *item* is either a +window or subsizer that is a member of this sizer, or a zero-based +index of an item. + 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. + + 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. + - SetItemPosition(Window window, GBPosition pos) -> bool -SetItemPosition(Sizer sizer, GBPosition pos) -> bool -SetItemPosition(size_t index, GBPosition pos) -> bool + SetItemPosition(self, item, GBPosition pos) -> bool + +Set the grid position of the specified *item* where *item* is either a +window or subsizer that is a member of this sizer, or a zero-based +index of an item. Returns True on success. If the move is not +allowed (because an item is already there) then False is returned. + + 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. + 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. - GetItemSpan(Window window) -> GBSpan -GetItemSpan(Sizer sizer) -> GBSpan -GetItemSpan(size_t index) -> GBSpan + GetItemSpan(self, item) -> GBSpan + +Get the row/col spanning of the specified *item* where *item* is +either a window or subsizer that is a member of this sizer, or a +zero-based index of an item. + 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. + 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. - SetItemSpan(Window window, GBSpan span) -> bool -SetItemSpan(Sizer sizer, GBSpan span) -> bool -SetItemSpan(size_t index, GBSpan span) -> bool + SetItemSpan(self, item, GBSpan span) -> bool + +Set the row/col spanning of the specified *item* where *item* is +either a window or subsizer that is a member of this sizer, or a +zero-based index of an item. Returns True on success. If the move is +not allowed (because an item is already there) then False is returned. + FindItem(self, item) -> GBSizerItem + +Find the sizer item for the given window or subsizer, returns None if +not found. (non-recursive) - FindItem(Window window) -> GBSizerItem -FindItem(Sizer sizer) -> GBSizerItem + FindItem(self, item) -> GBSizerItem + +Find the sizer item for the given window or subsizer, returns None if +not found. (non-recursive) - FindItemAtPosition(GBPosition pos) -> GBSizerItem + FindItemAtPosition(self, GBPosition pos) -> GBSizerItem + Return the sizer item for the given grid cell, or None if there is no +item at that position. (non-recursive) - FindItemAtPoint(Point pt) -> GBSizerItem + FindItemAtPoint(self, Point pt) -> GBSizerItem + 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) - - FindItemWithData(Object userData) -> GBSizerItem - - - - - - RecalcSizes() - - - CalcMin() -> Size - - + + CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool + 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. + - - CheckForIntersection(GBSizerItem item, GBSizerItem excludeItem=None) -> bool -CheckForIntersection(GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool + + CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool + Look at all items and see if any intersect (or would overlap) the +given position and span. Returns True if so, False if there would be +no overlap. If an *excludeItem* is given then it will not be checked +for intersection, for example it may be the item we are checking the +position of. @@ -7062,53 +8180,62 @@ CheckForIntersection(GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) #--------------------------------------------------------------------------- - - 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 + + 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. -Constraints are initially set to have the relationship wx.Unconstrained, which -means that their values should be calculated by looking at known constraints. +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 +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 + 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.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 + 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 + 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. + wx.Absolute The edge or dimension should be a given absolute value. + ================== ============================================== +:see: `wx.LayoutConstraints`, `wx.Window.SetConstraints` - Set(int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN) + Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN) + Sets the properties of the constraint. Normally called by one of the +convenience functions such as Above, RightOf, SameAs. @@ -7118,40 +8245,49 @@ using the more general Set function. - LeftOf(Window sibling, int marg=0) - Sibling relationship + LeftOf(self, Window sibling, int marg=0) + 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. - RightOf(Window sibling, int marg=0) - Sibling relationship + RightOf(self, Window sibling, int marg=0) + 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. - Above(Window sibling, int marg=0) - Sibling relationship + Above(self, Window sibling, int marg=0) + 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. - Below(Window sibling, int marg=0) - Sibling relationship + Below(self, Window sibling, int marg=0) + 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. - SameAs(Window otherW, int edge, int marg=0) - 'Same edge' alignment + SameAs(self, Window otherW, int edge, int marg=0) + Constrains this edge or dimension to be to the same as the edge of the +given window, with an optional margin. @@ -7159,8 +8295,9 @@ using the more general Set function. - PercentOf(Window otherW, int wh, int per) - The edge is a percentage of the other window's edge + PercentOf(self, Window otherW, int wh, int per) + Constrains this edge or dimension to be to a percentage of the given +window, with an optional margin. @@ -7168,83 +8305,89 @@ using the more general Set function. - Absolute(int val) - Edge has absolute value + Absolute(self, int val) + Constrains this edge or dimension to be the given absolute value. - Unconstrained() - Dimension is unconstrained + Unconstrained(self) + Sets this edge or dimension to be unconstrained, that is, dependent on +other edges and dimensions from which this value can be deduced. - AsIs() - Dimension is 'as is' (use current size settings) + AsIs(self) + 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. - GetOtherWindow() -> Window + GetOtherWindow(self) -> Window - GetMyEdge() -> int + GetMyEdge(self) -> int - SetEdge(int which) + SetEdge(self, int which) - SetValue(int v) + SetValue(self, int v) - GetMargin() -> int + GetMargin(self) -> int - SetMargin(int m) + SetMargin(self, int m) - GetValue() -> int + GetValue(self) -> int - GetPercent() -> int + GetPercent(self) -> int - GetOtherEdge() -> int + GetOtherEdge(self) -> int - GetDone() -> bool + GetDone(self) -> bool - SetDone(bool d) + SetDone(self, bool d) - GetRelationship() -> int + GetRelationship(self) -> int - SetRelationship(int r) + SetRelationship(self, int r) - ResetIfWin(Window otherW) -> bool + ResetIfWin(self, Window otherW) -> bool Reset constraint if it mentions otherWin - SatisfyConstraint(LayoutConstraints constraints, Window win) -> bool + SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool Try to satisfy constraint @@ -7252,7 +8395,7 @@ using the more general Set function. - GetEdge(int which, Window thisWin, Window other) -> int + GetEdge(self, int which, Window thisWin, Window other) -> int Get the value of this edge or dimension, or if this is not determinable, -1. @@ -7262,11 +8405,12 @@ is not determinable, -1. - - Note: constraints are now deprecated and you should use sizers instead. + + **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 @@ -7281,16 +8425,19 @@ directly to set the appropriate constraints. * 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` - __init__() -> LayoutConstraints + __init__(self) -> LayoutConstraints @@ -7308,7 +8455,7 @@ default size. If the constraint is wxAsIs, the dimension will not be changed. - AreSatisfied() -> bool + AreSatisfied(self) -> bool #---------------------------------------------------------------------------- @@ -7332,16 +8479,16 @@ __wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar' #---------------------------------------------------------------------------- # Load version numbers from __version__... Ensure that major and minor -# versions are the same for both wxPython and wxWindows. +# versions are the same for both wxPython and wxWidgets. from __version__ import * __version__ = VERSION_STRING -assert MAJOR_VERSION == _core.MAJOR_VERSION, "wxPython/wxWindows version mismatch" -assert MINOR_VERSION == _core.MINOR_VERSION, "wxPython/wxWindows version mismatch" -if RELEASE_VERSION != _core.RELEASE_VERSION: +assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch" +assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch" +if RELEASE_VERSION != _core_.RELEASE_VERSION: import warnings - warnings.warn("wxPython/wxWindows release number mismatch") + warnings.warn("wxPython/wxWidgets release number mismatch") #---------------------------------------------------------------------------- @@ -7377,7 +8524,7 @@ class PyUnbornObjectError(AttributeError): 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 @@ -7409,10 +8556,13 @@ def CallAfter(callable, *args, **kw): """ Call the specified function after the current and pending event handlers have been completed. This is also good for making GUI - method calls from non-GUI threads. + method calls from non-GUI threads. Any extra positional or + keyword args are passed on to the callable when it is called. + + :see: `wx.FutureCall` """ app = wx.GetApp() - assert app, 'No wxApp created yet' + assert app is not None, 'No wx.App created yet' global _wxPyCallAfterId if _wxPyCallAfterId is None: @@ -7435,7 +8585,7 @@ class FutureCall: 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 @@ -7443,6 +8593,8 @@ class FutureCall: 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 @@ -7526,84 +8678,117 @@ class FutureCall: 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() #---------------------------------------------------------------------------- #---------------------------------------------------------------------------- - - - wx = core + + + wx = _core #--------------------------------------------------------------------------- - + - __init__() -> GDIObject + __init__(self) -> GDIObject - __del__() + __del__(self) - GetVisible() -> bool + GetVisible(self) -> bool - SetVisible(bool visible) + SetVisible(self, bool visible) - IsNull() -> bool + IsNull(self) -> bool #--------------------------------------------------------------------------- - - 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. + + 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. +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`. + - __init__(unsigned char red=0, unsigned char green=0, unsigned char blue=0) -> Colour - Constructs a colour from red, green and blue values. + __init__(self, byte red=0, byte green=0, byte blue=0) -> Colour + Constructs a colour from red, green and blue values. + +:see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`. + - - - + + + NamedColour(String colorName) -> Colour - Constructs a colour object using a colour name listed in wx.TheColourDatabase. + Constructs a colour object using a colour name listed in +``wx.TheColourDatabase``. @@ -7616,63 +8801,64 @@ wx.SystemSettings.GetColour. - __del__() + __del__(self) - - Red() -> unsigned char + + Red(self) -> byte Returns the red intensity. - - Green() -> unsigned char + + Green(self) -> byte Returns the green intensity. - - Blue() -> unsigned char + + Blue(self) -> byte Returns the blue intensity. - Ok() -> bool + Ok(self) -> bool Returns True if the colour object is valid (the colour has been initialised with RGB values). - Set(unsigned char red, unsigned char green, unsigned char blue) + Set(self, byte red, byte green, byte blue) Sets the RGB intensity values. - - - + + + - SetRGB(unsigned long colRGB) + SetRGB(self, unsigned long colRGB) Sets the RGB intensity values from a packed RGB value. - SetFromName(String colourName) - Sets the RGB intensity values using a colour name listed in wx.TheColourDatabase. + SetFromName(self, String colourName) + Sets the RGB intensity values using a colour name listed in +``wx.TheColourDatabase``. - GetPixel() -> long + GetPixel(self) -> long 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). +COLORREF is returned. On X, an allocated pixel value is returned. -1 +is returned if the pixel is invalid (on X, unallocated). - __eq__(Colour colour) -> bool + __eq__(self, Colour colour) -> bool Compare colours for equality - __ne__(Colour colour) -> bool + __ne__(self, Colour colour) -> bool Compare colours for inequality @@ -7683,7 +8869,7 @@ COLORREF is returned. On X, an allocated pixel value is returned. Returns the RGB intensity values as a tuple. - GetRGB() -> unsigned long + GetRGB(self) -> unsigned long Return the colour as a packed RGB value @@ -7692,10 +8878,10 @@ COLORREF is returned. On X, an allocated pixel value is returned. NamedColor = NamedColour ColorRGB = ColourRGB - + - __init__(int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette + __init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette @@ -7704,10 +8890,10 @@ COLORREF is returned. On X, an allocated pixel value is returned. - __del__() + __del__(self) - GetPixel(byte red, byte green, byte blue) -> int + GetPixel(self, byte red, byte green, byte blue) -> int @@ -7724,16 +8910,16 @@ COLORREF is returned. On X, an allocated pixel value is returned. - Ok() -> bool + Ok(self) -> bool #--------------------------------------------------------------------------- - + - __init__(Colour colour, int width=1, int style=SOLID) -> Pen + __init__(self, Colour colour, int width=1, int style=SOLID) -> Pen @@ -7741,158 +8927,227 @@ COLORREF is returned. On X, an allocated pixel value is returned. - __del__() + __del__(self) - GetCap() -> int + GetCap(self) -> int - GetColour() -> Colour + GetColour(self) -> Colour - GetJoin() -> int + GetJoin(self) -> int - GetStyle() -> int + GetStyle(self) -> int - GetWidth() -> int + GetWidth(self) -> int - Ok() -> bool + Ok(self) -> bool - SetCap(int cap_style) + SetCap(self, int cap_style) - SetColour(Colour colour) + SetColour(self, Colour colour) - SetJoin(int join_style) + SetJoin(self, int join_style) - SetStyle(int style) + SetStyle(self, int style) - SetWidth(int width) + SetWidth(self, int width) - SetDashes(int dashes, wxDash dashes_array) + SetDashes(self, int dashes, wxDash dashes_array) - GetDashes() -> PyObject - - - __eq__(Pen other) -> bool - - - + GetDashes(self) -> PyObject - - __ne__(Pen other) -> bool + + _SetDashes(self, PyObject _self, PyObject pyDashes) - + + - GetDashCount() -> int + GetDashCount(self) -> int - - - - - __init__(Colour colour, int width=1, int style=SOLID) -> PyPen + + __eq__(self, Pen other) -> bool - - - + - - - __del__() - - - SetDashes(int dashes, wxDash dashes_array) + + + __ne__(self, Pen other) -> bool - - + - Pen = PyPen #--------------------------------------------------------------------------- - - 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. + + 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. + +:warning: Do not create instances of wx.Brush before the `wx.App` + object has been created because, depending on the platform, + required internal data structures may not have been initialized + yet. Instead create your brushes in the app's OnInit or as they + are needed for drawing. + +:note: On monochrome displays all brushes are white, unless the colour + really is black. + +:see: `wx.BrushList`, `wx.DC`, `wx.DC.SetBrush` + - __init__(Colour colour, int style=SOLID) -> Brush - Constructs a brush from a colour object and style. + __init__(self, Colour colour, int style=SOLID) -> Brush + Constructs a brush from a `wx.Colour` object and a style.The style parameter may be one of the following: + + =================== ============================= + Style Meaning + =================== ============================= + wx.TRANSPARENT Transparent (no fill). + wx.SOLID Solid. + wx.STIPPLE Uses a bitmap as a stipple. + wx.BDIAGONAL_HATCH Backward diagonal hatch. + wx.CROSSDIAG_HATCH Cross-diagonal hatch. + wx.FDIAGONAL_HATCH Forward diagonal hatch. + wx.CROSS_HATCH Cross hatch. + wx.HORIZONTAL_HATCH Horizontal hatch. + wx.VERTICAL_HATCH Vertical hatch. + =================== ============================= + + - __del__() + __del__(self) - SetColour(Colour col) + SetColour(self, Colour col) + Set the brush's `wx.Colour`. - SetStyle(int style) + SetStyle(self, int style) + Sets the style of the brush. See `__init__` for a listing of styles. - SetStipple(Bitmap stipple) + SetStipple(self, Bitmap stipple) + Sets the stipple `wx.Bitmap`. - GetColour() -> Colour + GetColour(self) -> Colour + Returns the `wx.Colour` of the brush. - GetStyle() -> int + GetStyle(self) -> int + Returns the style of the brush. See `__init__` for a listing of +styles. - GetStipple() -> Bitmap + GetStipple(self) -> Bitmap + 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). - Ok() -> bool + Ok(self) -> bool + Returns True if the brush is initialised and valid. - + + 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. + +The BMP and XMP image file formats are supported on all platforms by +wx.Bitmap. Other formats are automatically loaded by `wx.Image` and +converted to a wx.Bitmap, so any image file format supported by +`wx.Image` can be used. + +:todo: Add wrappers and support for raw bitmap data access. Can this + be be put into Python without losing the speed benefits of the + teplates and iterators in rawbmp.h? + +:todo: Find a way to do very efficient PIL Image <--> wx.Bitmap + converstions. + - __init__(String name, int type=BITMAP_TYPE_ANY) -> Bitmap - Loads a bitmap from a file. + __init__(self, String name, int type=BITMAP_TYPE_ANY) -> Bitmap + Loads a bitmap from a file. + :param name: Name of the file to load the bitmap from. + :param type: The type of image to expect. Can be one of the following + constants (assuming that the neccessary `wx.Image` handlers are + loaded): + + * wx.BITMAP_TYPE_ANY + * wx.BITMAP_TYPE_BMP + * wx.BITMAP_TYPE_ICO + * wx.BITMAP_TYPE_CUR + * wx.BITMAP_TYPE_XBM + * wx.BITMAP_TYPE_XPM + * wx.BITMAP_TYPE_TIF + * wx.BITMAP_TYPE_GIF + * wx.BITMAP_TYPE_PNG + * wx.BITMAP_TYPE_JPEG + * wx.BITMAP_TYPE_PNM + * wx.BITMAP_TYPE_PCX + * wx.BITMAP_TYPE_PICT + * wx.BITMAP_TYPE_ICON + * wx.BITMAP_TYPE_ANI + * wx.BITMAP_TYPE_IFF + +:see: Alternate constructors `wx.EmptyBitmap`, `wx.BitmapFromIcon`, + `wx.BitmapFromImage`, `wx.BitmapFromXPMData`, + `wx.BitmapFromBits` + @@ -7900,9 +9155,9 @@ background of rectangles, ellipses, etc. It has a colour and a style. EmptyBitmap(int width, int height, int depth=-1) -> Bitmap - 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. + 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. @@ -7911,17 +9166,18 @@ the current screen or visual. Some platforms only support 1 for monochrome and BitmapFromIcon(Icon icon) -> Bitmap - Create a new bitmap from an Icon object. + Create a new bitmap from a `wx.Icon` object. BitmapFromImage(Image image, int depth=-1) -> Bitmap - 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. + 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. @@ -7936,10 +9192,10 @@ depth is -1) which entails that a colour reduction has to take place. BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap - 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. + 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. @@ -7948,135 +9204,165 @@ platform dependent. - __del__() + __del__(self) - Ok() -> bool + Ok(self) -> bool - GetWidth() -> int + GetWidth(self) -> int Gets the width of the bitmap in pixels. - GetHeight() -> int + GetHeight(self) -> int Gets the height of the bitmap in pixels. - GetDepth() -> int + GetDepth(self) -> int Gets the colour depth of the bitmap. A value of 1 indicates a monochrome bitmap. + + GetSize(self) -> Size + Get the size of the bitmap. + - ConvertToImage() -> Image - 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. + ConvertToImage(self) -> Image + 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. - GetMask() -> Mask - Gets the associated mask (if any) which may have been loaded from a file -or explpicitly set for the bitmap. + GetMask(self) -> Mask + Gets the associated mask (if any) which may have been loaded from a +file or explpicitly set for the bitmap. + +:see: `SetMask`, `wx.Mask` + - SetMask(Mask mask) - Sets the mask for this bitmap. + SetMask(self, Mask mask) + Sets the mask for this bitmap. + +:see: `GetMask`, `wx.Mask` + - SetMaskColour(Colour colour) + SetMaskColour(self, Colour colour) Create a Mask based on a specified colour in the Bitmap. - GetSubBitmap(Rect rect) -> Bitmap - 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. + GetSubBitmap(self, Rect rect) -> Bitmap + 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. - SaveFile(String name, int type, Palette palette=(wxPalette *) NULL) -> bool - Saves a bitmap in the named file. + SaveFile(self, String name, int type, Palette palette=None) -> bool + Saves a bitmap in the named file. See `__init__` for a description of +the ``type`` parameter. - + - LoadFile(String name, int type) -> bool - Loads a bitmap from a file + LoadFile(self, String name, int type) -> bool + Loads a bitmap from a file. See `__init__` for a description of the +``type`` parameter. - CopyFromIcon(Icon icon) -> bool + CopyFromIcon(self, Icon icon) -> bool - SetHeight(int height) - Set the height property (does not affect the bitmap data). + SetHeight(self, int height) + Set the height property (does not affect the existing bitmap data). - SetWidth(int width) - Set the width property (does not affect the bitmap data). + SetWidth(self, int width) + Set the width property (does not affect the existing bitmap data). - SetDepth(int depth) - Set the depth property (does not affect the bitmap data). + SetDepth(self, int depth) + Set the depth property (does not affect the existing bitmap data). + + SetSize(self, Size size) + Set the bitmap size (does not affect the existing bitmap data). + + + + - __eq__(Bitmap other) -> bool + __eq__(self, Bitmap other) -> bool - __ne__(Bitmap other) -> bool + __ne__(self, Bitmap other) -> bool - - 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. + + 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. - __init__(Bitmap bitmap, Colour colour=NullColour) -> Mask - 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. + __init__(self, Bitmap bitmap, Colour colour=NullColour) -> Mask + 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` - MaskColour = Mask - + MaskColour = wx._deprecated(Mask, "wx.MaskColour is deprecated, use `wx.Mask` instead.") + - __init__(String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon + __init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon @@ -8106,88 +9392,88 @@ the transparent portions of the mask, by default BLACK is used. - __del__() + __del__(self) - LoadFile(String name, int type) -> bool + LoadFile(self, String name, int type) -> bool - Ok() -> bool + Ok(self) -> bool - GetWidth() -> int + GetWidth(self) -> int - GetHeight() -> int + GetHeight(self) -> int - GetDepth() -> int + GetDepth(self) -> int - SetWidth(int w) + SetWidth(self, int w) - SetHeight(int h) + SetHeight(self, int h) - SetDepth(int d) + SetDepth(self, int d) - CopyFromBitmap(Bitmap bmp) + CopyFromBitmap(self, Bitmap bmp) - + - __init__(String filename=&wxPyEmptyString, int num=0) -> IconLocation + __init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation - __del__() + __del__(self) - IsOk() -> bool + IsOk(self) -> bool - SetFileName(String filename) + SetFileName(self, String filename) - GetFileName() -> String + GetFileName(self) -> String - SetIndex(int num) + SetIndex(self, int num) - GetIndex() -> int + GetIndex(self) -> int - + - __init__() -> IconBundle + __init__(self) -> IconBundle IconBundleFromFile(String file, long type) -> IconBundle @@ -8203,61 +9489,42 @@ the transparent portions of the mask, by default BLACK is used. - __del__() + __del__(self) - AddIcon(Icon icon) + AddIcon(self, Icon icon) - AddIconFromFile(String file, long type) + AddIconFromFile(self, String file, long type) - GetIcon(Size size) -> Icon + GetIcon(self, Size size) -> Icon - - 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 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. - - - __init__(String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor - 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. +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. -This cursor is not available on wxGTK, use wx.StockCursor, -wx.CursorFromImage, or wx.CursorFromBits instead. - - - - - - - - - StockCursor(int id) -> Cursor - Create a cursor using one of the stock cursors. Note that not -all cursors are available on all platforms. - - Stock Cursor IDs +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. @@ -8285,43 +9552,65 @@ all cursors are available on all platforms. 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.) + ======================== ====================================== + + + + + __init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor + 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. - +This constructor is not available on wxGTK, use ``wx.StockCursor``, +``wx.CursorFromImage``, or ``wx.CursorFromBits`` instead. + + + + + + + + + StockCursor(int id) -> Cursor + Create a cursor using one of the stock cursors. Note that not all +cursors are available on all platforms. CursorFromImage(Image image) -> Cursor - 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). + 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). - __del__() + __del__(self) - Ok() -> bool + Ok(self) -> bool #--------------------------------------------------------------------------- - + - __init__(int x=0, int y=0, int width=0, int height=0) -> Region + __init__(self, int x=0, int y=0, int width=0, int height=0) -> Region @@ -8330,10 +9619,16 @@ respected). - RegionFromBitmap(Bitmap bmp, Colour transColour=NullColour, int tolerance=0) -> Region + RegionFromBitmap(Bitmap bmp) -> Region + + + + + + RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region - + @@ -8346,39 +9641,39 @@ respected). - __del__() + __del__(self) - Clear() + Clear(self) - Offset(int x, int y) -> bool + Offset(self, int x, int y) -> bool - Contains(int x, int y) -> int + Contains(self, int x, int y) -> int - ContainsPoint(Point pt) -> int + ContainsPoint(self, Point pt) -> int - ContainsRect(Rect rect) -> int + ContainsRect(self, Rect rect) -> int - ContainsRectDim(int x, int y, int w, int h) -> int + ContainsRectDim(self, int x, int y, int w, int h) -> int @@ -8387,10 +9682,10 @@ respected). - GetBox() -> Rect + GetBox(self) -> Rect - Intersect(int x, int y, int width, int height) -> bool + Intersect(self, int x, int y, int width, int height) -> bool @@ -8399,22 +9694,22 @@ respected). - IntersectRect(Rect rect) -> bool + IntersectRect(self, Rect rect) -> bool - IntersectRegion(Region region) -> bool + IntersectRegion(self, Region region) -> bool - IsEmpty() -> bool + IsEmpty(self) -> bool - Union(int x, int y, int width, int height) -> bool + Union(self, int x, int y, int width, int height) -> bool @@ -8423,19 +9718,19 @@ respected). - UnionRect(Rect rect) -> bool + UnionRect(self, Rect rect) -> bool - UnionRegion(Region region) -> bool + UnionRegion(self, Region region) -> bool - Subtract(int x, int y, int width, int height) -> bool + Subtract(self, int x, int y, int width, int height) -> bool @@ -8444,19 +9739,19 @@ respected). - SubtractRect(Rect rect) -> bool + SubtractRect(self, Rect rect) -> bool - SubtractRegion(Region region) -> bool + SubtractRegion(self, Region region) -> bool - Xor(int x, int y, int width, int height) -> bool + Xor(self, int x, int y, int width, int height) -> bool @@ -8465,72 +9760,78 @@ respected). - XorRect(Rect rect) -> bool + XorRect(self, Rect rect) -> bool - XorRegion(Region region) -> bool + XorRegion(self, Region region) -> bool - ConvertToBitmap() -> Bitmap + ConvertToBitmap(self) -> Bitmap - UnionBitmap(Bitmap bmp, Colour transColour=NullColour, int tolerance=0) -> bool + UnionBitmap(self, Bitmap bmp) -> bool + + + + + + UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool - + - + - __init__(Region region) -> RegionIterator + __init__(self, Region region) -> RegionIterator - __del__() + __del__(self) - GetX() -> int + GetX(self) -> int - GetY() -> int + GetY(self) -> int - GetW() -> int + GetW(self) -> int - GetWidth() -> int + GetWidth(self) -> int - GetH() -> int + GetH(self) -> int - GetHeight() -> int + GetHeight(self) -> int - GetRect() -> Rect + GetRect(self) -> Rect - HaveRects() -> bool + HaveRects(self) -> bool - Reset() + Reset(self) - Next() + Next(self) - __nonzero__() -> bool + __nonzero__(self) -> bool @@ -8539,124 +9840,124 @@ respected). #--------------------------------------------------------------------------- - + - __init__() -> NativeFontInfo + __init__(self) -> NativeFontInfo - __del__() + __del__(self) - Init() + Init(self) - InitFromFont(Font font) + InitFromFont(self, Font font) - GetPointSize() -> int + GetPointSize(self) -> int - GetStyle() -> int + GetStyle(self) -> int - GetWeight() -> int + GetWeight(self) -> int - GetUnderlined() -> bool + GetUnderlined(self) -> bool - GetFaceName() -> String + GetFaceName(self) -> String - GetFamily() -> int + GetFamily(self) -> int - GetEncoding() -> int + GetEncoding(self) -> int - SetPointSize(int pointsize) + SetPointSize(self, int pointsize) - SetStyle(int style) + SetStyle(self, int style) - SetWeight(int weight) + SetWeight(self, int weight) - SetUnderlined(bool underlined) + SetUnderlined(self, bool underlined) - SetFaceName(String facename) + SetFaceName(self, String facename) - SetFamily(int family) + SetFamily(self, int family) - SetEncoding(int encoding) + SetEncoding(self, int encoding) - FromString(String s) -> bool + FromString(self, String s) -> bool - ToString() -> String + ToString(self) -> String - __str__() -> String + __str__(self) -> String - FromUserString(String s) -> bool + FromUserString(self, String s) -> bool - ToUserString() -> String + ToUserString(self) -> String - + - __init__() -> NativeEncodingInfo + __init__(self) -> NativeEncodingInfo - __del__() + __del__(self) - FromString(String s) -> bool + FromString(self, String s) -> bool - ToString() -> String + ToString(self) -> String @@ -8674,12 +9975,12 @@ respected). #--------------------------------------------------------------------------- - + - __init__() -> FontMapper + __init__(self) -> FontMapper - __del__() + __del__(self) Get() -> FontMapper @@ -8691,7 +9992,7 @@ respected). - CharsetToEncoding(String charset, bool interactive=True) -> int + CharsetToEncoding(self, String charset, bool interactive=True) -> int @@ -8718,14 +10019,20 @@ respected). + + GetEncodingFromName(String name) -> int + + + + - SetConfig(ConfigBase config) + SetConfig(self, ConfigBase config) - SetConfigPath(String prefix) + SetConfigPath(self, String prefix) @@ -8734,7 +10041,7 @@ respected). GetDefaultConfigPath() -> String - GetAltForEncoding(int encoding, String facename=EmptyString, bool interactive=True) -> PyObject + GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject @@ -8742,20 +10049,20 @@ respected). - IsEncodingAvailable(int encoding, String facename=EmptyString) -> bool + IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool - SetDialogParent(Window parent) + SetDialogParent(self, Window parent) - SetDialogTitle(String title) + SetDialogTitle(self, String title) @@ -8764,10 +10071,10 @@ respected). #--------------------------------------------------------------------------- - + - __init__(int pointSize, int family, int style, int weight, bool underline=False, + __init__(self, int pointSize, int family, int style, int weight, bool underline=False, String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font @@ -8804,133 +10111,133 @@ respected). - __del__() + __del__(self) - Ok() -> bool + Ok(self) -> bool - __eq__(Font other) -> bool + __eq__(self, Font other) -> bool - __ne__(Font other) -> bool + __ne__(self, Font other) -> bool - GetPointSize() -> int + GetPointSize(self) -> int - GetFamily() -> int + GetFamily(self) -> int - GetStyle() -> int + GetStyle(self) -> int - GetWeight() -> int + GetWeight(self) -> int - GetUnderlined() -> bool + GetUnderlined(self) -> bool - GetFaceName() -> String + GetFaceName(self) -> String - GetEncoding() -> int + GetEncoding(self) -> int - GetNativeFontInfo() -> NativeFontInfo + GetNativeFontInfo(self) -> NativeFontInfo - IsFixedWidth() -> bool + IsFixedWidth(self) -> bool - GetNativeFontInfoDesc() -> String + GetNativeFontInfoDesc(self) -> String - GetNativeFontInfoUserDesc() -> String + GetNativeFontInfoUserDesc(self) -> String - SetPointSize(int pointSize) + SetPointSize(self, int pointSize) - SetFamily(int family) + SetFamily(self, int family) - SetStyle(int style) + SetStyle(self, int style) - SetWeight(int weight) + SetWeight(self, int weight) - SetFaceName(String faceName) + SetFaceName(self, String faceName) - SetUnderlined(bool underlined) + SetUnderlined(self, bool underlined) - SetEncoding(int encoding) + SetEncoding(self, int encoding) - SetNativeFontInfo(NativeFontInfo info) + SetNativeFontInfo(self, NativeFontInfo info) - SetNativeFontInfoFromString(String info) + SetNativeFontInfoFromString(self, String info) - SetNativeFontInfoUserDesc(String info) + SetNativeFontInfoUserDesc(self, String info) - GetFamilyString() -> String + GetFamilyString(self) -> String - GetStyleString() -> String + GetStyleString(self) -> String - GetWeightString() -> String + GetWeightString(self) -> String - SetNoAntiAliasing(bool no=True) + SetNoAntiAliasing(self, bool no=True) - GetNoAntiAliasing() -> bool + GetNoAntiAliasing(self) -> bool GetDefaultEncoding() -> int @@ -8945,15 +10252,15 @@ respected). #--------------------------------------------------------------------------- - + - __init__() -> FontEnumerator + __init__(self) -> FontEnumerator - __del__() + __del__(self) - _setCallbackInfo(PyObject self, PyObject _class, bool incref) + _setCallbackInfo(self, PyObject self, PyObject _class, bool incref) @@ -8961,46 +10268,46 @@ respected). - EnumerateFacenames(int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool + EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool - EnumerateEncodings(String facename=EmptyString) -> bool + EnumerateEncodings(self, String facename=EmptyString) -> bool - GetEncodings() -> PyObject + GetEncodings(self) -> PyObject - GetFacenames() -> PyObject + GetFacenames(self) -> PyObject #--------------------------------------------------------------------------- - + - + - __init__(int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale + __init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale - + - __del__() + __del__(self) - Init1(String szName, String szShort=EmptyString, String szLocale=EmptyString, + Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString, bool bLoadDefault=True, bool bConvertEncoding=False) -> bool @@ -9012,7 +10319,7 @@ respected). - Init2(int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool + Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool @@ -9028,19 +10335,19 @@ respected). GetSystemEncodingName() -> String - IsOk() -> bool + IsOk(self) -> bool - GetLocale() -> String + GetLocale(self) -> String - GetLanguage() -> int + GetLanguage(self) -> int - GetSysName() -> String + GetSysName(self) -> String - GetCanonicalName() -> String + GetCanonicalName(self) -> String AddCatalogLookupPathPrefix(String prefix) @@ -9049,13 +10356,13 @@ respected). - AddCatalog(String szDomain) -> bool + AddCatalog(self, String szDomain) -> bool - IsLoaded(String szDomain) -> bool + IsLoaded(self, String szDomain) -> bool @@ -9085,14 +10392,14 @@ respected). - GetString(String szOrigString, String szDomain=EmptyString) -> String + GetString(self, String szOrigString, String szDomain=EmptyString) -> String - GetName() -> String + GetName(self) -> String @@ -9115,16 +10422,16 @@ GetTranslation(String str, String strPlural, size_t n) -> String #--------------------------------------------------------------------------- - + - __init__() -> EncodingConverter + __init__(self) -> EncodingConverter - __del__() + __del__(self) - Init(int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool + Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool @@ -9132,7 +10439,7 @@ GetTranslation(String str, String strPlural, size_t n) -> String - Convert(String input) -> String + Convert(self, String input) -> String @@ -9159,16 +10466,7 @@ GetTranslation(String str, String strPlural, size_t n) -> String #---------------------------------------------------------------------------- -# 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 @@ -9181,19 +10479,54 @@ if wx.Platform == "__WXMSW__": #--------------------------------------------------------------------------- - + + A wx.DC is a device context onto which graphics and text can be +drawn. It is intended to represent a number of output devices in a +generic way, so a window can have a device context associated with it, +and a printer also has a device context. In this way, the same piece +of code may write to a number of different devices, if the device +context is used as a parameter. + +Derived types of wxDC have documentation for specific features only, +so refer to this section for most device context information. + +The wx.DC class is abstract and can not be instantiated, you must use +one of the derived classes instead. Which one will depend on the +situation in which it is used. - __del__() + __del__(self) - BeginDrawing() + BeginDrawing(self) + Allows for optimization of drawing code on platforms that need it. On +other platforms this is just an empty function and is harmless. To +take advantage of this postential optimization simply enclose each +group of calls to the drawing primitives within calls to +`BeginDrawing` and `EndDrawing`. - EndDrawing() + EndDrawing(self) + Ends the group of drawing primitives started with `BeginDrawing`, and +invokes whatever optimization is available for this DC type on the +current platform. - - FloodFillXY(int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool + + FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool + Flood fills the device context starting from the given point, using +the current brush colour, and using a style: + + - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than + the given colour is encountered. + + - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given + colour. + +Returns False if the operation failed. + +Note: The present implementation for non-Windows platforms may fail to +find colour borders if the pixels do not match the colour +exactly. However the function will still return true. @@ -9201,29 +10534,48 @@ if wx.Platform == "__WXMSW__": - - FloodFill(Point pt, Colour col, int style=FLOOD_SURFACE) -> bool + + FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool + Flood fills the device context starting from the given point, using +the current brush colour, and using a style: + + - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than + the given colour is encountered. + + - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given + colour. + +Returns False if the operation failed. + +Note: The present implementation for non-Windows platforms may fail to +find colour borders if the pixels do not match the colour +exactly. However the function will still return true. - - GetPixelXY(int x, int y) -> Colour + + GetPixel(self, int x, int y) -> Colour + Gets the colour at the specified location on the DC. - - GetPixel(Point pt) -> Colour + + GetPixelPoint(self, Point pt) -> Colour - - DrawLineXY(int x1, int y1, int x2, int y2) + + DrawLine(self, int x1, int y1, int x2, int y2) + Draws a line from the first point to the second. The current pen is +used for drawing the line. Note that the second point is *not* part of +the line and is not drawn by this function (this is consistent with +the behaviour of many other toolkits). @@ -9231,28 +10583,44 @@ if wx.Platform == "__WXMSW__": - - DrawLine(Point pt1, Point pt2) + + DrawLinePoint(self, Point pt1, Point pt2) + Draws a line from the first point to the second. The current pen is +used for drawing the line. Note that the second point is *not* part of +the line and is not drawn by this function (this is consistent with +the behaviour of many other toolkits). - - CrossHairXY(int x, int y) + + CrossHair(self, int x, int y) + Displays a cross hair using the current pen. This is a vertical and +horizontal line the height and width of the window, centred on the +given point. - - CrossHair(Point pt) + + CrossHairPoint(self, Point pt) + Displays a cross hair using the current pen. This is a vertical and +horizontal line the height and width of the window, centred on the +given point. - - DrawArcXY(int x1, int y1, int x2, int y2, int xc, int yc) + + DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc) + Draws an arc of a circle, centred on the *center* point (xc, yc), from +the first point to the second. The current pen is used for the outline +and the current brush for filling the shape. + +The arc is drawn in an anticlockwise direction from the start point to +the end point. @@ -9262,16 +10630,23 @@ if wx.Platform == "__WXMSW__": - - DrawArc(Point pt1, Point pt2, Point centre) + + DrawArcPoint(self, Point pt1, Point pt2, Point center) + Draws an arc of a circle, centred on the *center* point (xc, yc), from +the first point to the second. The current pen is used for the outline +and the current brush for filling the shape. + +The arc is drawn in an anticlockwise direction from the start point to +the end point. - + - - DrawCheckMarkXY(int x, int y, int width, int height) + + DrawCheckMark(self, int x, int y, int width, int height) + Draws a check mark inside the given rectangle. @@ -9279,47 +10654,71 @@ if wx.Platform == "__WXMSW__": - - DrawCheckMark(Rect rect) + + DrawCheckMarkRect(self, Rect rect) + Draws a check mark inside the given rectangle. - - DrawEllipticArcXY(int x, int y, int w, int h, double sa, double ea) + + DrawEllipticArc(self, int x, int y, int w, int h, double start, double end) + Draws an arc of an ellipse, with the given rectangle defining the +bounds of the ellipse. The current pen is used for drawing the arc and +the current brush is used for drawing the pie. + +The *start* and *end* parameters specify the start and end of the arc +relative to the three-o'clock position from the center of the +rectangle. Angles are specified in degrees (360 is a complete +circle). Positive values mean counter-clockwise motion. If start is +equal to end, a complete ellipse will be drawn. - - + + - - DrawEllipticArc(Point pt, Size sz, double sa, double ea) + + DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end) + Draws an arc of an ellipse, with the given rectangle defining the +bounds of the ellipse. The current pen is used for drawing the arc and +the current brush is used for drawing the pie. + +The *start* and *end* parameters specify the start and end of the arc +relative to the three-o'clock position from the center of the +rectangle. Angles are specified in degrees (360 is a complete +circle). Positive values mean counter-clockwise motion. If start is +equal to end, a complete ellipse will be drawn. - - + + - - DrawPointXY(int x, int y) + + DrawPoint(self, int x, int y) + Draws a point using the current pen. - - DrawPoint(Point pt) + + DrawPointPoint(self, Point pt) + Draws a point using the current pen. - - DrawRectangleXY(int x, int y, int width, int height) + + DrawRectangle(self, int x, int y, int width, int height) + Draws a rectangle with the given top left corner, and with the given +size. The current pen is used for the outline and the current brush +for filling the shape. @@ -9327,21 +10726,38 @@ if wx.Platform == "__WXMSW__": - - DrawRectangle(Point pt, Size sz) + + DrawRectangleRect(self, Rect rect) + Draws a rectangle with the given top left corner, and with the given +size. The current pen is used for the outline and the current brush +for filling the shape. - - + - - DrawRectangleRect(Rect rect) + + DrawRectanglePointSize(self, Point pt, Size sz) + Draws a rectangle with the given top left corner, and with the given +size. The current pen is used for the outline and the current brush +for filling the shape. - + + - - DrawRoundedRectangleXY(int x, int y, int width, int height, double radius) + + DrawRoundedRectangle(self, int x, int y, int width, int height, double radius) + Draws a rectangle with the given top left corner, and with the given +size. The corners are quarter-circles using the given radius. The +current pen is used for the outline and the current brush for filling +the shape. + +If radius is positive, the value is assumed to be the radius of the +rounded corner. If radius is negative, the absolute value is assumed +to be the proportion of the smallest dimension of the rectangle. This +means that the corner can be a sensible size relative to the size of +the rectangle, and also avoids the strange effects X produces when the +corners are too big for the rectangle. @@ -9350,38 +10766,74 @@ if wx.Platform == "__WXMSW__": - - DrawRoundedRectangle(Point pt, Size sz, double radius) + + DrawRoundedRectangleRect(self, Rect r, double radius) + Draws a rectangle with the given top left corner, and with the given +size. The corners are quarter-circles using the given radius. The +current pen is used for the outline and the current brush for filling +the shape. + +If radius is positive, the value is assumed to be the radius of the +rounded corner. If radius is negative, the absolute value is assumed +to be the proportion of the smallest dimension of the rectangle. This +means that the corner can be a sensible size relative to the size of +the rectangle, and also avoids the strange effects X produces when the +corners are too big for the rectangle. - - + - - DrawRoundedRectangleRect(Rect r, double radius) + + DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius) + Draws a rectangle with the given top left corner, and with the given +size. The corners are quarter-circles using the given radius. The +current pen is used for the outline and the current brush for filling +the shape. + +If radius is positive, the value is assumed to be the radius of the +rounded corner. If radius is negative, the absolute value is assumed +to be the proportion of the smallest dimension of the rectangle. This +means that the corner can be a sensible size relative to the size of +the rectangle, and also avoids the strange effects X produces when the +corners are too big for the rectangle. - + + - - DrawCircleXY(int x, int y, int radius) + + DrawCircle(self, int x, int y, int radius) + Draws a circle with the given center point and radius. The current +pen is used for the outline and the current brush for filling the +shape. + +:see: `DrawEllipse` - - DrawCircle(Point pt, int radius) + + DrawCirclePoint(self, Point pt, int radius) + Draws a circle with the given center point and radius. The current +pen is used for the outline and the current brush for filling the +shape. + +:see: `DrawEllipse` - - DrawEllipseXY(int x, int y, int width, int height) + + DrawEllipse(self, int x, int y, int width, int height) + Draws an ellipse contained in the specified rectangle. The current pen +is used for the outline and the current brush for filling the shape. + +:see: `DrawCircle` @@ -9389,36 +10841,61 @@ if wx.Platform == "__WXMSW__": - - DrawEllipse(Point pt, Size sz) + + DrawEllipseRect(self, Rect rect) + Draws an ellipse contained in the specified rectangle. The current pen +is used for the outline and the current brush for filling the shape. + +:see: `DrawCircle` - - + - - DrawEllipseRect(Rect rect) + + DrawEllipsePointSize(self, Point pt, Size sz) + Draws an ellipse contained in the specified rectangle. The current pen +is used for the outline and the current brush for filling the shape. + +:see: `DrawCircle` - + + - - DrawIconXY(Icon icon, int x, int y) + + DrawIcon(self, Icon icon, int x, int y) + Draw an icon on the display (does nothing if the device context is +PostScript). This can be the simplest way of drawing bitmaps on a +window. - - DrawIcon(Icon icon, Point pt) + + DrawIconPoint(self, Icon icon, Point pt) + Draw an icon on the display (does nothing if the device context is +PostScript). This can be the simplest way of drawing bitmaps on a +window. - - DrawBitmapXY(Bitmap bmp, int x, int y, bool useMask=False) + + DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False) + Draw a bitmap on the device context at the specified point. If +*transparent* is true and the bitmap has a transparency mask, (or +alpha channel on the platforms that support it) then the bitmap will +be drawn transparently. + +When drawing a mono-bitmap, the current text foreground colour will be +used to draw the foreground of the bitmap (all bits set to 1), and the +current text background colour to draw the background (all bits set to +0). + +:see: `SetTextForeground`, `SetTextBackground` and `wx.MemoryDC` @@ -9426,31 +10903,74 @@ if wx.Platform == "__WXMSW__": - - DrawBitmap(Bitmap bmp, Point pt, bool useMask=False) + + DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False) + Draw a bitmap on the device context at the specified point. If +*transparent* is true and the bitmap has a transparency mask, (or +alpha channel on the platforms that support it) then the bitmap will +be drawn transparently. + +When drawing a mono-bitmap, the current text foreground colour will be +used to draw the foreground of the bitmap (all bits set to 1), and the +current text background colour to draw the background (all bits set to +0). + +:see: `SetTextForeground`, `SetTextBackground` and `wx.MemoryDC` - - DrawTextXY(String text, int x, int y) + + DrawText(self, String text, int x, int y) + Draws a text string at the specified point, using the current text +font, and the current text foreground and background colours. + +The coordinates refer to the top-left corner of the rectangle bounding +the string. See `GetTextExtent` for how to get the dimensions of a +text string, which can be used to position the text more precisely. + +**NOTE**: under wxGTK the current logical function is used by this +function but it is ignored by wxMSW. Thus, you should avoid using +logical functions with this function in portable programs. + +:see: `DrawRotatedText` - - DrawText(String text, Point pt) + + DrawTextPoint(self, String text, Point pt) + Draws a text string at the specified point, using the current text +font, and the current text foreground and background colours. + +The coordinates refer to the top-left corner of the rectangle bounding +the string. See `GetTextExtent` for how to get the dimensions of a +text string, which can be used to position the text more precisely. + +**NOTE**: under wxGTK the current logical function is used by this +function but it is ignored by wxMSW. Thus, you should avoid using +logical functions with this function in portable programs. + +:see: `DrawRotatedText` - - DrawRotatedTextXY(String text, int x, int y, double angle) + + DrawRotatedText(self, String text, int x, int y, double angle) + Draws the text rotated by *angle* degrees, if supported by the platform. + +**NOTE**: Under Win9x only TrueType fonts can be drawn by this +function. In particular, a font different from ``wx.NORMAL_FONT`` +should be used as the it is not normally a TrueType +font. ``wx.SWISS_FONT`` is an example of a font which is. + +:see: `DrawText` @@ -9458,18 +10978,47 @@ if wx.Platform == "__WXMSW__": - - DrawRotatedText(String text, Point pt, double angle) + + DrawRotatedTextPoint(self, String text, Point pt, double angle) + Draws the text rotated by *angle* degrees, if supported by the platform. + +**NOTE**: Under Win9x only TrueType fonts can be drawn by this +function. In particular, a font different from ``wx.NORMAL_FONT`` +should be used as the it is not normally a TrueType +font. ``wx.SWISS_FONT`` is an example of a font which is. + +:see: `DrawText` - - BlitXY(int xdest, int ydest, int width, int height, DC source, + + 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 + Copy from a source DC to this DC. Parameters specify the destination +coordinates, size of area to copy, source DC, source coordinates, +logical function, whether to use a bitmap mask, and mask source +position. + + :param xdest: Destination device context x position. + :param ydest: Destination device context y position. + :param width: Width of source area to be copied. + :param height: Height of source area to be copied. + :param source: Source device context. + :param xsrc: Source device context x position. + :param ysrc: Source device context y position. + :param rop: Logical function to use: see `SetLogicalFunction`. + :param useMask: If true, Blit does a transparent blit using the mask + that is associated with the bitmap selected into the + source device context. + :param xsrcMask: Source x position on the mask. If both xsrcMask and + ysrcMask are -1, xsrc and ysrc will be assumed for + the mask source position. + :param ysrcMask: Source y position on the mask. + @@ -9484,9 +11033,24 @@ if wx.Platform == "__WXMSW__": - - Blit(Point destPt, Size sz, DC source, Point srcPt, int rop=COPY, + + BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY, bool useMask=False, Point srcPtMask=DefaultPosition) -> bool + Copy from a source DC to this DC. Parameters specify the destination +coordinates, size of area to copy, source DC, source coordinates, +logical function, whether to use a bitmap mask, and mask source +position. + + :param destPt: Destination device context position. + :param sz: Size of source area to be copied. + :param source: Source device context. + :param srcPt: Source device context position. + :param rop: Logical function to use: see `SetLogicalFunction`. + :param useMask: If true, Blit does a transparent blit using the mask + that is associated with the bitmap selected into the + source device context. + :param srcPtMask: Source position on the mask. + @@ -9497,8 +11061,87 @@ if wx.Platform == "__WXMSW__": + + SetClippingRegion(self, int x, int y, int width, int height) + Sets the clipping region for this device context to the intersection +of the given region described by the parameters of this method and the +previously set clipping region. You should call `DestroyClippingRegion` +if you want to set the clipping region exactly to the region +specified. + +The clipping region is an area to which drawing is +restricted. Possible uses for the clipping region are for clipping +text or for speeding up window redraws when only a known area of the +screen is damaged. + +:see: `DestroyClippingRegion`, `wx.Region` + + + + + + + + + SetClippingRegionPointSize(self, Point pt, Size sz) + Sets the clipping region for this device context to the intersection +of the given region described by the parameters of this method and the +previously set clipping region. You should call `DestroyClippingRegion` +if you want to set the clipping region exactly to the region +specified. + +The clipping region is an area to which drawing is +restricted. Possible uses for the clipping region are for clipping +text or for speeding up window redraws when only a known area of the +screen is damaged. + +:see: `DestroyClippingRegion`, `wx.Region` + + + + + + + SetClippingRegionAsRegion(self, Region region) + Sets the clipping region for this device context to the intersection +of the given region described by the parameters of this method and the +previously set clipping region. You should call `DestroyClippingRegion` +if you want to set the clipping region exactly to the region +specified. + +The clipping region is an area to which drawing is +restricted. Possible uses for the clipping region are for clipping +text or for speeding up window redraws when only a known area of the +screen is damaged. + +:see: `DestroyClippingRegion`, `wx.Region` + + + + + + SetClippingRect(self, Rect rect) + Sets the clipping region for this device context to the intersection +of the given region described by the parameters of this method and the +previously set clipping region. You should call `DestroyClippingRegion` +if you want to set the clipping region exactly to the region +specified. + +The clipping region is an area to which drawing is +restricted. Possible uses for the clipping region are for clipping +text or for speeding up window redraws when only a known area of the +screen is damaged. + +:see: `DestroyClippingRegion`, `wx.Region` + + + + - DrawLines(int points, Point points_array, int xoffset=0, int yoffset=0) + DrawLines(self, List points, int xoffset=0, int yoffset=0) + Draws lines using a sequence of `wx.Point` objects, adding the +optional offset coordinate. The current pen is used for drawing the +lines. @@ -9507,8 +11150,16 @@ if wx.Platform == "__WXMSW__": - DrawPolygon(int points, Point points_array, int xoffset=0, int yoffset=0, + DrawPolygon(self, List points, int xoffset=0, int yoffset=0, int fillStyle=ODDEVEN_RULE) + Draws a filled polygon using a sequence of `wx.Point` objects, adding +the optional offset coordinate. The last argument specifies the fill +rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``. + +The current pen is used for drawing the outline, and the current brush +for filling the shape. Using a transparent brush suppresses +filling. Note that wxWidgets automatically closes the first and last +points. @@ -9518,8 +11169,13 @@ if wx.Platform == "__WXMSW__": - DrawLabel(String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, + DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, int indexAccel=-1) + Draw *text* within the specified rectangle, abiding by the alignment +flags. Will additionally emphasize the character at *indexAccel* if +it is not -1. + +:see: `DrawImageLabel` @@ -9528,8 +11184,12 @@ if wx.Platform == "__WXMSW__": - DrawImageLabel(String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, + DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, int indexAccel=-1) -> Rect + Draw *text* and an image (which may be ``wx.NullBitmap`` to skip +drawing it) within the specified rectangle, abiding by the alignment +flags. Will additionally emphasize the character at *indexAccel* if +it is not -1. Returns the bounding rectangle. @@ -9539,99 +11199,112 @@ if wx.Platform == "__WXMSW__": - DrawSpline(int points, Point points_array) + DrawSpline(self, List points) + Draws a spline between all given control points, (a list of `wx.Point` +objects) using the current pen. The spline is drawn using a series of +lines, using an algorithm taken from the X drawing program 'XFIG'. - Clear() + Clear(self) + Clears the device context using the current background brush. - StartDoc(String message) -> bool + StartDoc(self, String message) -> bool + Starts a document (only relevant when outputting to a +printer). *Message* is a message to show whilst printing. - EndDoc() + EndDoc(self) + Ends a document (only relevant when outputting to a printer). - StartPage() + StartPage(self) + Starts a document page (only relevant when outputting to a printer). - EndPage() + EndPage(self) + Ends a document page (only relevant when outputting to a printer). - SetFont(Font font) + SetFont(self, Font font) + Sets the current font for the DC. It must be a valid font, in +particular you should not pass ``wx.NullFont`` to this method. + +:see: `wx.Font` - SetPen(Pen pen) + SetPen(self, Pen pen) + Sets the current pen for the DC. + +If the argument is ``wx.NullPen``, the current pen is selected out of the +device context, and the original pen restored. + +:see: `wx.Pen` - SetBrush(Brush brush) + SetBrush(self, Brush brush) + Sets the current brush for the DC. + +If the argument is ``wx.NullBrush``, the current brush is selected out +of the device context, and the original brush restored, allowing the +current brush to be destroyed safely. + +:see: `wx.Brush` - SetBackground(Brush brush) + SetBackground(self, Brush brush) + Sets the current background brush for the DC. - SetBackgroundMode(int mode) + SetBackgroundMode(self, int mode) + *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting +determines whether text will be drawn with a background colour or +not. - SetPalette(Palette palette) + SetPalette(self, Palette palette) + If this is a window DC or memory DC, assigns the given palette to the +window or bitmap associated with the DC. If the argument is +``wx.NullPalette``, the current palette is selected out of the device +context, and the original palette restored. + +:see: `wx.Palette` - - SetClippingRegionXY(int x, int y, int width, int height) - - - - - - - - - SetClippingRegion(Point pt, Size sz) - - - - - - - SetClippingRect(Rect rect) - - - - - - SetClippingRegionAsRegion(Region region) - - - - - DestroyClippingRegion() + DestroyClippingRegion(self) + Destroys the current clipping region so that none of the DC is +clipped. + +:see: `SetClippingRegion` GetClippingBox() -> (x, y, width, height) + Gets the rectangle surrounding the current clipping region. @@ -9640,18 +11313,21 @@ if wx.Platform == "__WXMSW__": - GetClippingRect() -> Rect + GetClippingRect(self) -> Rect + Gets the rectangle surrounding the current clipping region. - GetCharHeight() -> int + GetCharHeight(self) -> int + Gets the character height of the currently set font. - GetCharWidth() -> int + GetCharWidth(self) -> int + Gets the average character width of the currently set font. GetTextExtent(wxString string) -> (width, height) - Get the width and height of the text using the current font. -Only works for single line strings. + Get the width and height of the text using the current font. Only +works for single line strings. @@ -9661,8 +11337,8 @@ Only works for single line strings. GetFullTextExtent(wxString string, Font font=None) -> (width, height, descent, externalLeading) - Get the width, height, decent and leading of the text using the current or specified font. -Only works for single line strings. + Get the width, height, decent and leading of the text using the +current or specified font. Only works for single line strings. @@ -9675,8 +11351,9 @@ Only works for single line strings. GetMultiLineTextExtent(wxString string, Font font=None) -> (width, height, descent, externalLeading) - 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. + 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. @@ -9686,25 +11363,51 @@ Works for single as well as multi-line strings. - GetPartialTextExtents(String text) -> wxArrayInt + GetPartialTextExtents(self, text) -> [widths] + Returns a list of integers such that each value is the distance in +pixels from the begining of text to the coresponding character of +*text*. The generic version simply builds a running total of the widths +of each character using GetTextExtent, however if the various +platforms have a native API function that is faster or more accurate +than the generic implementation then it will be used instead. - GetSize() -> Size - Get the DC size in device units. + GetSize(self) -> Size + This gets the horizontal and vertical resolution in device units. It +can be used to scale graphics to fit the page. For example, if *maxX* +and *maxY* represent the maximum horizontal and vertical 'pixel' values +used in your application, the following code will scale the graphic to +fit on the printer page:: + + w, h = dc.GetSize() + scaleX = maxX*1.0 / w + scaleY = maxY*1.0 / h + dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY)) + GetSizeTuple() -> (width, height) - Get the DC size in device units. + This gets the horizontal and vertical resolution in device units. It +can be used to scale graphics to fit the page. For example, if *maxX* +and *maxY* represent the maximum horizontal and vertical 'pixel' values +used in your application, the following code will scale the graphic to +fit on the printer page:: + + w, h = dc.GetSize() + scaleX = maxX*1.0 / w + scaleY = maxY*1.0 / h + dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY)) + - GetSizeMM() -> Size + GetSizeMM(self) -> Size Get the DC size in milimeters. @@ -9716,119 +11419,185 @@ Works for single as well as multi-line strings. - DeviceToLogicalX(int x) -> int + DeviceToLogicalX(self, int x) -> int + Convert device X coordinate to logical coordinate, using the current +mapping mode. - DeviceToLogicalY(int y) -> int + DeviceToLogicalY(self, int y) -> int + Converts device Y coordinate to logical coordinate, using the current +mapping mode. - DeviceToLogicalXRel(int x) -> int + DeviceToLogicalXRel(self, int x) -> int + Convert device X coordinate to relative logical coordinate, using the +current mapping mode but ignoring the x axis orientation. Use this +function for converting a width, for example. - DeviceToLogicalYRel(int y) -> int + DeviceToLogicalYRel(self, int y) -> int + Convert device Y coordinate to relative logical coordinate, using the +current mapping mode but ignoring the y axis orientation. Use this +function for converting a height, for example. - LogicalToDeviceX(int x) -> int + LogicalToDeviceX(self, int x) -> int + Converts logical X coordinate to device coordinate, using the current +mapping mode. - LogicalToDeviceY(int y) -> int + LogicalToDeviceY(self, int y) -> int + Converts logical Y coordinate to device coordinate, using the current +mapping mode. - LogicalToDeviceXRel(int x) -> int + LogicalToDeviceXRel(self, int x) -> int + Converts logical X coordinate to relative device coordinate, using the +current mapping mode but ignoring the x axis orientation. Use this for +converting a width, for example. - LogicalToDeviceYRel(int y) -> int + LogicalToDeviceYRel(self, int y) -> int + Converts logical Y coordinate to relative device coordinate, using the +current mapping mode but ignoring the y axis orientation. Use this for +converting a height, for example. - CanDrawBitmap() -> bool + CanDrawBitmap(self) -> bool - CanGetTextExtent() -> bool + CanGetTextExtent(self) -> bool - GetDepth() -> int + GetDepth(self) -> int + Returns the colour depth of the DC. - GetPPI() -> Size + GetPPI(self) -> Size + Resolution in Pixels per inch - Ok() -> bool + Ok(self) -> bool + Returns true if the DC is ok to use. - GetBackgroundMode() -> int + GetBackgroundMode(self) -> int + Returns the current background mode, either ``wx.SOLID`` or +``wx.TRANSPARENT``. + +:see: `SetBackgroundMode` - GetBackground() -> Brush + GetBackground(self) -> Brush + Gets the brush used for painting the background. + +:see: `SetBackground` - GetBrush() -> Brush + GetBrush(self) -> Brush + Gets the current brush - GetFont() -> Font + GetFont(self) -> Font + Gets the current font - GetPen() -> Pen + GetPen(self) -> Pen + Gets the current pen - GetTextBackground() -> Colour + GetTextBackground(self) -> Colour + Gets the current text background colour - GetTextForeground() -> Colour + GetTextForeground(self) -> Colour + Gets the current text foreground colour - SetTextForeground(Colour colour) + SetTextForeground(self, Colour colour) + Sets the current text foreground colour for the DC. - SetTextBackground(Colour colour) + SetTextBackground(self, Colour colour) + Sets the current text background colour for the DC. - GetMapMode() -> int + GetMapMode(self) -> int + Gets the current *mapping mode* for the device context - SetMapMode(int mode) + SetMapMode(self, int mode) + The *mapping mode* of the device context defines the unit of +measurement used to convert logical units to device units. The +mapping mode can be one of the following: + + ================ ============================================= + wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440 + of an inch. + wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch. + wx.MM_METRIC Each logical unit is 1 mm. + wx.MM_LOMETRIC Each logical unit is 1/10 of a mm. + wx.MM_TEXT Each logical unit is 1 pixel. + ================ ============================================= + +Note that in X, text drawing isn't handled consistently with the +mapping mode; a font is always specified in point size. However, +setting the user scale (see `SetUserScale`) scales the text +appropriately. In Windows, scalable TrueType fonts are always used; in +X, results depend on availability of fonts, but usually a reasonable +match is found. + +The coordinate origin is always at the top left of the screen/printer. + +Drawing to a Windows printer device context uses the current mapping +mode, but mapping mode is currently ignored for PostScript output. + - GetUserScale() -> (xScale, yScale) + GetUserScale(self) -> (xScale, yScale) + Gets the current user scale factor (set by `SetUserScale`). - SetUserScale(double x, double y) + SetUserScale(self, double x, double y) + Sets the user scaling factor, useful for applications which require +'zooming'. @@ -9842,14 +11611,14 @@ Works for single as well as multi-line strings. - SetLogicalScale(double x, double y) + SetLogicalScale(self, double x, double y) - GetLogicalOrigin() -> Point + GetLogicalOrigin(self) -> Point GetLogicalOriginTuple() -> (x,y) @@ -9859,14 +11628,20 @@ Works for single as well as multi-line strings. - SetLogicalOrigin(int x, int y) + SetLogicalOrigin(self, int x, int y) + + SetLogicalOriginPoint(self, Point point) + + + + - GetDeviceOrigin() -> Point + GetDeviceOrigin(self) -> Point GetDeviceOriginTuple() -> (x,y) @@ -9876,61 +11651,133 @@ Works for single as well as multi-line strings. - SetDeviceOrigin(int x, int y) + SetDeviceOrigin(self, int x, int y) + + SetDeviceOriginPoint(self, Point point) + + + + - SetAxisOrientation(bool xLeftRight, bool yBottomUp) + SetAxisOrientation(self, bool xLeftRight, bool yBottomUp) + Sets the x and y axis orientation (i.e., the direction from lowest to +highest values on the axis). The default orientation is the natural +orientation, e.g. x axis from left to right and y axis from bottom up. - GetLogicalFunction() -> int + GetLogicalFunction(self) -> int + Gets the current logical function (set by `SetLogicalFunction`). - SetLogicalFunction(int function) + SetLogicalFunction(self, int function) + Sets the current logical function for the device context. This +determines how a source pixel (from a pen or brush colour, or source +device context if using `Blit`) combines with a destination pixel in +the current device context. + +The possible values and their meaning in terms of source and +destination pixel values are as follows: + + ================ ========================== + wx.AND src AND dst + wx.AND_INVERT (NOT src) AND dst + wx.AND_REVERSE src AND (NOT dst) + wx.CLEAR 0 + wx.COPY src + wx.EQUIV (NOT src) XOR dst + wx.INVERT NOT dst + wx.NAND (NOT src) OR (NOT dst) + wx.NOR (NOT src) AND (NOT dst) + wx.NO_OP dst + wx.OR src OR dst + wx.OR_INVERT (NOT src) OR dst + wx.OR_REVERSE src OR (NOT dst) + wx.SET 1 + wx.SRC_INVERT NOT src + wx.XOR src XOR dst + ================ ========================== + +The default is wx.COPY, which simply draws with the current +colour. The others combine the current colour and the background using +a logical operation. wx.INVERT is commonly used for drawing rubber +bands or moving outlines, since drawing twice reverts to the original +colour. + - SetOptimization(bool opt) + SetOptimization(self, bool optimize) + If *optimize* is true this function sets optimization mode on. This +currently means that under X, the device context will not try to set a +pen or brush property if it is known to be set already. This approach +can fall down if non-wxWidgets code is using the same device context +or window, for example when the window is a panel on which the +windowing system draws panel items. The wxWidgets device context +'memory' will now be out of step with reality. + +Setting optimization off, drawing, then setting it back on again, is a +trick that must occasionally be employed. - + - GetOptimization() -> bool + GetOptimization(self) -> bool + Returns true if device context optimization is on. See +`SetOptimization` for . - CalcBoundingBox(int x, int y) + CalcBoundingBox(self, int x, int y) + Adds the specified point to the bounding box which can be retrieved +with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions. + + CalcBoundingBoxPoint(self, Point point) + Adds the specified point to the bounding box which can be retrieved +with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions. + + + + - ResetBoundingBox() + ResetBoundingBox(self) + Resets the bounding box: after a call to this function, the bounding +box doesn't contain anything. - MinX() -> int + MinX(self) -> int + Gets the minimum horizontal extent used in drawing commands so far. - MaxX() -> int + MaxX(self) -> int + Gets the maximum horizontal extent used in drawing commands so far. - MinY() -> int + MinY(self) -> int + Gets the minimum vertical extent used in drawing commands so far. - MaxY() -> int + MaxY(self) -> int + Gets the maximum vertical extent used in drawing commands so far. GetBoundingBox() -> (x1,y1, x2,y2) + Returns the min and max points used in drawing commands so far. @@ -9939,7 +11786,7 @@ Works for single as well as multi-line strings. - _DrawPointList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject + _DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject @@ -9947,7 +11794,7 @@ Works for single as well as multi-line strings. - _DrawLineList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject + _DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject @@ -9955,7 +11802,7 @@ Works for single as well as multi-line strings. - _DrawRectangleList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject + _DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject @@ -9963,7 +11810,7 @@ Works for single as well as multi-line strings. - _DrawEllipseList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject + _DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject @@ -9971,7 +11818,7 @@ Works for single as well as multi-line strings. - _DrawPolygonList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject + _DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject @@ -9979,7 +11826,7 @@ Works for single as well as multi-line strings. - _DrawTextList(PyObject textList, PyObject pyPoints, PyObject foregroundList, + _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList, PyObject backgroundList) -> PyObject @@ -9992,19 +11839,49 @@ Works for single as well as multi-line strings. #--------------------------------------------------------------------------- - + + A memory device context provides a means to draw graphics onto a +bitmap. A bitmap must be selected into the new memory DC before it may +be used for anything. Typical usage is as follows:: + + dc = wx.MemoryDC() + dc.SelectObject(bitmap) + # draw on the dc usign any of the Draw methods + dc.SelectObject(wx.NullBitmap) + # the bitmap now contains wahtever was drawn upon it + +Note that the memory DC *must* be deleted (or the bitmap selected out +of it) before a bitmap can be reselected into another memory DC. + - __init__() -> MemoryDC + __init__(self) -> MemoryDC + Constructs a new memory device context. + +Use the Ok member to test whether the constructor was successful in +creating a usable device context. Don't forget to select a bitmap into +the DC before drawing on it. + +:see: `MemoryDCFromDC` MemoryDCFromDC(DC oldDC) -> MemoryDC + Creates a DC that is compatible with the oldDC. - SelectObject(Bitmap bitmap) + SelectObject(self, Bitmap bitmap) + Selects the bitmap into the device context, to use as the memory +bitmap. Selecting the bitmap into a memory DC allows you to draw into +the DC, and therefore the bitmap, and also to use Blit to copy the +bitmap to a window. + +If the argument is wx.NullBitmap (or some other uninitialised +`wx.Bitmap`) the current bitmap is selected out of the device context, +and the original bitmap restored, allowing the current bitmap to be +destroyed safely. @@ -10013,40 +11890,106 @@ Works for single as well as multi-line strings. #--------------------------------------------------------------------------- - + + This simple class provides a simple way to avoid flicker: when drawing +on it, everything is in fact first drawn on an in-memory buffer (a +`wx.Bitmap`) and then copied to the screen only once, when this object +is destroyed. + +It can be used in the same way as any other device +context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you +want to use it in your EVT_PAINT handler, you should look at +`wx.BufferedPaintDC`. + + Constructs a buffered DC. + + :param dc: The underlying DC: everything drawn to this object will + be flushed to this DC when this object is destroyed. You may + pass ``None`` in order to just initialize the buffer, and not + flush it. + + :param buffer: If a `wx.Size` object is passed as the 2nd arg then + it is the size of the bitmap that will be created internally + and used for an implicit buffer. If the 2nd arg is a + `wx.Bitmap` then it is the explicit buffer that will be + used. Using an explicit buffer is the most efficient solution + as the bitmap doesn't have to be recreated each time but it + also requires more memory as the bitmap is never freed. The + bitmap should have appropriate size, anything drawn outside of + its bounds is clipped. + - __init__(DC dc, Bitmap buffer) -> BufferedDC -__init__(DC dc, Size area) -> BufferedDC - - - - - - - BufferedDCInternalBuffer(DC dc, Size area) -> BufferedDC + __init__(self, DC dc, Bitmap buffer) -> BufferedDC +__init__(self, DC dc, Size area) -> BufferedDC + Constructs a buffered DC. + + :param dc: The underlying DC: everything drawn to this object will + be flushed to this DC when this object is destroyed. You may + pass ``None`` in order to just initialize the buffer, and not + flush it. + + :param buffer: If a `wx.Size` object is passed as the 2nd arg then + it is the size of the bitmap that will be created internally + and used for an implicit buffer. If the 2nd arg is a + `wx.Bitmap` then it is the explicit buffer that will be + used. Using an explicit buffer is the most efficient solution + as the bitmap doesn't have to be recreated each time but it + also requires more memory as the bitmap is never freed. The + bitmap should have appropriate size, anything drawn outside of + its bounds is clipped. + - __del__() + __del__(self) + Copies everything drawn on the DC so far to the underlying DC +associated with this object, if any. - UnMask() + UnMask(self) + Blits the buffer to the dc, and detaches the dc from the buffer (so it +can be effectively used once only). This is usually only called in +the destructor. - + + This is a subclass of `wx.BufferedDC` which can be used inside of an +EVT_PAINT event handler. Just create an object of this class instead +of `wx.PaintDC` and that's all you have to do to (mostly) avoid +flicker. The only thing to watch out for is that if you are using this +class together with `wx.ScrolledWindow`, you probably do **not** want +to call `wx.Window.PrepareDC` on it as it already does this internally +for the real underlying `wx.PaintDC`. + +If your window is already fully buffered in a `wx.Bitmap` then your +EVT_PAINT handler can be as simple as just creating a +``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window +automatically when it is destroyed. For example:: + + def OnPaint(self, event): + dc = wx.BufferedPaintDC(self, self.buffer) + + + - __init__(Window window, Bitmap buffer=NullBitmap) -> BufferedPaintDC + __init__(self, Window window, Bitmap buffer=NullBitmap) -> BufferedPaintDC + Create a buffered paint DC. As with `wx.BufferedDC`, you may either +provide the bitmap to be used for buffering or let this object create +one internally (in the latter case, the size of the client part of the +window is automatically used). + + @@ -10056,34 +11999,74 @@ __init__(DC dc, Size area) -> BufferedDC #--------------------------------------------------------------------------- - + + A wxScreenDC can be used to paint anywhere on the screen. This should +normally be constructed as a temporary stack object; don't store a +wxScreenDC object. + - __init__() -> ScreenDC + __init__(self) -> ScreenDC + A wxScreenDC can be used to paint anywhere on the screen. This should +normally be constructed as a temporary stack object; don't store a +wxScreenDC object. + - StartDrawingOnTopWin(Window window) -> bool + StartDrawingOnTopWin(self, Window window) -> bool + Specify that the area of the screen to be drawn upon coincides with +the given window. + +:see: `EndDrawingOnTop` - StartDrawingOnTop(Rect rect=None) -> bool + StartDrawingOnTop(self, Rect rect=None) -> bool + Specify that the area is the given rectangle, or the whole screen if +``None`` is passed. + +:see: `EndDrawingOnTop` - EndDrawingOnTop() -> bool + EndDrawingOnTop(self) -> bool + Use this in conjunction with `StartDrawingOnTop` or +`StartDrawingOnTopWin` to ensure that drawing to the screen occurs on +top of existing windows. Without this, some window systems (such as X) +only allow drawing to take place underneath other windows. + +You might use this pair of functions when implementing a drag feature, +for example as in the `wx.SplitterWindow` implementation. + +These functions are probably obsolete since the X implementations +allow drawing directly on the screen now. However, the fact that this +function allows the screen to be refreshed afterwards may be useful +to some applications. #--------------------------------------------------------------------------- - + + A wx.ClientDC must be constructed if an application wishes to paint on +the client area of a window from outside an EVT_PAINT event. This should +normally be constructed as a temporary stack object; don't store a +wx.ClientDC object long term. + +To draw on a window from within an EVT_PAINT handler, construct a +`wx.PaintDC` object. + +To draw on the whole window including decorations, construct a +`wx.WindowDC` object (Windows only). + - __init__(Window win) -> ClientDC + __init__(self, Window win) -> ClientDC + Constructor. Pass the window on which you wish to paint. @@ -10092,10 +12075,25 @@ __init__(DC dc, Size area) -> BufferedDC #--------------------------------------------------------------------------- - + + A wx.PaintDC must be constructed if an application wishes to paint on +the client area of a window from within an EVT_PAINT event +handler. This should normally be constructed as a temporary stack +object; don't store a wx.PaintDC object. If you have an EVT_PAINT +handler, you **must** create a wx.PaintDC object within it even if you +don't actually use it. + +Using wx.PaintDC within EVT_PAINT handlers is important because it +automatically sets the clipping area to the damaged area of the +window. Attempts to draw outside this area do not appear. + +To draw on a window from outside EVT_PAINT handlers, construct a +`wx.ClientDC` object. + - __init__(Window win) -> PaintDC + __init__(self, Window win) -> PaintDC + Constructor. Pass the window on which you wish to paint. @@ -10104,10 +12102,15 @@ __init__(DC dc, Size area) -> BufferedDC #--------------------------------------------------------------------------- - + + A wx.WindowDC must be constructed if an application wishes to paint on +the whole area of a window (client and decorations). This should +normally be constructed as a temporary stack object; don't store a +wx.WindowDC object. - __init__(Window win) -> WindowDC + __init__(self, Window win) -> WindowDC + Constructor. Pass the window on which you wish to paint. @@ -10116,10 +12119,19 @@ __init__(DC dc, Size area) -> BufferedDC #--------------------------------------------------------------------------- - + + wx.MirrorDC is a simple wrapper class which is always associated with a +real `wx.DC` object and either forwards all of its operations to it +without changes (no mirroring takes place) or exchanges x and y +coordinates which makes it possible to reuse the same code to draw a +figure and its mirror -- i.e. reflection related to the diagonal line +x == y. - __init__(DC dc, bool mirror) -> MirrorDC + __init__(self, DC dc, bool mirror) -> MirrorDC + Creates a mirrored DC associated with the real *dc*. Everything drawn +on the wx.MirrorDC will appear on the *dc*, and will be mirrored if +*mirror* is True. @@ -10129,49 +12141,55 @@ __init__(DC dc, Size area) -> BufferedDC #--------------------------------------------------------------------------- - + + This is a `wx.DC` that can write to PostScript files on any platform. - __init__(wxPrintData printData) -> PostScriptDC + __init__(self, wxPrintData printData) -> PostScriptDC + Constructs a PostScript printer device context from a `wx.PrintData` +object. - GetPrintData() -> wxPrintData + GetPrintData(self) -> wxPrintData - SetPrintData(wxPrintData data) + SetPrintData(self, wxPrintData data) SetResolution(int ppi) + Set resolution (in pixels per inch) that will be used in PostScript +output. Default is 720ppi. GetResolution() -> int + Return resolution used in PostScript output. #--------------------------------------------------------------------------- - + - __init__(String filename=EmptyString) -> MetaFile + __init__(self, String filename=EmptyString) -> MetaFile - + - __init__(String filename=EmptyString, int width=0, int height=0, + __init__(self, String filename=EmptyString, int width=0, int height=0, String description=EmptyString) -> MetaFileDC @@ -10181,274 +12199,22 @@ __init__(DC dc, Size area) -> BufferedDC - + - __init__(wxPrintData printData) -> PrinterDC + __init__(self, wxPrintData printData) -> PrinterDC - 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 - - - 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 - - - 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 - - - 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 - - - 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 - - - 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 - - - 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 - - - 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 - - - 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 - - - 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 - - - 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 - - - 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 - - #--------------------------------------------------------------------------- - + - __init__(int width, int height, int mask=True, int initialCount=1) -> ImageList + __init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList @@ -10457,37 +12223,37 @@ __init__(DC dc, Size area) -> BufferedDC - __del__() + __del__(self) - Add(Bitmap bitmap, Bitmap mask=NullBitmap) -> int + Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int - AddWithColourMask(Bitmap bitmap, Colour maskColour) -> int + AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int - AddIcon(Icon icon) -> int + AddIcon(self, Icon icon) -> int - Replace(int index, Bitmap bitmap) -> bool + Replace(self, int index, Bitmap bitmap) -> bool - Draw(int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL, + Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL, bool solidBackground=False) -> bool @@ -10499,16 +12265,16 @@ __init__(DC dc, Size area) -> BufferedDC - GetImageCount() -> int + GetImageCount(self) -> int - Remove(int index) -> bool + Remove(self, int index) -> bool - RemoveAll() -> bool + RemoveAll(self) -> bool GetSize() -> (width,height) @@ -10522,16 +12288,16 @@ __init__(DC dc, Size area) -> BufferedDC #--------------------------------------------------------------------------- - + - AddPen(Pen pen) + AddPen(self, Pen pen) - FindOrCreatePen(Colour colour, int width, int style) -> Pen + FindOrCreatePen(self, Colour colour, int width, int style) -> Pen @@ -10539,69 +12305,69 @@ __init__(DC dc, Size area) -> BufferedDC - RemovePen(Pen pen) + RemovePen(self, Pen pen) - GetCount() -> int + GetCount(self) -> int - + - AddBrush(Brush brush) + AddBrush(self, Brush brush) - FindOrCreateBrush(Colour colour, int style) -> Brush + FindOrCreateBrush(self, Colour colour, int style) -> Brush - RemoveBrush(Brush brush) + RemoveBrush(self, Brush brush) - GetCount() -> int + GetCount(self) -> int - + - __init__() -> ColourDatabase + __init__(self) -> ColourDatabase - __del__() + __del__(self) - Find(String name) -> Colour + Find(self, String name) -> Colour - FindName(Colour colour) -> String + FindName(self, Colour colour) -> String - AddColour(String name, Colour colour) + AddColour(self, String name, Colour colour) - Append(String name, int red, int green, int blue) + Append(self, String name, int red, int green, int blue) @@ -10610,16 +12376,16 @@ __init__(DC dc, Size area) -> BufferedDC - + - AddFont(Font font) + AddFont(self, Font font) - FindOrCreateFont(int point_size, int family, int style, int weight, + FindOrCreateFont(self, int point_size, int family, int style, int weight, bool underline=False, String facename=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font @@ -10633,13 +12399,13 @@ __init__(DC dc, Size area) -> BufferedDC - RemoveFont(Font font) + RemoveFont(self, Font font) - GetCount() -> int + GetCount(self) -> int @@ -10649,58 +12415,58 @@ __init__(DC dc, Size area) -> BufferedDC #--------------------------------------------------------------------------- - + - __init__() -> Effects + __init__(self) -> Effects - GetHighlightColour() -> Colour + GetHighlightColour(self) -> Colour - GetLightShadow() -> Colour + GetLightShadow(self) -> Colour - GetFaceColour() -> Colour + GetFaceColour(self) -> Colour - GetMediumShadow() -> Colour + GetMediumShadow(self) -> Colour - GetDarkShadow() -> Colour + GetDarkShadow(self) -> Colour - SetHighlightColour(Colour c) + SetHighlightColour(self, Colour c) - SetLightShadow(Colour c) + SetLightShadow(self, Colour c) - SetFaceColour(Colour c) + SetFaceColour(self, Colour c) - SetMediumShadow(Colour c) + SetMediumShadow(self, Colour c) - SetDarkShadow(Colour c) + SetDarkShadow(self, Colour c) - Set(Colour highlightColour, Colour lightShadow, Colour faceColour, + Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour, Colour mediumShadow, Colour darkShadow) @@ -10711,7 +12477,7 @@ __init__(DC dc, Size area) -> BufferedDC - DrawSunkenEdge(DC dc, Rect rect, int borderSize=1) + DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1) @@ -10719,7 +12485,7 @@ __init__(DC dc, Size area) -> BufferedDC - TileBitmap(Rect rect, DC dc, Bitmap bitmap) -> bool + TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool @@ -10728,16 +12494,16 @@ __init__(DC dc, Size area) -> BufferedDC - - - wx = core + + + wx = _core #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, String name=PanelNameStr) -> Panel @@ -10753,13 +12519,13 @@ __init__(DC dc, Size area) -> BufferedDC PrePanel() -> Panel - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxTAB_TRAVERSAL|wxNO_BORDER, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, String name=PanelNameStr) -> bool Create the GUI part of the Window for 2-phase creation mode. - + @@ -10767,16 +12533,34 @@ __init__(DC dc, Size area) -> BufferedDC - InitDialog() + InitDialog(self) + Sends an EVT_INIT_DIALOG event, whose handler usually transfers data +to the dialog via validators. + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL, String name=PanelNameStr) -> ScrolledWindow @@ -10792,7 +12576,7 @@ __init__(DC dc, Size area) -> BufferedDC PreScrolledWindow() -> ScrolledWindow - Create(Window parent, int id=-1, Point pos=DefaultPosition, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL, String name=PanelNameStr) -> bool Create the GUI part of the Window for 2-phase creation mode. @@ -10806,7 +12590,7 @@ __init__(DC dc, Size area) -> BufferedDC - SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX, + SetScrollbars(self, int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX, int noUnitsY, int xPos=0, int yPos=0, bool noRefresh=False) @@ -10819,27 +12603,27 @@ __init__(DC dc, Size area) -> BufferedDC - Scroll(int x, int y) + Scroll(self, int x, int y) - GetScrollPageSize(int orient) -> int + GetScrollPageSize(self, int orient) -> int - SetScrollPageSize(int orient, int pageSize) + SetScrollPageSize(self, int orient, int pageSize) - SetScrollRate(int xstep, int ystep) + SetScrollRate(self, int xstep, int ystep) @@ -10854,7 +12638,7 @@ __init__(DC dc, Size area) -> BufferedDC - EnableScrolling(bool x_scrolling, bool y_scrolling) + EnableScrolling(self, bool x_scrolling, bool y_scrolling) @@ -10869,17 +12653,17 @@ __init__(DC dc, Size area) -> BufferedDC - SetScale(double xs, double ys) + SetScale(self, double xs, double ys) - GetScaleX() -> double + GetScaleX(self) -> double - GetScaleY() -> double + GetScaleY(self) -> double Translate between scrolled and unscrolled coordinates. @@ -10888,7 +12672,7 @@ __init__(DC dc, Size area) -> BufferedDC - CalcScrolledPosition(Point pt) -> Point + CalcScrolledPosition(self, Point pt) -> Point CalcScrolledPosition(int x, int y) -> (sx, sy) Translate between scrolled and unscrolled coordinates. @@ -10905,7 +12689,7 @@ CalcScrolledPosition(int x, int y) -> (sx, sy) - CalcUnscrolledPosition(Point pt) -> Point + CalcUnscrolledPosition(self, Point pt) -> Point CalcUnscrolledPosition(int x, int y) -> (ux, uy) Translate between scrolled and unscrolled coordinates. @@ -10916,88 +12700,111 @@ CalcUnscrolledPosition(int x, int y) -> (ux, uy) - AdjustScrollbars() + AdjustScrollbars(self) - CalcScrollInc(ScrollWinEvent event) -> int + CalcScrollInc(self, ScrollWinEvent event) -> int - SetTargetWindow(Window target) + SetTargetWindow(self, Window target) - GetTargetWindow() -> Window + GetTargetWindow(self) -> Window + + + DoPrepareDC(self, DC dc) + Normally what is called by `PrepareDC`. + + + + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - Maximize(bool maximize=True) + Maximize(self, bool maximize=True) - Restore() + Restore(self) - Iconize(bool iconize=True) + Iconize(self, bool iconize=True) - IsMaximized() -> bool + IsMaximized(self) -> bool - IsIconized() -> bool + IsIconized(self) -> bool - GetIcon() -> Icon + GetIcon(self) -> Icon - SetIcon(Icon icon) + SetIcon(self, Icon icon) - SetIcons(wxIconBundle icons) + SetIcons(self, wxIconBundle icons) - ShowFullScreen(bool show, long style=FULLSCREEN_ALL) -> bool + ShowFullScreen(self, bool show, long style=FULLSCREEN_ALL) -> bool - IsFullScreen() -> bool + IsFullScreen(self) -> bool - SetTitle(String title) + SetTitle(self, String title) Sets the window's title. Applicable only to frames and dialogs. - GetTitle() -> String + GetTitle(self) -> String Gets the window's title. Applicable only to frames and dialogs. - SetShape(Region region) -> bool + SetShape(self, Region region) -> bool @@ -11006,16 +12813,16 @@ CalcUnscrolledPosition(int x, int y) -> (ux, uy) #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, - String name=FrameNameStr) -> Frame + __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 - - + + @@ -11026,13 +12833,13 @@ CalcUnscrolledPosition(int x, int y) -> (ux, uy) PreFrame() -> Frame - Create(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, - String name=FrameNameStr) -> bool + 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 - - + + @@ -11040,31 +12847,31 @@ CalcUnscrolledPosition(int x, int y) -> (ux, uy) - GetClientAreaOrigin() -> Point + GetClientAreaOrigin(self) -> Point 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...) - SendSizeEvent() + SendSizeEvent(self) - SetMenuBar(MenuBar menubar) + SetMenuBar(self, MenuBar menubar) - GetMenuBar() -> MenuBar + GetMenuBar(self) -> MenuBar - ProcessCommand(int winid) -> bool + ProcessCommand(self, int winid) -> bool - CreateStatusBar(int number=1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE, + CreateStatusBar(self, int number=1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE, int winid=0, String name=StatusLineNameStr) -> StatusBar @@ -11074,52 +12881,52 @@ the borders, scrollbars, other decorations...) - GetStatusBar() -> StatusBar + GetStatusBar(self) -> StatusBar - SetStatusBar(StatusBar statBar) + SetStatusBar(self, StatusBar statBar) - SetStatusText(String text, int number=0) + SetStatusText(self, String text, int number=0) - SetStatusWidths(int widths, int widths_field) + SetStatusWidths(self, int widths, int widths_field) - PushStatusText(String text, int number=0) + PushStatusText(self, String text, int number=0) - PopStatusText(int number=0) + PopStatusText(self, int number=0) - SetStatusBarPane(int n) + SetStatusBarPane(self, int n) - GetStatusBarPane() -> int + GetStatusBarPane(self) -> int - CreateToolBar(long style=-1, int winid=-1, String name=ToolBarNameStr) -> wxToolBar + CreateToolBar(self, long style=-1, int winid=-1, String name=ToolBarNameStr) -> wxToolBar @@ -11127,41 +12934,57 @@ the borders, scrollbars, other decorations...) - GetToolBar() -> wxToolBar + GetToolBar(self) -> wxToolBar - SetToolBar(wxToolBar toolbar) + SetToolBar(self, wxToolBar toolbar) - DoGiveHelp(String text, bool show) + DoGiveHelp(self, String text, bool show) - DoMenuUpdates(Menu menu=None) + DoMenuUpdates(self, Menu menu=None) + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_DIALOG_STYLE, - String name=DialogNameStr) -> Dialog + __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 - - + + @@ -11172,13 +12995,13 @@ the borders, scrollbars, other decorations...) PreDialog() -> Dialog - Create(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_DIALOG_STYLE, - String name=DialogNameStr) -> bool + 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 - - + + @@ -11186,55 +13009,68 @@ the borders, scrollbars, other decorations...) - SetReturnCode(int returnCode) + SetReturnCode(self, int returnCode) - GetReturnCode() -> int + GetReturnCode(self) -> int - CreateTextSizer(String message) -> Sizer + CreateTextSizer(self, String message) -> Sizer - CreateButtonSizer(long flags) -> Sizer + CreateButtonSizer(self, long flags) -> Sizer - IsModal() -> bool + IsModal(self) -> bool - ShowModal() -> int + ShowModal(self) -> int - EndModal(int retCode) + EndModal(self, int retCode) - - IsModalShowing() -> bool - + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, - String name=FrameNameStr) -> MiniFrame + __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 - - + + @@ -11245,13 +13081,13 @@ the borders, scrollbars, other decorations...) PreMiniFrame() -> MiniFrame - Create(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, - String name=FrameNameStr) -> bool + 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 - - + + @@ -11262,10 +13098,10 @@ the borders, scrollbars, other decorations...) #--------------------------------------------------------------------------- - + - __init__(Bitmap bitmap, Window parent, int id, Point pos=DefaultPosition, + __init__(self, Bitmap bitmap, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, long style=NO_BORDER) -> SplashScreenWindow @@ -11277,49 +13113,49 @@ the borders, scrollbars, other decorations...) - SetBitmap(Bitmap bitmap) + SetBitmap(self, Bitmap bitmap) - GetBitmap() -> Bitmap + GetBitmap(self) -> Bitmap - + - __init__(Bitmap bitmap, long splashStyle, int milliseconds, - Window parent, int id, Point pos=DefaultPosition, + __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 - + - GetSplashStyle() -> long + GetSplashStyle(self) -> long - GetSplashWindow() -> SplashScreenWindow + GetSplashWindow(self) -> SplashScreenWindow - GetTimeout() -> int + GetTimeout(self) -> int #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=-1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE, + __init__(self, Window parent, int id=-1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE, String name=StatusLineNameStr) -> StatusBar @@ -11332,85 +13168,109 @@ the borders, scrollbars, other decorations...) PreStatusBar() -> StatusBar - Create(Window parent, int id, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> bool + Create(self, Window parent, int id=-1, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> bool - + - SetFieldsCount(int number=1) + SetFieldsCount(self, int number=1) - GetFieldsCount() -> int + GetFieldsCount(self) -> int - SetStatusText(String text, int number=0) + SetStatusText(self, String text, int number=0) - GetStatusText(int number=0) -> String + GetStatusText(self, int number=0) -> String - PushStatusText(String text, int number=0) + PushStatusText(self, String text, int number=0) - PopStatusText(int number=0) + PopStatusText(self, int number=0) - SetStatusWidths(int widths, int widths_field) + SetStatusWidths(self, int widths, int widths_field) + + SetStatusStyles(self, int styles, int styles_field) + + + + + - GetFieldRect(int i) -> Rect + GetFieldRect(self, int i) -> Rect - SetMinHeight(int height) + SetMinHeight(self, int height) - GetBorderX() -> int + GetBorderX(self) -> int - GetBorderY() -> int + GetBorderY(self) -> int + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - - 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. - - - Styles + + 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. + +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. @@ -11425,43 +13285,45 @@ used with the mouse or programmatically. 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. + ==================== ====================================== + +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.) - - + 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.) + ============================== ======================================= + + - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=SP_3D, String name=SplitterNameStr) -> SplitterWindow + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=SP_3D, String name=SplitterNameStr) -> SplitterWindow Constructor. Creates and shows a SplitterWindow. - + @@ -11473,12 +13335,12 @@ used with the mouse or programmatically. Precreate a SplitterWindow for 2-phase creation. - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=SP_3D, String name=SplitterNameStr) -> bool + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=SP_3D, String name=SplitterNameStr) -> bool Create the GUI part of the SplitterWindow for the 2-phase create. - + @@ -11486,56 +13348,55 @@ used with the mouse or programmatically. - GetWindow1() -> Window + GetWindow1(self) -> Window Gets the only or left/top pane. - GetWindow2() -> Window + GetWindow2(self) -> Window Gets the right/bottom pane. - SetSplitMode(int mode) + SetSplitMode(self, int mode) 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. +wx.SPLIT_HORIZONTAL. This only sets the internal variable; does not +update the display. - GetSplitMode() -> int + GetSplitMode(self) -> int Gets the split mode - Initialize(Window window) - 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. + Initialize(self, Window window) + 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. - SplitVertically(Window window1, Window window2, int sashPosition=0) -> bool + SplitVertically(self, Window window1, Window window2, int sashPosition=0) -> bool 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. + :param window1: The left pane. + :param window2: The right pane. + :param 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. + @@ -11543,26 +13404,25 @@ not currently split using IsSplit. - SplitHorizontally(Window window1, Window window2, int sashPosition=0) -> bool + SplitHorizontally(self, Window window1, Window window2, int sashPosition=0) -> bool 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 + :param window1: The top pane. + :param window2: The bottom pane. + :param 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). +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. +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. + @@ -11570,10 +13430,10 @@ not currently split using IsSplit. - Unsplit(Window toRemove=None) -> bool - 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). + Unsplit(self, Window toRemove=None) -> bool + 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 @@ -11584,98 +13444,94 @@ removed is only hidden. - ReplaceWindow(Window winOld, Window winNew) -> bool + ReplaceWindow(self, Window winOld, Window winNew) -> bool 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. +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. - UpdateSize() - 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. + UpdateSize(self) + 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. - IsSplit() -> bool + IsSplit(self) -> bool Is the window split? - SetSashSize(int width) + SetSashSize(self, int width) Sets the sash size - SetBorderSize(int width) + SetBorderSize(self, int width) Sets the border size - GetSashSize() -> int + GetSashSize(self) -> int Gets the sash size - GetBorderSize() -> int + GetBorderSize(self) -> int Gets the border size - SetSashPosition(int position, bool redraw=True) - Sets the sash position, in pixels. If redraw is Ttrue then -the panes are resized and the sash and border are redrawn. + SetSashPosition(self, int position, bool redraw=True) + Sets the sash position, in pixels. If redraw is Ttrue then the panes +are resized and the sash and border are redrawn. - GetSashPosition() -> int + GetSashPosition(self) -> int Returns the surrent sash position. - SetMinimumPaneSize(int min) + SetMinimumPaneSize(self, int min) 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. +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. - GetMinimumPaneSize() -> int + GetMinimumPaneSize(self) -> int Gets the minimum pane size in pixels. - SashHitTest(int x, int y, int tolerance=5) -> bool + SashHitTest(self, int x, int y, int tolerance=5) -> bool Tests for x, y over the sash @@ -11684,24 +13540,40 @@ unsplit even if minimum size is non-zero. - SizeWindows() + SizeWindows(self) Resizes subwindows - SetNeedUpdating(bool needUpdating) + SetNeedUpdating(self, bool needUpdating) - GetNeedUpdating() -> bool + GetNeedUpdating(self) -> bool + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + - + This class represents the events generated by a splitter control. - __init__(wxEventType type=wxEVT_NULL, SplitterWindow splitter=(wxSplitterWindow *) NULL) -> SplitterEvent + __init__(self, wxEventType type=wxEVT_NULL, SplitterWindow splitter=(wxSplitterWindow *) NULL) -> SplitterEvent This class represents the events generated by a splitter control. @@ -11709,37 +13581,34 @@ unsplit even if minimum size is non-zero. - SetSashPosition(int pos) - 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. + SetSashPosition(self, int pos) + 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. - GetSashPosition() -> int - Returns the new sash position while in -EVT_SPLITTER_SASH_POS_CHANGING and -EVT_SPLITTER_SASH_POS_CHANGED events. + GetSashPosition(self) -> int + Returns the new sash position while in EVT_SPLITTER_SASH_POS_CHANGING +and EVT_SPLITTER_SASH_POS_CHANGED events. - GetWindowBeingRemoved() -> Window - Returns a pointer to the window being removed when a -splitter window is unsplit. + GetWindowBeingRemoved(self) -> Window + Returns a pointer to the window being removed when a splitter window +is unsplit. - GetX() -> int + GetX(self) -> int Returns the x coordinate of the double-click point in a EVT_SPLITTER_DCLICK event. - GetY() -> int + GetY(self) -> int Returns the y coordinate of the double-click point in a EVT_SPLITTER_DCLICK event. @@ -11754,15 +13623,15 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCLIP_CHILDREN|wxSW_3D, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, String name=SashNameStr) -> SashWindow - + @@ -11773,12 +13642,12 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED PreSashWindow() -> SashWindow - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCLIP_CHILDREN|wxSW_3D, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, String name=SashNameStr) -> bool - + @@ -11786,93 +13655,93 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED - SetSashVisible(int edge, bool sash) + SetSashVisible(self, int edge, bool sash) - GetSashVisible(int edge) -> bool + GetSashVisible(self, int edge) -> bool - SetSashBorder(int edge, bool border) + SetSashBorder(self, int edge, bool border) - HasBorder(int edge) -> bool + HasBorder(self, int edge) -> bool - GetEdgeMargin(int edge) -> int + GetEdgeMargin(self, int edge) -> int - SetDefaultBorderSize(int width) + SetDefaultBorderSize(self, int width) - GetDefaultBorderSize() -> int + GetDefaultBorderSize(self) -> int - SetExtraBorderSize(int width) + SetExtraBorderSize(self, int width) - GetExtraBorderSize() -> int + GetExtraBorderSize(self) -> int - SetMinimumSizeX(int min) + SetMinimumSizeX(self, int min) - SetMinimumSizeY(int min) + SetMinimumSizeY(self, int min) - GetMinimumSizeX() -> int + GetMinimumSizeX(self) -> int - GetMinimumSizeY() -> int + GetMinimumSizeY(self) -> int - SetMaximumSizeX(int max) + SetMaximumSizeX(self, int max) - SetMaximumSizeY(int max) + SetMaximumSizeY(self, int max) - GetMaximumSizeX() -> int + GetMaximumSizeX(self) -> int - GetMaximumSizeY() -> int + GetMaximumSizeY(self) -> int - SashHitTest(int x, int y, int tolerance=2) -> int + SashHitTest(self, int x, int y, int tolerance=2) -> int @@ -11880,44 +13749,44 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED - SizeWindows() + SizeWindows(self) - + - __init__(int id=0, int edge=SASH_NONE) -> SashEvent + __init__(self, int id=0, int edge=SASH_NONE) -> SashEvent - SetEdge(int edge) + SetEdge(self, int edge) - GetEdge() -> int + GetEdge(self) -> int - SetDragRect(Rect rect) + SetDragRect(self, Rect rect) - GetDragRect() -> Rect + GetDragRect(self) -> Rect - SetDragStatus(int status) + SetDragStatus(self, int status) - GetDragStatus() -> int + GetDragStatus(self) -> int @@ -11927,100 +13796,100 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED #--------------------------------------------------------------------------- - + - __init__(int id=0) -> QueryLayoutInfoEvent + __init__(self, int id=0) -> QueryLayoutInfoEvent - SetRequestedLength(int length) + SetRequestedLength(self, int length) - GetRequestedLength() -> int + GetRequestedLength(self) -> int - SetFlags(int flags) + SetFlags(self, int flags) - GetFlags() -> int + GetFlags(self) -> int - SetSize(Size size) + SetSize(self, Size size) - GetSize() -> Size + GetSize(self) -> Size - SetOrientation(int orient) + SetOrientation(self, int orient) - GetOrientation() -> int + GetOrientation(self) -> int - SetAlignment(int align) + SetAlignment(self, int align) - GetAlignment() -> int + GetAlignment(self) -> int - + - __init__(int id=0) -> CalculateLayoutEvent + __init__(self, int id=0) -> CalculateLayoutEvent - SetFlags(int flags) + SetFlags(self, int flags) - GetFlags() -> int + GetFlags(self) -> int - SetRect(Rect rect) + SetRect(self, Rect rect) - GetRect() -> Rect + GetRect(self) -> Rect EVT_QUERY_LAYOUT_INFO = wx.PyEventBinder( wxEVT_QUERY_LAYOUT_INFO ) EVT_CALCULATE_LAYOUT = wx.PyEventBinder( wxEVT_CALCULATE_LAYOUT ) - + - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCLIP_CHILDREN|wxSW_3D, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, String name=SashLayoutNameStr) -> SashLayoutWindow - + @@ -12031,12 +13900,12 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED PreSashLayoutWindow() -> SashLayoutWindow - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCLIP_CHILDREN|wxSW_3D, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, String name=SashLayoutNameStr) -> bool - + @@ -12044,54 +13913,54 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED - GetAlignment() -> int + GetAlignment(self) -> int - GetOrientation() -> int + GetOrientation(self) -> int - SetAlignment(int alignment) + SetAlignment(self, int alignment) - SetDefaultSize(Size size) + SetDefaultSize(self, Size size) - SetOrientation(int orientation) + SetOrientation(self, int orientation) - + - __init__() -> LayoutAlgorithm + __init__(self) -> LayoutAlgorithm - __del__() + __del__(self) - LayoutMDIFrame(MDIParentFrame frame, Rect rect=None) -> bool + LayoutMDIFrame(self, MDIParentFrame frame, Rect rect=None) -> bool - LayoutFrame(Frame frame, Window mainWindow=None) -> bool + LayoutFrame(self, Frame frame, Window mainWindow=None) -> bool - LayoutWindow(Window parent, Window mainWindow=None) -> bool + LayoutWindow(self, Window parent, Window mainWindow=None) -> bool @@ -12101,10 +13970,10 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED #--------------------------------------------------------------------------- - + - __init__(Window parent, int flags=BORDER_NONE) -> PopupWindow + __init__(self, Window parent, int flags=BORDER_NONE) -> PopupWindow @@ -12114,14 +13983,14 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED PrePopupWindow() -> PopupWindow - Create(Window parent, int flags=BORDER_NONE) -> bool + Create(self, Window parent, int flags=BORDER_NONE) -> bool - Position(Point ptOrigin, Size size) + Position(self, Point ptOrigin, Size size) @@ -12131,10 +14000,10 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED #--------------------------------------------------------------------------- - + - __init__(Window parent, int style=BORDER_NONE) -> PopupTransientWindow + __init__(self, Window parent, int style=BORDER_NONE) -> PopupTransientWindow @@ -12144,29 +14013,29 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED PrePopupTransientWindow() -> PopupTransientWindow - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - Popup(Window focus=None) + Popup(self, Window focus=None) - Dismiss() + Dismiss(self) #--------------------------------------------------------------------------- - + - __init__(Window parent, String text, int maxLength=100, Rect rectBound=None) -> TipWindow + __init__(self, Window parent, String text, int maxLength=100, Rect rectBound=None) -> TipWindow @@ -12175,22 +14044,22 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED - SetBoundingRect(Rect rectBound) + SetBoundingRect(self, Rect rectBound) - Close() + Close(self) #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=ID_ANY, Point pos=DefaultPosition, + __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=PanelNameStr) -> VScrolledWindow @@ -12205,14 +14074,14 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED PreVScrolledWindow() -> VScrolledWindow - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - Create(Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool @@ -12224,19 +14093,19 @@ EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED - SetLineCount(size_t count) + SetLineCount(self, size_t count) - ScrollToLine(size_t line) -> bool + ScrollToLine(self, size_t line) -> bool - ScrollLines(int lines) -> bool + ScrollLines(self, int lines) -> bool 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 @@ -12246,8 +14115,8 @@ already on top/bottom and nothing was done. - ScrollPages(int pages) -> bool - If the platform and window class supports it, scrolls the window by + ScrollPages(self, int pages) -> bool + 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. @@ -12256,20 +14125,20 @@ already on top/bottom and nothing was done. - RefreshLine(size_t line) + RefreshLine(self, size_t line) - RefreshLines(size_t from, size_t to) + RefreshLines(self, size_t from, size_t to) - - HitTestXT(int x, int y) -> int + + HitTestXY(self, int x, int y) -> int Test where the given (in client coords) point lies @@ -12277,35 +14146,35 @@ already on top/bottom and nothing was done. - HitTest(Point pt) -> int + HitTest(self, Point pt) -> int Test where the given (in client coords) point lies - RefreshAll() + RefreshAll(self) - GetLineCount() -> size_t + GetLineCount(self) -> size_t - GetFirstVisibleLine() -> size_t + GetFirstVisibleLine(self) -> size_t - GetLastVisibleLine() -> size_t + GetLastVisibleLine(self) -> size_t - IsVisible(size_t line) -> bool + IsVisible(self, size_t line) -> bool - + - __init__(Window parent, int id=ID_ANY, Point pos=DefaultPosition, + __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> VListBox @@ -12320,14 +14189,14 @@ already on top/bottom and nothing was done. PreVListBox() -> VListBox - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - Create(Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool @@ -12339,112 +14208,109 @@ already on top/bottom and nothing was done. - GetItemCount() -> size_t + GetItemCount(self) -> size_t - HasMultipleSelection() -> bool + HasMultipleSelection(self) -> bool - GetSelection() -> int + GetSelection(self) -> int - IsCurrent(size_t item) -> bool + IsCurrent(self, size_t item) -> bool - IsSelected(size_t item) -> bool + IsSelected(self, size_t item) -> bool - GetSelectedCount() -> size_t + GetSelectedCount(self) -> size_t - - GetFirstSelected(unsigned long cookie) -> int - - - + + GetFirstSelected(self) -> PyObject - - GetNextSelected(unsigned long cookie) -> int + + GetNextSelected(self, unsigned long cookie) -> PyObject - GetMargins() -> Point + GetMargins(self) -> Point - GetSelectionBackground() -> Colour + GetSelectionBackground(self) -> Colour - SetItemCount(size_t count) + SetItemCount(self, size_t count) - Clear() + Clear(self) - SetSelection(int selection) + SetSelection(self, int selection) - Select(size_t item, bool select=True) -> bool + Select(self, size_t item, bool select=True) -> bool - SelectRange(size_t from, size_t to) -> bool + SelectRange(self, size_t from, size_t to) -> bool - Toggle(size_t item) + Toggle(self, size_t item) - SelectAll() -> bool + SelectAll(self) -> bool - DeselectAll() -> bool + DeselectAll(self) -> bool - SetMargins(Point pt) + SetMargins(self, Point pt) - SetMarginsXY(int x, int y) + SetMarginsXY(self, int x, int y) - SetSelectionBackground(Colour col) + SetSelectionBackground(self, Colour col) - + - __init__(Window parent, int id=ID_ANY, Point pos=DefaultPosition, + __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> HtmlListBox @@ -12459,14 +14325,14 @@ already on top/bottom and nothing was done. PreHtmlListBox() -> HtmlListBox - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - Create(Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool @@ -12478,53 +14344,60 @@ already on top/bottom and nothing was done. - RefreshAll() + RefreshAll(self) - SetItemCount(size_t count) + SetItemCount(self, size_t count) + + GetFileSystem(self) -> FileSystem + #--------------------------------------------------------------------------- - + - __init__() -> TaskBarIcon + __init__(self) -> TaskBarIcon - __del__() + __del__(self) + + Destroy(self) + Deletes the C++ object this Python object is a proxy for. + - IsOk() -> bool + IsOk(self) -> bool - IsIconInstalled() -> bool + IsIconInstalled(self) -> bool - SetIcon(Icon icon, String tooltip=EmptyString) -> bool + SetIcon(self, Icon icon, String tooltip=EmptyString) -> bool - RemoveIcon() -> bool + RemoveIcon(self) -> bool - PopupMenu(Menu menu) -> bool + PopupMenu(self, Menu menu) -> bool - + - __init__(wxEventType evtType, TaskBarIcon tbIcon) -> TaskBarIconEvent + __init__(self, wxEventType evtType, TaskBarIcon tbIcon) -> TaskBarIconEvent @@ -12543,88 +14416,98 @@ EVT_TASKBAR_RIGHT_DCLICK = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_DCLICK ) #--------------------------------------------------------------------------- - - This class holds a variety of information related to colour dialogs. + + 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`. - __init__() -> ColourData + __init__(self) -> ColourData Constructor, sets default values. - __del__() + __del__(self) - GetChooseFull() -> bool - 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. + GetChooseFull(self) -> bool + 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. - GetColour() -> Colour + GetColour(self) -> Colour Gets the colour (pre)selected by the dialog. - GetCustomColour(int i) -> Colour - 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. + GetCustomColour(self, int i) -> Colour + 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. - SetChooseFull(int flag) - 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. + SetChooseFull(self, int flag) + 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. - SetColour(Colour colour) - Sets the default colour for the colour dialog. The default colour is black. + SetColour(self, Colour colour) + Sets the default colour for the colour dialog. The default colour is +black. - SetCustomColour(int i, Colour colour) - 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. + SetCustomColour(self, int i, Colour colour) + 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. - + This class represents the colour chooser dialog. - __init__(Window parent, ColourData data=None) -> ColourDialog - Constructor. Pass a parent window, and optionally a ColourData, which -will be copied to the colour dialog's internal ColourData instance. + __init__(self, Window parent, ColourData data=None) -> ColourDialog + Constructor. Pass a parent window, and optionally a `wx.ColourData`, +which will be copied to the colour dialog's internal ColourData +instance. - GetColourData() -> ColourData - Returns a reference to the ColourData used by the dialog. - - - - This class represents the directory chooser dialog. - - 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. + GetColourData(self) -> ColourData + Returns a reference to the `wx.ColourData` used by the dialog. + + + + wx.DirDialog allows the user to select a directory by browising the +file system. + +Window Styles +-------------- + ==================== ========================================== + wx.DD_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. + ==================== ========================================== + - __init__(Window parent, String message=DirSelectorPromptStr, + __init__(self, Window parent, String message=DirSelectorPromptStr, String defaultPath=EmptyString, long style=0, Point pos=DefaultPosition, Size size=DefaultSize, String name=DirDialogNameStr) -> DirDialog @@ -12640,70 +14523,77 @@ will be copied to the colour dialog's internal ColourData instance. - GetPath() -> String + GetPath(self) -> String Returns the default or user-selected path. - GetMessage() -> String + GetMessage(self) -> String Returns the message that will be displayed on the dialog. - GetStyle() -> long + GetStyle(self) -> long Returns the dialog style. - SetMessage(String message) + SetMessage(self, String message) Sets the message that will be displayed on the dialog. - SetPath(String path) + SetPath(self, String path) Sets the default path. - - This class represents the file chooser dialog. - -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. + + wx.FileDialog allows the user to select one or more files from the +filesystem. -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: +In Windows, this is the common file selector dialog. On X based +platforms a generic alternative is used. 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. +Window 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.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.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.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. - + wx.CHANGE_DIR Change the current working directory to the + directory where the file(s) chosen by the user + are. + =================== ========================================== + - __init__(Window parent, String message=FileSelectorPromptStr, + __init__(self, Window parent, String message=FileSelectorPromptStr, String defaultDir=EmptyString, String defaultFile=EmptyString, String wildcard=FileSelectorDefaultWildcardStr, long style=0, Point pos=DefaultPosition) -> FileDialog @@ -12719,101 +14609,104 @@ for each, such as: - SetMessage(String message) + SetMessage(self, String message) Sets the message that will be displayed on the dialog. - SetPath(String path) - Sets the path (the combined directory and filename that will -be returned when the dialog is dismissed). + SetPath(self, String path) + Sets the path (the combined directory and filename that will be +returned when the dialog is dismissed). - SetDirectory(String dir) + SetDirectory(self, String dir) Sets the default directory. - SetFilename(String name) + SetFilename(self, String name) Sets the default filename. - SetWildcard(String wildCard) - Sets the wildcard, which can contain multiple file types, for example: - "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" + SetWildcard(self, String wildCard) + Sets the wildcard, which can contain multiple file types, for +example:: + + "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" + - SetStyle(long style) + SetStyle(self, long style) Sets the dialog style. - SetFilterIndex(int filterIndex) + SetFilterIndex(self, int filterIndex) Sets the default filter index, starting from zero. - GetMessage() -> String + GetMessage(self) -> String Returns the message that will be displayed on the dialog. - GetPath() -> String + GetPath(self) -> String Returns the full path (directory and filename) of the selected file. - GetDirectory() -> String + GetDirectory(self) -> String Returns the default directory. - GetFilename() -> String + GetFilename(self) -> String Returns the default filename. - GetWildcard() -> String + GetWildcard(self) -> String Returns the file dialog wildcard. - GetStyle() -> long + GetStyle(self) -> long Returns the dialog style. - GetFilterIndex() -> int + GetFilterIndex(self) -> int 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. +which will be used when the dialog is first displayed. After the +dialog is shown, this is the index selected by the user. - GetFilenames() -> PyObject - Returns a list of filenames chosen in the dialog. This function should -only be used with the dialogs which have wx.MULTIPLE style, use + GetFilenames(self) -> PyObject + 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. - GetPaths() -> PyObject + GetPaths(self) -> PyObject 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. +function should only be used with the dialogs which have wx.MULTIPLE +style, use GetPath for the others. - + A simple dialog with a multi selection listbox. @@ -12826,14 +14719,15 @@ use GetPath for the others. - + SetSelections(List selections) - Specify the items in the list that shoudl be selected, using a list of integers. + Specify the items in the list that should be selected, using a list of +integers. @@ -12843,7 +14737,7 @@ use GetPath for the others. Returns a list of integers representing the items that are selected. - + A simple dialog with a single selection listbox. @@ -12862,26 +14756,26 @@ use GetPath for the others. - GetSelection() -> int + GetSelection(self) -> int Get the index of teh currently selected item. - GetStringSelection() -> String + GetStringSelection(self) -> String Returns the string value of the currently selected item - SetSelection(int sel) + SetSelection(self, int sel) Set the current selected item to sel - + A dialog with text control, [ok] and [cancel] buttons - __init__(Window parent, String message, String caption=GetTextFromUserPromptStr, + __init__(self, Window parent, String message, String caption=GetTextFromUserPromptStr, String defaultValue=EmptyString, long style=wxOK|wxCANCEL|wxCENTRE, Point pos=DefaultPosition) -> TextEntryDialog Constructor. Use ShowModal method to show the dialog. @@ -12895,163 +14789,169 @@ use GetPath for the others. - GetValue() -> String + GetValue(self) -> String Returns the text that the user has entered if the user has pressed OK, or the original value if the user has pressed Cancel. - SetValue(String value) + SetValue(self, String value) Sets the default text value. - - This class holds a variety of information related to font dialogs. + + This class holds a variety of information related to font dialogs and +is used to transfer settings to and results from a `wx.FontDialog`. - __init__() -> FontData - This class holds a variety of information related to font dialogs. + __init__(self) -> FontData + This class holds a variety of information related to font dialogs and +is used to transfer settings to and results from a `wx.FontDialog`. - __del__() + __del__(self) - EnableEffects(bool enable) - Enables or disables 'effects' under MS Windows only. This refers -to the controls for manipulating colour, strikeout and underline + EnableEffects(self, bool enable) + 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. - GetAllowSymbols() -> bool - Under MS Windows, returns a flag determining whether symbol fonts can be -selected. Has no effect on other platforms. The default value is true. + GetAllowSymbols(self) -> bool + Under MS Windows, returns a flag determining whether symbol fonts can +be selected. Has no effect on other platforms. The default value is +true. - GetColour() -> Colour - Gets the colour associated with the font dialog. The default value is black. + GetColour(self) -> Colour + Gets the colour associated with the font dialog. The default value is +black. - GetChosenFont() -> Font + GetChosenFont(self) -> Font Gets the font chosen by the user. - GetEnableEffects() -> bool + GetEnableEffects(self) -> bool Determines whether 'effects' are enabled under Windows. - GetInitialFont() -> Font - Gets the font that will be initially used by the font dialog. This should have -previously been set by the application. + GetInitialFont(self) -> Font + Gets the font that will be initially used by the font dialog. This +should have previously been set by the application. - GetShowHelp() -> bool - Returns true if the Help button will be shown (Windows only). The default -value is false. + GetShowHelp(self) -> bool + Returns true if the Help button will be shown (Windows only). The +default value is false. - SetAllowSymbols(bool allowSymbols) - Under MS Windows, determines whether symbol fonts can be selected. Has no -effect on other platforms. The default value is true. + SetAllowSymbols(self, bool allowSymbols) + Under MS Windows, determines whether symbol fonts can be selected. Has +no effect on other platforms. The default value is true. - SetChosenFont(Font font) - Sets the font that will be returned to the user (for internal use only). + SetChosenFont(self, Font font) + Sets the font that will be returned to the user (normally for internal +use only). - SetColour(Colour colour) - Sets the colour that will be used for the font foreground colour. The default -colour is black. + SetColour(self, Colour colour) + Sets the colour that will be used for the font foreground colour. The +default colour is black. - SetInitialFont(Font font) + SetInitialFont(self, Font font) Sets the font that will be initially used by the font dialog. - SetRange(int min, int max) - Sets the valid range for the font point size (Windows only). The default is -0, 0 (unrestricted range). + SetRange(self, int min, int max) + Sets the valid range for the font point size (Windows only). The +default is 0, 0 (unrestricted range). - SetShowHelp(bool showHelp) - Determines whether the Help button will be displayed in the font dialog -(Windows only). The default value is false. + SetShowHelp(self, bool showHelp) + Determines whether the Help button will be displayed in the font +dialog (Windows only). The default value is false. - - This class represents the font chooser dialog. + + wx.FontDialog allows the user to select a system font and its attributes. + +:see: `wx.FontData` + - __init__(Window parent, FontData data) -> FontDialog - Constructor. Pass a parent window and the FontData object to be -used to initialize the dialog controls. + __init__(self, Window parent, FontData data) -> FontDialog + 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`. - GetFontData() -> FontData - Returns a reference to the internal FontData used by the FontDialog. - - - - This class provides a dialog that shows a single or multi-line message, with -a choice of OK, Yes, No and Cancel buttons. - - 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). - + GetFontData(self) -> FontData + Returns a reference to the internal `wx.FontData` used by the +wx.FontDialog. + + + + 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. + +Window 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). + =================== ============================================= + - __init__(Window parent, String message, String caption=MessageBoxCaptionStr, + __init__(self, Window parent, String message, String caption=MessageBoxCaptionStr, long style=wxOK|wxCANCEL|wxCENTRE, Point pos=DefaultPosition) -> MessageDialog - This class provides a dialog that shows a single or multi-line message, with -a choice of OK, Yes, No and Cancel buttons. + Constructor, use `ShowModal` to display the dialog. @@ -13061,41 +14961,44 @@ a choice of OK, Yes, No and Cancel buttons. - - A dialog that shows a short message and a progress bar. Optionally, it can -display an ABORT button. - - Styles + + A dialog that shows a short message and a progress bar. Optionally, it +can display an ABORT button. - 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. +Window 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_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_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_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_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. - + wx.PD_REMAINING_TIME This flag tells the dialog that it should show + remaining time. + ==================== ============================================= + - __init__(String title, String message, int maximum=100, Window parent=None, + __init__(self, String title, String message, int maximum=100, Window parent=None, int style=wxPD_AUTO_HIDE|wxPD_APP_MODAL) -> ProgressDialog - 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. + 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. @@ -13105,22 +15008,25 @@ windows, or, if wxPD_APP_MODAL flag is not given, for its parent window only. - Update(int value, String newmsg=EmptyString) -> bool - 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. + Update(self, int value, String newmsg=EmptyString) -> bool + Updates the dialog, setting the progress bar to the new value and, if +given changes the message above it. The value given should be less +than or equal to the maximum value given to the constructor and the +dialog is closed if it is equal to the maximum. 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. +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. - Resume() - Can be used to continue with the dialog, after the user had chosen to abort. + Resume(self) + Can be used to continue with the dialog, after the user had chosen to +abort. @@ -13137,11 +15043,11 @@ EVT_COMMAND_FIND_REPLACE = EVT_FIND_REPLACE EVT_COMMAND_FIND_REPLACE_ALL = EVT_FIND_REPLACE_ALL EVT_COMMAND_FIND_CLOSE = EVT_FIND_CLOSE - + Events for the FindReplaceDialog - __init__(wxEventType commandType=wxEVT_NULL, int id=0) -> FindDialogEvent + __init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> FindDialogEvent Events for the FindReplaceDialog @@ -13149,126 +15055,135 @@ EVT_COMMAND_FIND_CLOSE = EVT_FIND_CLOSE - GetFlags() -> int + GetFlags(self) -> int Get the currently selected flags: this is the combination of wx.FR_DOWN, wx.FR_WHOLEWORD and wx.FR_MATCHCASE flags. - GetFindString() -> String + GetFindString(self) -> String Return the string to find (never empty). - GetReplaceString() -> String - Return the string to replace the search string with (only -for replace and replace all events). + GetReplaceString(self) -> String + Return the string to replace the search string with (only for replace +and replace all events). - GetDialog() -> FindReplaceDialog + GetDialog(self) -> FindReplaceDialog Return the pointer to the dialog which generated this event. - SetFlags(int flags) + SetFlags(self, int flags) - SetFindString(String str) + SetFindString(self, String str) - SetReplaceString(String str) + SetReplaceString(self, String str) - - 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. + + 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. -Note that all SetXXX() methods may only be called before showing the dialog -and calling them has no effect later. +Note that all SetXXX() methods may only be called before showing the +dialog and calling them has no effect later. - Flags - wxFR_DOWN: downward search/replace selected (otherwise, upwards) +Flags +----- + ================ =============================================== + wx.FR_DOWN Downward search/replace selected (otherwise, + upwards) - wxFR_WHOLEWORD: whole word search/replace selected + wx.FR_WHOLEWORD Whole word search/replace selected - wxFR_MATCHCASE: case sensitive search/replace selected (otherwise, - case insensitive) + wx.FR_MATCHCASE Case sensitive search/replace selected + (otherwise, case insensitive) + ================ =============================================== - __init__(int flags=0) -> FindReplaceData + __init__(self, int flags=0) -> FindReplaceData Constuctor initializes the flags to default value (0). - __del__() + __del__(self) - GetFindString() -> String + GetFindString(self) -> String Get the string to find. - GetReplaceString() -> String + GetReplaceString(self) -> String Get the replacement string. - GetFlags() -> int + GetFlags(self) -> int Get the combination of flag values. - SetFlags(int flags) + SetFlags(self, int flags) Set the flags to use to initialize the controls of the dialog. - SetFindString(String str) + SetFindString(self, String str) Set the string to find (used as initial value by the dialog). - SetReplaceString(String str) + SetReplaceString(self, String str) Set the replacement string (used as initial value by the dialog). - - 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. - - Styles - wx.FR_REPLACEDIALOG: replace dialog (otherwise find dialog) + + 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. + - wx.FR_NOUPDOWN: don't allow changing the search direction +Window Styles +------------- - wx.FR_NOMATCHCASE: don't allow case sensitive searching + ===================== ========================================= + wx.FR_REPLACEDIALOG replace dialog (otherwise find dialog) - wx.FR_NOWHOLEWORD: don't allow whole word searching - + 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 + ===================== ========================================= + - __init__(Window parent, FindReplaceData data, String title, + __init__(self, Window parent, FindReplaceData data, String title, int style=0) -> FindReplaceDialog Create a FindReplaceDialog. The parent and data parameters must be non-None. Use Show to display the dialog. @@ -13284,7 +15199,7 @@ non-None. Use Show to display the dialog. Precreate a FindReplaceDialog for 2-phase creation - Create(Window parent, FindReplaceData data, String title, + Create(self, Window parent, FindReplaceData data, String title, int style=0) -> bool Create the dialog, for 2-phase create. @@ -13295,11 +15210,11 @@ non-None. Use Show to display the dialog. - GetData() -> FindReplaceData + GetData(self) -> FindReplaceData Get the FindReplaceData object used by this dialog. - SetData(FindReplaceData data) + SetData(self, FindReplaceData data) Set the FindReplaceData object used by this dialog. @@ -13309,16 +15224,17 @@ non-None. Use Show to display the dialog. #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL, + __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 - - + + @@ -13329,13 +15245,14 @@ non-None. Use Show to display the dialog. PreMDIParentFrame() -> MDIParentFrame - Create(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL, + 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 - - + + @@ -13343,40 +15260,41 @@ non-None. Use Show to display the dialog. - ActivateNext() + ActivateNext(self) - ActivatePrevious() + ActivatePrevious(self) - ArrangeIcons() + ArrangeIcons(self) - Cascade() + Cascade(self) - GetActiveChild() -> MDIChildFrame + GetActiveChild(self) -> MDIChildFrame - GetClientWindow() -> MDIClientWindow + GetClientWindow(self) -> MDIClientWindow - GetToolBar() -> Window + GetToolBar(self) -> Window - Tile() + Tile(self) - + - __init__(MDIParentFrame parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, + __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 - - + + @@ -13387,13 +15305,14 @@ non-None. Use Show to display the dialog. PreMDIChildFrame() -> MDIChildFrame - Create(MDIParentFrame parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, + 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 - - + + @@ -13401,22 +15320,22 @@ non-None. Use Show to display the dialog. - Activate() + Activate(self) - Maximize(bool maximize) + Maximize(self, bool maximize) - Restore() + Restore(self) - + - __init__(MDIParentFrame parent, long style=0) -> MDIClientWindow + __init__(self, MDIParentFrame parent, long style=0) -> MDIClientWindow @@ -13426,7 +15345,7 @@ non-None. Use Show to display the dialog. PreMDIClientWindow() -> MDIClientWindow - Create(MDIParentFrame parent, long style=0) -> bool + Create(self, MDIParentFrame parent, long style=0) -> bool @@ -13436,29 +15355,38 @@ non-None. Use Show to display the dialog. #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=PanelNameStr) -> PyWindow + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=PanelNameStr) -> PyWindow - + + + PrePyWindow() -> PyWindow + - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) + + SetBestSize(self, Size size) + + + + - base_DoMoveWindow(int x, int y, int width, int height) + base_DoMoveWindow(self, int x, int y, int width, int height) @@ -13467,7 +15395,7 @@ non-None. Use Show to display the dialog. - base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) + base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) @@ -13477,14 +15405,14 @@ non-None. Use Show to display the dialog. - base_DoSetClientSize(int width, int height) + base_DoSetClientSize(self, int width, int height) - base_DoSetVirtualSize(int x, int y) + base_DoSetVirtualSize(self, int x, int y) @@ -13512,68 +15440,225 @@ non-None. Use Show to display the dialog. - base_DoGetVirtualSize() -> Size + base_DoGetVirtualSize(self) -> Size - base_DoGetBestSize() -> Size + base_DoGetBestSize(self) -> Size - base_InitDialog() + base_InitDialog(self) - base_TransferDataToWindow() -> bool + base_TransferDataToWindow(self) -> bool - base_TransferDataFromWindow() -> bool + base_TransferDataFromWindow(self) -> bool - base_Validate() -> bool + base_Validate(self) -> bool - base_AcceptsFocus() -> bool + base_AcceptsFocus(self) -> bool - base_AcceptsFocusFromKeyboard() -> bool + base_AcceptsFocusFromKeyboard(self) -> bool - base_GetMaxSize() -> Size + base_GetMaxSize(self) -> Size - base_AddChild(Window child) + base_AddChild(self, Window child) - base_RemoveChild(Window child) + base_RemoveChild(self, Window child) + + base_ShouldInheritColours(self) -> bool + + + base_ApplyParentThemeBackground(self, Colour c) + + + + + + base_GetDefaultAttributes(self) -> VisualAttributes + - + - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=PanelNameStr) -> PyPanel + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=PanelNameStr) -> PyPanel - + + + + + + + + + PrePyPanel() -> PyPanel + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + SetBestSize(self, Size size) + + + + + + base_DoMoveWindow(self, int x, int y, int width, int height) + + + + + + + + + base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) + + + + + + + + + + base_DoSetClientSize(self, int width, int height) + + + + + + + base_DoSetVirtualSize(self, int x, int y) + + + + + + + base_DoGetSize() -> (width, height) + + + + + + + base_DoGetClientSize() -> (width, height) + + + + + + + base_DoGetPosition() -> (x,y) + + + + + + + base_DoGetVirtualSize(self) -> Size + + + base_DoGetBestSize(self) -> Size + + + base_InitDialog(self) + + + base_TransferDataToWindow(self) -> bool + + + base_TransferDataFromWindow(self) -> bool + + + base_Validate(self) -> bool + + + base_AcceptsFocus(self) -> bool + + + base_AcceptsFocusFromKeyboard(self) -> bool + + + base_GetMaxSize(self) -> Size + + + base_AddChild(self, Window child) + + + + + + base_RemoveChild(self, Window child) + + + + + + base_ShouldInheritColours(self) -> bool + + + base_ApplyParentThemeBackground(self, Colour c) + + + + + + base_GetDefaultAttributes(self) -> VisualAttributes + + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=PanelNameStr) -> PyScrolledWindow + + + + + PrePyScrolledWindow() -> PyScrolledWindow + - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) + + SetBestSize(self, Size size) + + + + - base_DoMoveWindow(int x, int y, int width, int height) + base_DoMoveWindow(self, int x, int y, int width, int height) @@ -13582,7 +15667,7 @@ non-None. Use Show to display the dialog. - base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) + base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) @@ -13592,14 +15677,14 @@ non-None. Use Show to display the dialog. - base_DoSetClientSize(int width, int height) + base_DoSetClientSize(self, int width, int height) - base_DoSetVirtualSize(int x, int y) + base_DoSetVirtualSize(self, int x, int y) @@ -13627,602 +15712,624 @@ non-None. Use Show to display the dialog. - base_DoGetVirtualSize() -> Size + base_DoGetVirtualSize(self) -> Size - base_DoGetBestSize() -> Size + base_DoGetBestSize(self) -> Size - base_InitDialog() + base_InitDialog(self) - base_TransferDataToWindow() -> bool + base_TransferDataToWindow(self) -> bool - base_TransferDataFromWindow() -> bool + base_TransferDataFromWindow(self) -> bool - base_Validate() -> bool + base_Validate(self) -> bool - base_AcceptsFocus() -> bool + base_AcceptsFocus(self) -> bool - base_AcceptsFocusFromKeyboard() -> bool + base_AcceptsFocusFromKeyboard(self) -> bool - base_GetMaxSize() -> Size + base_GetMaxSize(self) -> Size - base_AddChild(Window child) + base_AddChild(self, Window child) - base_RemoveChild(Window child) + base_RemoveChild(self, Window child) + + base_ShouldInheritColours(self) -> bool + + + base_ApplyParentThemeBackground(self, Colour c) + + + + + + base_GetDefaultAttributes(self) -> VisualAttributes + #--------------------------------------------------------------------------- - + - - __init__() -> PrintData + + + __init__(self) -> PrintData +__init__(self, PrintData data) -> PrintData + + + - __del__() + __del__(self) - GetNoCopies() -> int + GetNoCopies(self) -> int - GetCollate() -> bool + GetCollate(self) -> bool - GetOrientation() -> int + GetOrientation(self) -> int - Ok() -> bool + Ok(self) -> bool - GetPrinterName() -> String + GetPrinterName(self) -> String - GetColour() -> bool + GetColour(self) -> bool - GetDuplex() -> int + GetDuplex(self) -> int - GetPaperId() -> int + GetPaperId(self) -> int - GetPaperSize() -> Size + GetPaperSize(self) -> Size - GetQuality() -> int + GetQuality(self) -> int - SetNoCopies(int v) + SetNoCopies(self, int v) - SetCollate(bool flag) + SetCollate(self, bool flag) - SetOrientation(int orient) + SetOrientation(self, int orient) - SetPrinterName(String name) + SetPrinterName(self, String name) - SetColour(bool colour) + SetColour(self, bool colour) - SetDuplex(int duplex) + SetDuplex(self, int duplex) - SetPaperId(int sizeId) + SetPaperId(self, int sizeId) - SetPaperSize(Size sz) + SetPaperSize(self, Size sz) - SetQuality(int quality) + SetQuality(self, int quality) - GetPrinterCommand() -> String + GetPrinterCommand(self) -> String - GetPrinterOptions() -> String + GetPrinterOptions(self) -> String - GetPreviewCommand() -> String + GetPreviewCommand(self) -> String - GetFilename() -> String + GetFilename(self) -> String - GetFontMetricPath() -> String + GetFontMetricPath(self) -> String - GetPrinterScaleX() -> double + GetPrinterScaleX(self) -> double - GetPrinterScaleY() -> double + GetPrinterScaleY(self) -> double - GetPrinterTranslateX() -> long + GetPrinterTranslateX(self) -> long - GetPrinterTranslateY() -> long + GetPrinterTranslateY(self) -> long - GetPrintMode() -> int + GetPrintMode(self) -> int - SetPrinterCommand(String command) + SetPrinterCommand(self, String command) - SetPrinterOptions(String options) + SetPrinterOptions(self, String options) - SetPreviewCommand(String command) + SetPreviewCommand(self, String command) - SetFilename(String filename) + SetFilename(self, String filename) - SetFontMetricPath(String path) + SetFontMetricPath(self, String path) - SetPrinterScaleX(double x) + SetPrinterScaleX(self, double x) - SetPrinterScaleY(double y) + SetPrinterScaleY(self, double y) - SetPrinterScaling(double x, double y) + SetPrinterScaling(self, double x, double y) - SetPrinterTranslateX(long x) + SetPrinterTranslateX(self, long x) - SetPrinterTranslateY(long y) + SetPrinterTranslateY(self, long y) - SetPrinterTranslation(long x, long y) + SetPrinterTranslation(self, long x, long y) - SetPrintMode(int printMode) + SetPrintMode(self, int printMode) - GetOutputStream() -> OutputStream + GetOutputStream(self) -> OutputStream - SetOutputStream(OutputStream outputstream) + SetOutputStream(self, OutputStream outputstream) - + - - __init__() -> PageSetupDialogData + + + __init__(self) -> PageSetupDialogData +__init__(self, PageSetupDialogData data) -> PageSetupDialogData + + + - __del__() + __del__(self) - EnableHelp(bool flag) + EnableHelp(self, bool flag) - EnableMargins(bool flag) + EnableMargins(self, bool flag) - EnableOrientation(bool flag) + EnableOrientation(self, bool flag) - EnablePaper(bool flag) + EnablePaper(self, bool flag) - EnablePrinter(bool flag) + EnablePrinter(self, bool flag) - GetDefaultMinMargins() -> bool + GetDefaultMinMargins(self) -> bool - GetEnableMargins() -> bool + GetEnableMargins(self) -> bool - GetEnableOrientation() -> bool + GetEnableOrientation(self) -> bool - GetEnablePaper() -> bool + GetEnablePaper(self) -> bool - GetEnablePrinter() -> bool + GetEnablePrinter(self) -> bool - GetEnableHelp() -> bool + GetEnableHelp(self) -> bool - GetDefaultInfo() -> bool + GetDefaultInfo(self) -> bool - GetMarginTopLeft() -> Point + GetMarginTopLeft(self) -> Point - GetMarginBottomRight() -> Point + GetMarginBottomRight(self) -> Point - GetMinMarginTopLeft() -> Point + GetMinMarginTopLeft(self) -> Point - GetMinMarginBottomRight() -> Point + GetMinMarginBottomRight(self) -> Point - GetPaperId() -> int + GetPaperId(self) -> int - GetPaperSize() -> Size + GetPaperSize(self) -> Size - GetPrintData() -> PrintData + GetPrintData(self) -> PrintData - Ok() -> bool + Ok(self) -> bool - SetDefaultInfo(bool flag) + SetDefaultInfo(self, bool flag) - SetDefaultMinMargins(bool flag) + SetDefaultMinMargins(self, bool flag) - SetMarginTopLeft(Point pt) + SetMarginTopLeft(self, Point pt) - SetMarginBottomRight(Point pt) + SetMarginBottomRight(self, Point pt) - SetMinMarginTopLeft(Point pt) + SetMinMarginTopLeft(self, Point pt) - SetMinMarginBottomRight(Point pt) + SetMinMarginBottomRight(self, Point pt) - SetPaperId(int id) + SetPaperId(self, int id) - SetPaperSize(Size size) + SetPaperSize(self, Size size) - SetPrintData(PrintData printData) + SetPrintData(self, PrintData printData) - + - __init__(Window parent, PageSetupDialogData data=None) -> PageSetupDialog + __init__(self, Window parent, PageSetupDialogData data=None) -> PageSetupDialog - GetPageSetupData() -> PageSetupDialogData + GetPageSetupData(self) -> PageSetupDialogData - ShowModal() -> int + ShowModal(self) -> int - + - __init__() -> PrintDialogData -__init__(PrintData printData) -> PrintDialogData + __init__(self) -> PrintDialogData +__init__(self, PrintData printData) -> PrintDialogData - __del__() + __del__(self) - GetFromPage() -> int + GetFromPage(self) -> int - GetToPage() -> int + GetToPage(self) -> int - GetMinPage() -> int + GetMinPage(self) -> int - GetMaxPage() -> int + GetMaxPage(self) -> int - GetNoCopies() -> int + GetNoCopies(self) -> int - GetAllPages() -> bool + GetAllPages(self) -> bool - GetSelection() -> bool + GetSelection(self) -> bool - GetCollate() -> bool + GetCollate(self) -> bool - GetPrintToFile() -> bool + GetPrintToFile(self) -> bool - GetSetupDialog() -> bool + GetSetupDialog(self) -> bool - SetFromPage(int v) + SetFromPage(self, int v) - SetToPage(int v) + SetToPage(self, int v) - SetMinPage(int v) + SetMinPage(self, int v) - SetMaxPage(int v) + SetMaxPage(self, int v) - SetNoCopies(int v) + SetNoCopies(self, int v) - SetAllPages(bool flag) + SetAllPages(self, bool flag) - SetSelection(bool flag) + SetSelection(self, bool flag) - SetCollate(bool flag) + SetCollate(self, bool flag) - SetPrintToFile(bool flag) + SetPrintToFile(self, bool flag) - SetSetupDialog(bool flag) + SetSetupDialog(self, bool flag) - EnablePrintToFile(bool flag) + EnablePrintToFile(self, bool flag) - EnableSelection(bool flag) + EnableSelection(self, bool flag) - EnablePageNumbers(bool flag) + EnablePageNumbers(self, bool flag) - EnableHelp(bool flag) + EnableHelp(self, bool flag) - GetEnablePrintToFile() -> bool + GetEnablePrintToFile(self) -> bool - GetEnableSelection() -> bool + GetEnableSelection(self) -> bool - GetEnablePageNumbers() -> bool + GetEnablePageNumbers(self) -> bool - GetEnableHelp() -> bool + GetEnableHelp(self) -> bool - Ok() -> bool + Ok(self) -> bool - GetPrintData() -> PrintData + GetPrintData(self) -> PrintData - SetPrintData(PrintData printData) + SetPrintData(self, PrintData printData) - + - __init__(Window parent, PrintDialogData data=None) -> PrintDialog + __init__(self, Window parent, PrintDialogData data=None) -> PrintDialog - GetPrintDialogData() -> PrintDialogData + GetPrintDialogData(self) -> PrintDialogData - GetPrintDC() -> DC + GetPrintDC(self) -> DC - ShowModal() -> int + ShowModal(self) -> int - + - __init__(PrintDialogData data=None) -> Printer + __init__(self, PrintDialogData data=None) -> Printer - __del__() + __del__(self) - CreateAbortWindow(Window parent, Printout printout) + CreateAbortWindow(self, Window parent, Printout printout) - GetPrintDialogData() -> PrintDialogData + GetPrintDialogData(self) -> PrintDialogData - Print(Window parent, Printout printout, int prompt=True) -> bool + Print(self, Window parent, Printout printout, int prompt=True) -> bool @@ -14230,13 +16337,13 @@ __init__(PrintData printData) -> PrintDialogData - PrintDialog(Window parent) -> DC + PrintDialog(self, Window parent) -> DC - ReportError(Window parent, Printout printout, String message) + ReportError(self, Window parent, Printout printout, String message) @@ -14244,47 +16351,47 @@ __init__(PrintData printData) -> PrintDialogData - Setup(Window parent) -> bool + Setup(self, Window parent) -> bool - GetAbort() -> bool + GetAbort(self) -> bool GetLastError() -> int - + - __init__(String title=PrintoutTitleStr) -> Printout + __init__(self, String title=PrintoutTitleStr) -> Printout - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - GetTitle() -> String + GetTitle(self) -> String - GetDC() -> DC + GetDC(self) -> DC - SetDC(DC dc) + SetDC(self, DC dc) - SetPageSizePixels(int w, int h) + SetPageSizePixels(self, int w, int h) @@ -14298,7 +16405,7 @@ __init__(PrintData printData) -> PrintDialogData - SetPageSizeMM(int w, int h) + SetPageSizeMM(self, int w, int h) @@ -14312,7 +16419,7 @@ __init__(PrintData printData) -> PrintDialogData - SetPPIScreen(int x, int y) + SetPPIScreen(self, int x, int y) @@ -14326,7 +16433,7 @@ __init__(PrintData printData) -> PrintDialogData - SetPPIPrinter(int x, int y) + SetPPIPrinter(self, int x, int y) @@ -14340,35 +16447,35 @@ __init__(PrintData printData) -> PrintDialogData - IsPreview() -> bool + IsPreview(self) -> bool - SetIsPreview(bool p) + SetIsPreview(self, bool p) - base_OnBeginDocument(int startPage, int endPage) -> bool + base_OnBeginDocument(self, int startPage, int endPage) -> bool - base_OnEndDocument() + base_OnEndDocument(self) - base_OnBeginPrinting() + base_OnBeginPrinting(self) - base_OnEndPrinting() + base_OnEndPrinting(self) - base_OnPreparePrinting() + base_OnPreparePrinting(self) - base_HasPage(int page) -> bool + base_HasPage(self, int page) -> bool @@ -14383,10 +16490,10 @@ __init__(PrintData printData) -> PrintDialogData - + - __init__(PrintPreview preview, Window parent, Point pos=DefaultPosition, + __init__(self, PrintPreview preview, Window parent, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=PreviewCanvasNameStr) -> PreviewCanvas @@ -14399,10 +16506,10 @@ __init__(PrintData printData) -> PrintDialogData - + - __init__(PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition, + __init__(self, PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition, Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PreviewFrame @@ -14416,22 +16523,22 @@ __init__(PrintData printData) -> PrintDialogData - Initialize() + Initialize(self) - CreateControlBar() + CreateControlBar(self) - CreateCanvas() + CreateCanvas(self) - GetControlBar() -> PreviewControlBar + GetControlBar(self) -> PreviewControlBar - + - __init__(PrintPreview preview, long buttons, Window parent, + __init__(self, PrintPreview preview, long buttons, Window parent, Point pos=DefaultPosition, Size size=DefaultSize, long style=TAB_TRAVERSAL, String name=PanelNameStr) -> PreviewControlBar @@ -14445,34 +16552,34 @@ __init__(PrintData printData) -> PrintDialogData - GetZoomControl() -> int + GetZoomControl(self) -> int - SetZoomControl(int zoom) + SetZoomControl(self, int zoom) - GetPrintPreview() -> PrintPreview + GetPrintPreview(self) -> PrintPreview - OnNext() + OnNext(self) - OnPrevious() + OnPrevious(self) - OnFirst() + OnFirst(self) - OnLast() + OnLast(self) - OnGoto() + OnGoto(self) - + @@ -14482,8 +16589,8 @@ __init__(PrintData printData) -> PrintDialogData - __init__(Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PrintPreview -__init__(Printout printout, Printout printoutForPrinting, PrintData data) -> PrintPreview + __init__(self, Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PrintPreview +__init__(self, Printout printout, Printout printoutForPrinting, PrintData data) -> PrintPreview @@ -14491,108 +16598,108 @@ __init__(Printout printout, Printout printoutForPrinting, PrintData data) -> - SetCurrentPage(int pageNum) -> bool + SetCurrentPage(self, int pageNum) -> bool - GetCurrentPage() -> int + GetCurrentPage(self) -> int - SetPrintout(Printout printout) + SetPrintout(self, Printout printout) - GetPrintout() -> Printout + GetPrintout(self) -> Printout - GetPrintoutForPrinting() -> Printout + GetPrintoutForPrinting(self) -> Printout - SetFrame(Frame frame) + SetFrame(self, Frame frame) - SetCanvas(PreviewCanvas canvas) + SetCanvas(self, PreviewCanvas canvas) - GetFrame() -> Frame + GetFrame(self) -> Frame - GetCanvas() -> PreviewCanvas + GetCanvas(self) -> PreviewCanvas - PaintPage(PreviewCanvas canvas, DC dc) -> bool + PaintPage(self, PreviewCanvas canvas, DC dc) -> bool - DrawBlankPage(PreviewCanvas canvas, DC dc) -> bool + DrawBlankPage(self, PreviewCanvas canvas, DC dc) -> bool - RenderPage(int pageNum) -> bool + RenderPage(self, int pageNum) -> bool - AdjustScrollbars(PreviewCanvas canvas) + AdjustScrollbars(self, PreviewCanvas canvas) - GetPrintDialogData() -> PrintDialogData + GetPrintDialogData(self) -> PrintDialogData - SetZoom(int percent) + SetZoom(self, int percent) - GetZoom() -> int + GetZoom(self) -> int - GetMaxPage() -> int + GetMaxPage(self) -> int - GetMinPage() -> int + GetMinPage(self) -> int - Ok() -> bool + Ok(self) -> bool - SetOk(bool ok) + SetOk(self, bool ok) - Print(bool interactive) -> bool + Print(self, bool interactive) -> bool - DetermineScaling() + DetermineScaling(self) - + @@ -14602,8 +16709,8 @@ __init__(Printout printout, Printout printoutForPrinting, PrintData data) -> - __init__(Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PyPrintPreview -__init__(Printout printout, Printout printoutForPrinting, PrintData data) -> PyPrintPreview + __init__(self, Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PyPrintPreview +__init__(self, Printout printout, Printout printoutForPrinting, PrintData data) -> PyPrintPreview @@ -14611,58 +16718,58 @@ __init__(Printout printout, Printout printoutForPrinting, PrintData data) -> - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - base_SetCurrentPage(int pageNum) -> bool + base_SetCurrentPage(self, int pageNum) -> bool - base_PaintPage(PreviewCanvas canvas, DC dc) -> bool + base_PaintPage(self, PreviewCanvas canvas, DC dc) -> bool - base_DrawBlankPage(PreviewCanvas canvas, DC dc) -> bool + base_DrawBlankPage(self, PreviewCanvas canvas, DC dc) -> bool - base_RenderPage(int pageNum) -> bool + base_RenderPage(self, int pageNum) -> bool - base_SetZoom(int percent) + base_SetZoom(self, int percent) - base_Print(bool interactive) -> bool + base_Print(self, bool interactive) -> bool - base_DetermineScaling() + base_DetermineScaling(self) - + - __init__(PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition, + __init__(self, PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition, Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PyPreviewFrame @@ -14676,38 +16783,38 @@ __init__(Printout printout, Printout printoutForPrinting, PrintData data) -> - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - SetPreviewCanvas(PreviewCanvas canvas) + SetPreviewCanvas(self, PreviewCanvas canvas) - SetControlBar(PreviewControlBar bar) + SetControlBar(self, PreviewControlBar bar) - base_Initialize() + base_Initialize(self) - base_CreateCanvas() + base_CreateCanvas(self) - base_CreateControlBar() + base_CreateControlBar(self) - + - __init__(PrintPreview preview, long buttons, Window parent, + __init__(self, PrintPreview preview, long buttons, Window parent, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=PanelNameStr) -> PyPreviewControlBar @@ -14721,61 +16828,133 @@ __init__(Printout printout, Printout printoutForPrinting, PrintData data) -> - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - SetPrintPreview(PrintPreview preview) + SetPrintPreview(self, PrintPreview preview) - base_CreateButtons() + base_CreateButtons(self) - base_SetZoomControl(int zoom) + base_SetZoomControl(self, int zoom) - - - wx = core + + + wx = _core #--------------------------------------------------------------------------- - + 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. - - 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. - +indeed almost any other window. + +Window Styles +------------- + ============== ========================================== + wx.BU_LEFT Left-justifies the label. Windows and GTK+ only. + wx.BU_TOP Aligns the label to the top of the button. + Windows and GTK+ only. + wx.BU_RIGHT Right-justifies the bitmap label. Windows and GTK+ only. + wx.BU_BOTTOM Aligns the label to the bottom of the button. + Windows and GTK+ 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. + ============ ========================================== + +:see: `wx.BitmapButton` + - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=ButtonNameStr) -> Button - Create and show a button. + __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 + Create and show a button. The preferred way to create standard +buttons is to use a standard ID and an empty label. In this case +wxWigets will automatically use a stock label that coresponds to the +ID given. In additon, the button will be decorated with stock icons +under GTK+ 2. + +The stock IDs and coresponding labels are + + ================== ==================== + wx.ID_ADD 'Add' + wx.ID_APPLY '\\&Apply' + wx.ID_BOLD '\\&Bold' + wx.ID_CANCEL '\\&Cancel' + wx.ID_CLEAR '\\&Clear' + wx.ID_CLOSE '\\&Close' + wx.ID_COPY '\\&Copy' + wx.ID_CUT 'Cu\\&t' + wx.ID_DELETE '\\&Delete' + wx.ID_FIND '\\&Find' + wx.ID_REPLACE 'Find and rep\\&lace' + wx.ID_BACKWARD '\\&Back' + wx.ID_DOWN '\\&Down' + wx.ID_FORWARD '\\&Forward' + wx.ID_UP '\\&Up' + wx.ID_HELP '\\&Help' + wx.ID_HOME '\\&Home' + wx.ID_INDENT 'Indent' + wx.ID_INDEX '\\&Index' + wx.ID_ITALIC '\\&Italic' + wx.ID_JUSTIFY_CENTER 'Centered' + wx.ID_JUSTIFY_FILL 'Justified' + wx.ID_JUSTIFY_LEFT 'Align Left' + wx.ID_JUSTIFY_RIGHT 'Align Right' + wx.ID_NEW '\\&New' + wx.ID_NO '\\&No' + wx.ID_OK '\\&OK' + wx.ID_OPEN '\\&Open' + wx.ID_PASTE '\\&Paste' + wx.ID_PREFERENCES '\\&Preferences' + wx.ID_PRINT '\\&Print' + wx.ID_PREVIEW 'Print previe\\&w' + wx.ID_PROPERTIES '\\&Properties' + wx.ID_EXIT '\\&Quit' + wx.ID_REDO '\\&Redo' + wx.ID_REFRESH 'Refresh' + wx.ID_REMOVE 'Remove' + wx.ID_REVERT_TO_SAVED 'Revert to Saved' + wx.ID_SAVE '\\&Save' + wx.ID_SAVEAS 'Save \\&As...' + wx.ID_STOP '\\&Stop' + wx.ID_UNDELETE 'Undelete' + wx.ID_UNDERLINE '\\&Underline' + wx.ID_UNDO '\\&Undo' + wx.ID_UNINDENT '\\&Unindent' + wx.ID_YES '\\&Yes' + wx.ID_ZOOM_100 '\\&Actual Size' + wx.ID_ZOOM_FIT 'Zoom to \\&Fit' + wx.ID_ZOOM_IN 'Zoom \\&In' + wx.ID_ZOOM_OUT 'Zoom \\&Out' + ================== ==================== + - - + + @@ -14788,14 +16967,15 @@ indeed almost any other window. Precreate a Button for 2-phase creation. - Create(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=ButtonNameStr) -> bool + 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 Acutally create the GUI Button for 2-phase creation. - - + + @@ -14804,47 +16984,75 @@ indeed almost any other window. - SetDefault() + SetDefault(self) This sets the button to be the default item for the panel or dialog box. GetDefaultSize() -> Size + Returns the default button size for this platform. + + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + - + 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. - - - 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 +unpressed focused state, and greyed-out state may be supplied. + +Window 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. - + 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. + =========== ================================== + +:see: `wx.Button`, `wx.Bitmap` + - __init__(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=BU_AUTODRAW, - Validator validator=DefaultValidator, + __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 Create and show a button with a bitmap for the label. - - + + @@ -14857,15 +17065,15 @@ unpressed focused state, and greyed-out state may be supplied. Precreate a BitmapButton for 2-phase creation. - Create(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=BU_AUTODRAW, - Validator validator=DefaultValidator, + 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 Acutally create the GUI BitmapButton for 2-phase creation. - - + + @@ -14874,44 +17082,44 @@ unpressed focused state, and greyed-out state may be supplied. - GetBitmapLabel() -> Bitmap + GetBitmapLabel(self) -> Bitmap Returns the label bitmap (the one passed to the constructor). - GetBitmapDisabled() -> Bitmap + GetBitmapDisabled(self) -> Bitmap Returns the bitmap for the disabled state. - GetBitmapFocus() -> Bitmap + GetBitmapFocus(self) -> Bitmap Returns the bitmap for the focused state. - GetBitmapSelected() -> Bitmap + GetBitmapSelected(self) -> Bitmap Returns the bitmap for the selected state. - SetBitmapDisabled(Bitmap bitmap) + SetBitmapDisabled(self, Bitmap bitmap) Sets the bitmap for the disabled button appearance. - SetBitmapFocus(Bitmap bitmap) + SetBitmapFocus(self, Bitmap bitmap) Sets the bitmap for the button appearance when it has the keyboard focus. - SetBitmapSelected(Bitmap bitmap) + SetBitmapSelected(self, Bitmap bitmap) Sets the bitmap for the selected (depressed) button appearance. - SetBitmapLabel(Bitmap bitmap) + SetBitmapLabel(self, Bitmap bitmap) 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. @@ -14919,51 +17127,64 @@ unselected state, and for all other states if no other bitmaps are provided. - SetMargins(int x, int y) + SetMargins(self, int x, int y) - GetMarginX() -> int + GetMarginX(self) -> int - GetMarginY() -> int + GetMarginY(self) -> int #--------------------------------------------------------------------------- - - 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. - - 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. - + + 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. + +Window 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. + =============================== =============================== + - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> CheckBox + __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 Creates and shows a CheckBox control - - + + @@ -14976,14 +17197,15 @@ state. Often this is used as a "Does Not Apply" state. Precreate a CheckBox for 2-phase creation. - Create(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> bool + 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 Actually create the GUI CheckBox for 2-phase creation. - - + + @@ -14992,58 +17214,81 @@ state. Often this is used as a "Does Not Apply" state. - GetValue() -> bool + GetValue(self) -> bool Gets the state of a 2-state CheckBox. Returns True if it is checked, False otherwise. - IsChecked() -> bool - Similar to GetValue, but raises an exception if it is not a 2-state CheckBox. + IsChecked(self) -> bool + Similar to GetValue, but raises an exception if it is not a 2-state +CheckBox. - SetValue(bool state) - Set the state of a 2-state CheckBox. Pass True for checked, -False for unchecked. + SetValue(self, bool state) + Set the state of a 2-state CheckBox. Pass True for checked, False for +unchecked. - Get3StateValue() -> int - 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. + Get3StateValue(self) -> int + 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. - Set3StateValue(int state) - 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. + Set3StateValue(self, int state) + 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. - Is3State() -> bool + Is3State(self) -> bool Returns whether or not the CheckBox is a 3-state CheckBox. - Is3rdStateAllowedForUser() -> bool - Returns whether or not the user can set the CheckBox to the third state. + Is3rdStateAllowedForUser(self) -> bool + Returns whether or not the user can set the CheckBox to the third +state. + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - - 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. - - Events - EVT_CHOICE: Sent when an item in the list is selected. - + + 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. + +Events +------ + ================ ========================================== + EVT_CHOICE Sent when an item in the list is selected. + ================ ========================================== + __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, @@ -15052,7 +17297,7 @@ only the selection is visible until the user pulls down the menu of choices.Create and show a Choice control - + @@ -15072,7 +17317,7 @@ only the selection is visible until the user pulls down the menu of choices.Actually create the GUI Choice control for 2-phase creation - + @@ -15082,65 +17327,90 @@ only the selection is visible until the user pulls down the menu of choices. - SetSelection(int n) + SetSelection(self, int n) Select the n'th item (zero based) in the list. - - SetStringSelection(String string) + + SetStringSelection(self, String string) -> bool Select the item with the specifed string - SetString(int n, String string) + SetString(self, int n, String string) Set the label for the n'th item (zero based) in the list. + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - - 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. - - 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 - - EVT_COMBOBOX: Sent when an item on the list is selected. - EVT_TEXT: Sent when the combobox text changes. - + + 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. + +A combobox permits a single selection only. Combobox items are +numbered from zero. + +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 +------- + ================ =============================================== + EVT_COMBOBOX Sent when an item on the list is selected. + EVT_TEXT Sent when the combobox text changes. + ================ =============================================== + __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 + List choices=[], long style=0, Validator validator=DefaultValidator, + String name=ComboBoxNameStr) -> ComboBox Constructor, creates and shows a ComboBox control. - + @@ -15162,7 +17432,7 @@ list with text field. Actually create the GUI wxComboBox control for 2-phase creation - + @@ -15173,44 +17443,44 @@ list with text field. - GetValue() -> String + GetValue(self) -> String Returns the current value in the combobox text field. - SetValue(String value) + SetValue(self, String value) - Copy() + Copy(self) Copies the selected text to the clipboard. - Cut() + Cut(self) Copies the selected text to the clipboard and removes the selection. - Paste() + Paste(self) Pastes text from the clipboard to the text field. - SetInsertionPoint(long pos) + SetInsertionPoint(self, long pos) Sets the insertion point in the combobox text field. - GetInsertionPoint() -> long + GetInsertionPoint(self) -> long Returns the insertion point for the combobox's text field. - GetLastPosition() -> long + GetLastPosition(self) -> long Returns the last position in the combobox text field. - Replace(long from, long to, String value) + Replace(self, long from, long to, String value) Replaces the text between two positions with the given text, in the combobox text field. @@ -15220,52 +17490,84 @@ combobox text field. - SetSelection(int n) - Selects the text between the two positions, in the combobox text field. + SetSelection(self, int n) + Sets the item at index 'n' to be the selected item. - SetMark(long from, long to) + SetMark(self, long from, long to) + Selects the text between the two positions in the combobox text field. + + SetStringSelection(self, String string) -> bool + Select the item with the specifed string + + + + + + SetString(self, int n, String string) + Set the label for the n'th item (zero based) in the list. + + + + + - SetEditable(bool editable) + SetEditable(self, bool editable) - SetInsertionPointEnd() + SetInsertionPointEnd(self) Sets the insertion point at the end of the combobox text field. - Remove(long from, long to) + Remove(self, long from, long to) Removes the text between the two positions in the combobox text field. + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, int range, Point pos=DefaultPosition, + __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 - - + + @@ -15277,14 +17579,14 @@ combobox text field. PreGauge() -> Gauge - Create(Window parent, int id, int range, Point pos=DefaultPosition, + 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 - - + + @@ -15293,58 +17595,74 @@ combobox text field. - SetRange(int range) + SetRange(self, int range) - GetRange() -> int + GetRange(self) -> int - SetValue(int pos) + SetValue(self, int pos) - GetValue() -> int + GetValue(self) -> int - IsVertical() -> bool + IsVertical(self) -> bool - SetShadowWidth(int w) + SetShadowWidth(self, int w) - GetShadowWidth() -> int + GetShadowWidth(self) -> int - SetBezelFace(int w) + SetBezelFace(self, int w) - GetBezelFace() -> int + GetBezelFace(self) -> int + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBoxNameStr) -> StaticBox + __init__(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticBoxNameStr) -> StaticBox - - + + @@ -15355,32 +17673,48 @@ combobox text field. PreStaticBox() -> StaticBox - Create(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBoxNameStr) -> bool + Create(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticBoxNameStr) -> bool - - + + + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=LI_HORIZONTAL, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=LI_HORIZONTAL, String name=StaticTextNameStr) -> StaticLine - + @@ -15391,12 +17725,12 @@ combobox text field. PreStaticLine() -> StaticLine - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=LI_HORIZONTAL, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=LI_HORIZONTAL, String name=StaticTextNameStr) -> bool - + @@ -15404,25 +17738,41 @@ combobox text field. - IsVertical() -> bool + IsVertical(self) -> bool GetDefaultSize() -> int + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticTextNameStr) -> StaticText + __init__(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticTextNameStr) -> StaticText - - + + @@ -15433,33 +17783,49 @@ combobox text field. PreStaticText() -> StaticText - Create(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticTextNameStr) -> bool + Create(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticTextNameStr) -> bool - - + + + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBitmapNameStr) -> StaticBitmap + __init__(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticBitmapNameStr) -> StaticBitmap - - + + @@ -15470,13 +17836,13 @@ combobox text field. PreStaticBitmap() -> StaticBitmap - Create(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBitmapNameStr) -> bool + Create(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticBitmapNameStr) -> bool - - + + @@ -15484,34 +17850,50 @@ combobox text field. - GetBitmap() -> Bitmap + GetBitmap(self) -> Bitmap - SetBitmap(Bitmap bitmap) + SetBitmap(self, Bitmap bitmap) - SetIcon(Icon icon) + SetIcon(self, Icon icon) + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - wxArrayString choices=wxPyEmptyStringArray, + __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 - + @@ -15524,13 +17906,13 @@ combobox text field. PreListBox() -> ListBox - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - wxArrayString choices=wxPyEmptyStringArray, + 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 - + @@ -15540,8 +17922,8 @@ combobox text field. - Insert(String item, int pos, PyObject clientData=None) - Insert an item into the control before the item at the pos index, + Insert(self, String item, int pos, PyObject clientData=None) + Insert an item into the control before the item at the ``pos`` index, optionally associating some data object with the item. @@ -15550,122 +17932,138 @@ optionally associating some data object with the item. - InsertItems(wxArrayString items, int pos) + InsertItems(self, wxArrayString items, int pos) - Set(wxArrayString items) + Set(self, wxArrayString items) - IsSelected(int n) -> bool + IsSelected(self, int n) -> bool - SetSelection(int n, bool select=True) + SetSelection(self, int n, bool select=True) - Select(int n) + Select(self, int n) Sets the item at index 'n' to be the selected item. - Deselect(int n) + Deselect(self, int n) - DeselectAll(int itemToLeaveSelected=-1) + DeselectAll(self, int itemToLeaveSelected=-1) - SetStringSelection(String s, bool select=True) -> bool + SetStringSelection(self, String s, bool select=True) -> bool - GetSelections() -> PyObject + GetSelections(self) -> PyObject - SetFirstItem(int n) + SetFirstItem(self, int n) - SetFirstItemStr(String s) + SetFirstItemStr(self, String s) - EnsureVisible(int n) + EnsureVisible(self, int n) - AppendAndEnsureVisible(String s) + AppendAndEnsureVisible(self, String s) - IsSorted() -> bool + IsSorted(self) -> bool - SetItemForegroundColour(int item, Colour c) + SetItemForegroundColour(self, int item, Colour c) - SetItemBackgroundColour(int item, Colour c) + SetItemBackgroundColour(self, int item, Colour c) - SetItemFont(int item, Font f) + SetItemFont(self, int item, Font f) + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - wxArrayString choices=wxPyEmptyStringArray, + __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 - + @@ -15678,13 +18076,13 @@ optionally associating some data object with the item. PreCheckListBox() -> CheckListBox - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - wxArrayString choices=wxPyEmptyStringArray, + 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 - + @@ -15694,30 +18092,30 @@ optionally associating some data object with the item. - IsChecked(int index) -> bool + IsChecked(self, int index) -> bool - Check(int index, int check=True) + Check(self, int index, int check=True) - GetItemHeight() -> int + GetItemHeight(self) -> int - HitTest(Point pt) -> int + HitTest(self, Point pt) -> int Test where the given (in client coords) point lies - HitTestXY(int x, int y) -> int + HitTestXY(self, int x, int y) -> int Test where the given (in client coords) point lies @@ -15728,127 +18126,129 @@ optionally associating some data object with the item. #--------------------------------------------------------------------------- - - - - __init__() -> TextAttr -__init__(Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont, - int alignment=TEXT_ALIGNMENT_DEFAULT) -> TextAttr + + + __init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour, + Font font=wxNullFont, int alignment=TEXT_ALIGNMENT_DEFAULT) -> TextAttr - + - __del__() + __del__(self) - Init() + Init(self) - SetTextColour(Colour colText) + SetTextColour(self, Colour colText) - SetBackgroundColour(Colour colBack) + SetBackgroundColour(self, Colour colBack) - SetFont(Font font, long flags=TEXT_ATTR_FONT) + SetFont(self, Font font, long flags=TEXT_ATTR_FONT) - SetAlignment(int alignment) + SetAlignment(self, int alignment) - SetTabs(wxArrayInt tabs) + SetTabs(self, wxArrayInt tabs) - SetLeftIndent(int indent) + SetLeftIndent(self, int indent, int subIndent=0) + - SetRightIndent(int indent) + SetRightIndent(self, int indent) - SetFlags(long flags) + SetFlags(self, long flags) - HasTextColour() -> bool + HasTextColour(self) -> bool - HasBackgroundColour() -> bool + HasBackgroundColour(self) -> bool - HasFont() -> bool + HasFont(self) -> bool - HasAlignment() -> bool + HasAlignment(self) -> bool - HasTabs() -> bool + HasTabs(self) -> bool - HasLeftIndent() -> bool + HasLeftIndent(self) -> bool - HasRightIndent() -> bool + HasRightIndent(self) -> bool - HasFlag(long flag) -> bool + HasFlag(self, long flag) -> bool - GetTextColour() -> Colour + GetTextColour(self) -> Colour - GetBackgroundColour() -> Colour + GetBackgroundColour(self) -> Colour - GetFont() -> Font + GetFont(self) -> Font - GetAlignment() -> int + GetAlignment(self) -> int - GetTabs() -> wxArrayInt + GetTabs(self) -> wxArrayInt - GetLeftIndent() -> long + GetLeftIndent(self) -> long + + + GetLeftSubIndent(self) -> long - GetRightIndent() -> long + GetRightIndent(self) -> long - GetFlags() -> long + GetFlags(self) -> long - IsDefault() -> bool + IsDefault(self) -> bool Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr @@ -15859,16 +18259,16 @@ __init__(Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont, - + - __init__(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, - Size size=DefaultSize, + __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 - + @@ -15881,13 +18281,13 @@ __init__(Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont, PreTextCtrl() -> TextCtrl - Create(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, - Size size=DefaultSize, + 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 - + @@ -15897,47 +18297,47 @@ __init__(Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont, - GetValue() -> String + GetValue(self) -> String - SetValue(String value) + SetValue(self, String value) - GetRange(long from, long to) -> String + GetRange(self, long from, long to) -> String - GetLineLength(long lineNo) -> int + GetLineLength(self, long lineNo) -> int - GetLineText(long lineNo) -> String + GetLineText(self, long lineNo) -> String - GetNumberOfLines() -> int + GetNumberOfLines(self) -> int - IsModified() -> bool + IsModified(self) -> bool - IsEditable() -> bool + IsEditable(self) -> bool - IsSingleLine() -> bool + IsSingleLine(self) -> bool - IsMultiLine() -> bool + IsMultiLine(self) -> bool GetSelection() -> (from, to) @@ -15948,13 +18348,13 @@ __init__(Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont, - GetStringSelection() -> String + GetStringSelection(self) -> String - Clear() + Clear(self) - Replace(long from, long to, String value) + Replace(self, long from, long to, String value) @@ -15962,56 +18362,56 @@ __init__(Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont, - Remove(long from, long to) + Remove(self, long from, long to) - LoadFile(String file) -> bool + LoadFile(self, String file) -> bool - SaveFile(String file=EmptyString) -> bool + SaveFile(self, String file=EmptyString) -> bool - MarkDirty() + MarkDirty(self) - DiscardEdits() + DiscardEdits(self) - SetMaxLength(unsigned long len) + SetMaxLength(self, unsigned long len) - WriteText(String text) + WriteText(self, String text) - AppendText(String text) + AppendText(self, String text) - EmulateKeyPress(KeyEvent event) -> bool + EmulateKeyPress(self, KeyEvent event) -> bool - SetStyle(long start, long end, TextAttr style) -> bool + SetStyle(self, long start, long end, TextAttr style) -> bool @@ -16019,23 +18419,23 @@ __init__(Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont, - GetStyle(long position, TextAttr style) -> bool + GetStyle(self, long position, TextAttr style) -> bool - SetDefaultStyle(TextAttr style) -> bool + SetDefaultStyle(self, TextAttr style) -> bool - GetDefaultStyle() -> TextAttr + GetDefaultStyle(self) -> TextAttr - XYToPosition(long x, long y) -> long + XYToPosition(self, long x, long y) -> long @@ -16050,101 +18450,127 @@ __init__(Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont, - ShowPosition(long pos) + ShowPosition(self, long pos) HitTest(Point pt) -> (result, row, col) - Find the character at position given in pixels. -NB: pt is in device coords (not adjusted for the client area -origin nor scrolling) + Find the row, col coresponding to the character at the point given in +pixels. NB: pt is in device coords but is not adjusted for the client +area origin nor scrolling. + + HitTestPos(Point pt) -> (result, position) + Find the character position in the text coresponding to the point +given in pixels. NB: pt is in device coords but is not adjusted for +the client area origin nor scrolling. + + + + + - Copy() + Copy(self) - Cut() + Cut(self) - Paste() + Paste(self) - CanCopy() -> bool + CanCopy(self) -> bool - CanCut() -> bool + CanCut(self) -> bool - CanPaste() -> bool + CanPaste(self) -> bool - Undo() + Undo(self) - Redo() + Redo(self) - CanUndo() -> bool + CanUndo(self) -> bool - CanRedo() -> bool + CanRedo(self) -> bool - SetInsertionPoint(long pos) + SetInsertionPoint(self, long pos) - SetInsertionPointEnd() + SetInsertionPointEnd(self) - GetInsertionPoint() -> long + GetInsertionPoint(self) -> long - GetLastPosition() -> long + GetLastPosition(self) -> long - SetSelection(long from, long to) + SetSelection(self, long from, long to) - SelectAll() + SelectAll(self) - SetEditable(bool editable) + SetEditable(self, bool editable) - write(String text) + write(self, String text) - GetString(long from, long to) -> String + GetString(self, long from, long to) -> String + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + - + - __init__(int winid, MouseEvent evtMouse, long start, long end) -> TextUrlEvent + __init__(self, int winid, MouseEvent evtMouse, long start, long end) -> TextUrlEvent @@ -16153,13 +18579,13 @@ origin nor scrolling) - GetMouseEvent() -> MouseEvent + GetMouseEvent(self) -> MouseEvent - GetURLStart() -> long + GetURLStart(self) -> long - GetURLEnd() -> long + GetURLEnd(self) -> long @@ -16171,10 +18597,10 @@ EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1) #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=SB_HORIZONTAL, Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> ScrollBar @@ -16191,7 +18617,7 @@ EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1) PreScrollBar() -> ScrollBar - Create(Window parent, int id=-1, Point pos=DefaultPosition, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=SB_HORIZONTAL, Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> bool Do the 2nd phase and create the GUI control. @@ -16206,42 +18632,42 @@ EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1) - GetThumbPosition() -> int + GetThumbPosition(self) -> int - GetThumbSize() -> int + GetThumbSize(self) -> int - GetPageSize() -> int + GetPageSize(self) -> int - GetRange() -> int + GetRange(self) -> int - IsVertical() -> bool + IsVertical(self) -> bool - SetThumbPosition(int viewStart) + SetThumbPosition(self, int viewStart) - SetScrollbar(int position, int thumbSize, int range, int pageSize, + SetScrollbar(self, int position, int thumbSize, int range, int pageSize, bool refresh=True) Sets the scrollbar properties of a built-in scrollbar. + :param orientation: Determines the scrollbar whose page size is to + be set. May be wx.HORIZONTAL or wx.VERTICAL. - orientation: Determines the scrollbar whose page size is to be - set. May be wx.HORIZONTAL or wx.VERTICAL. + :param position: The position of the scrollbar in scroll units. - position: The position of the scrollbar in scroll units. - - thumbSize: The size of the thumb, or visible portion of the + :param thumbSize: The size of the thumb, or visible portion of the scrollbar, in scroll units. - range: The maximum position of the scrollbar. + :param range: The maximum position of the scrollbar. - refresh: True to redraw the scrollbar, false otherwise. + :param refresh: True to redraw the scrollbar, false otherwise. + @@ -16250,14 +18676,30 @@ EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1) + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=SP_HORIZONTAL, String name=SPIN_BUTTON_NAME) -> SpinButton @@ -16273,7 +18715,7 @@ EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1) PreSpinButton() -> SpinButton - Create(Window parent, int id=-1, Point pos=DefaultPosition, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=SP_HORIZONTAL, String name=SPIN_BUTTON_NAME) -> bool @@ -16286,47 +18728,63 @@ EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1) - GetValue() -> int + GetValue(self) -> int - GetMin() -> int + GetMin(self) -> int - GetMax() -> int + GetMax(self) -> int - SetValue(int val) + SetValue(self, int val) - SetMin(int minVal) + SetMin(self, int minVal) - SetMax(int maxVal) + SetMax(self, int maxVal) - SetRange(int minVal, int maxVal) + SetRange(self, int minVal, int maxVal) - IsVertical() -> bool + IsVertical(self) -> bool + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + - + - __init__(Window parent, int id=-1, String value=EmptyString, + __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 @@ -16347,7 +18805,7 @@ EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1) PreSpinCtrl() -> SpinCtrl - Create(Window parent, int id=-1, String value=EmptyString, + 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 @@ -16365,55 +18823,71 @@ EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1) - GetValue() -> int + GetValue(self) -> int - SetValue(int value) + SetValue(self, int value) - SetValueString(String text) + SetValueString(self, String text) - SetRange(int minVal, int maxVal) + SetRange(self, int minVal, int maxVal) - GetMin() -> int + GetMin(self) -> int - GetMax() -> int + GetMax(self) -> int - SetSelection(long from, long to) + SetSelection(self, long from, long to) + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + - + - __init__(wxEventType commandType=wxEVT_NULL, int winid=0) -> SpinEvent + __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> SpinEvent - GetPosition() -> int + GetPosition(self) -> int - SetPosition(int pos) + SetPosition(self, int pos) @@ -16428,18 +18902,19 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) #--------------------------------------------------------------------------- - + - __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, + __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 - - + + @@ -16453,15 +18928,16 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) PreRadioBox() -> RadioBox - 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, + 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 - - + + @@ -16472,87 +18948,104 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) - SetSelection(int n) + SetSelection(self, int n) - GetSelection() -> int + GetSelection(self) -> int - GetStringSelection() -> String + GetStringSelection(self) -> String - SetStringSelection(String s) -> bool + SetStringSelection(self, String s) -> bool - GetCount() -> int + GetCount(self) -> int - FindString(String s) -> int + FindString(self, String s) -> int - GetString(int n) -> String + GetString(self, int n) -> String - SetString(int n, String label) + SetString(self, int n, String label) - EnableItem(int n, bool enable=True) + EnableItem(self, int n, bool enable=True) - ShowItem(int n, bool show=True) + ShowItem(self, int n, bool show=True) - GetColumnCount() -> int + GetColumnCount(self) -> int - GetRowCount() -> int + GetRowCount(self) -> int - GetNextItem(int item, int dir, long style) -> int + GetNextItem(self, int item, int dir, long style) -> int + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=RadioButtonNameStr) -> RadioButton + __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 - - + + @@ -16564,13 +19057,14 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) PreRadioButton() -> RadioButton - Create(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=RadioButtonNameStr) -> bool + 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 - - + + @@ -16579,31 +19073,48 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) - GetValue() -> bool + GetValue(self) -> bool - SetValue(bool value) + SetValue(self, bool value) + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, int value, int minValue, int maxValue, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=SL_HORIZONTAL, Validator validator=DefaultValidator, + __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 - - - - + + + + @@ -16615,16 +19126,17 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) PreSlider() -> Slider - Create(Window parent, int id, int value, int minValue, int maxValue, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=SL_HORIZONTAL, Validator validator=DefaultValidator, + 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 - - - - + + + + @@ -16633,101 +19145,117 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) - GetValue() -> int + GetValue(self) -> int - SetValue(int value) + SetValue(self, int value) - SetRange(int minValue, int maxValue) + SetRange(self, int minValue, int maxValue) - GetMin() -> int + GetMin(self) -> int - GetMax() -> int + GetMax(self) -> int - SetMin(int minValue) + SetMin(self, int minValue) - SetMax(int maxValue) + SetMax(self, int maxValue) - SetLineSize(int lineSize) + SetLineSize(self, int lineSize) - SetPageSize(int pageSize) + SetPageSize(self, int pageSize) - GetLineSize() -> int + GetLineSize(self) -> int - GetPageSize() -> int + GetPageSize(self) -> int - SetThumbLength(int lenPixels) + SetThumbLength(self, int lenPixels) - GetThumbLength() -> int + GetThumbLength(self) -> int - SetTickFreq(int n, int pos=1) + SetTickFreq(self, int n, int pos=1) - GetTickFreq() -> int + GetTickFreq(self) -> int - ClearTicks() + ClearTicks(self) - SetTick(int tickPos) + SetTick(self, int tickPos) - ClearSel() + ClearSel(self) - GetSelEnd() -> int + GetSelEnd(self) -> int - GetSelStart() -> int + GetSelStart(self) -> int - SetSelection(int min, int max) + SetSelection(self, int min, int max) - + + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- @@ -16735,16 +19263,17 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) EVT_TOGGLEBUTTON = wx.PyEventBinder( wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, 1) - + - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=ToggleButtonNameStr) -> ToggleButton + __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 - - + + @@ -16756,13 +19285,14 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) PreToggleButton() -> ToggleButton - Create(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=ToggleButtonNameStr) -> bool + 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 - - + + @@ -16771,109 +19301,125 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) - SetValue(bool value) + SetValue(self, bool value) - GetValue() -> bool + GetValue(self) -> bool - SetLabel(String label) + SetLabel(self, String label) Sets the item's text. + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - GetPageCount() -> size_t + GetPageCount(self) -> size_t - GetPage(size_t n) -> Window + GetPage(self, size_t n) -> Window - GetSelection() -> int + GetSelection(self) -> int - SetPageText(size_t n, String strText) -> bool + SetPageText(self, size_t n, String strText) -> bool - GetPageText(size_t n) -> String + GetPageText(self, size_t n) -> String - SetImageList(ImageList imageList) + SetImageList(self, ImageList imageList) - AssignImageList(ImageList imageList) + AssignImageList(self, ImageList imageList) - GetImageList() -> ImageList + GetImageList(self) -> ImageList - GetPageImage(size_t n) -> int + GetPageImage(self, size_t n) -> int - SetPageImage(size_t n, int imageId) -> bool + SetPageImage(self, size_t n, int imageId) -> bool - SetPageSize(Size size) + SetPageSize(self, Size size) - CalcSizeFromPage(Size sizePage) -> Size + CalcSizeFromPage(self, Size sizePage) -> Size - DeletePage(size_t n) -> bool + DeletePage(self, size_t n) -> bool - RemovePage(size_t n) -> bool + RemovePage(self, size_t n) -> bool - DeleteAllPages() -> bool + DeleteAllPages(self) -> bool - AddPage(Window page, String text, bool select=False, int imageId=-1) -> bool + AddPage(self, Window page, String text, bool select=False, int imageId=-1) -> bool @@ -16882,7 +19428,7 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) - InsertPage(size_t n, Window page, String text, bool select=False, + InsertPage(self, size_t n, Window page, String text, bool select=False, int imageId=-1) -> bool @@ -16893,22 +19439,38 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) - SetSelection(size_t n) -> int + SetSelection(self, size_t n) -> int - AdvanceSelection(bool forward=True) + AdvanceSelection(self, bool forward=True) + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + - + - __init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, + __init__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, int nOldSel=-1) -> BookCtrlEvent @@ -16918,19 +19480,19 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) - GetSelection() -> int + GetSelection(self) -> int - SetSelection(int nSel) + SetSelection(self, int nSel) - GetOldSelection() -> int + GetOldSelection(self) -> int - SetOldSelection(int nOldSel) + SetOldSelection(self, int nOldSel) @@ -16939,10 +19501,10 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=NOTEBOOK_NAME) -> Notebook @@ -16957,11 +19519,11 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) PreNotebook() -> Notebook - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=NOTEBOOK_NAME) -> bool + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=NOTEBOOK_NAME) -> bool - + @@ -16969,39 +19531,56 @@ EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) - GetRowCount() -> int + GetRowCount(self) -> int - SetPadding(Size padding) + SetPadding(self, Size padding) - SetTabSize(Size sz) + SetTabSize(self, Size sz) HitTest(Point pt) -> (tab, where) - Returns the tab which is hit, and flags indicating where using wx.NB_HITTEST_ flags. + Returns the tab which is hit, and flags indicating where using +wx.NB_HITTEST flags. - CalcSizeFromPage(Size sizePage) -> Size + CalcSizeFromPage(self, Size sizePage) -> Size + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + - + - __init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, + __init__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, int nOldSel=-1) -> NotebookEvent @@ -17050,10 +19629,10 @@ class NotebookPage(wx.Panel): #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=EmptyString) -> Listbook @@ -17068,11 +19647,11 @@ class NotebookPage(wx.Panel): PreListbook() -> Listbook - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=EmptyString) -> bool + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=EmptyString) -> bool - + @@ -17080,13 +19659,13 @@ class NotebookPage(wx.Panel): - IsVertical() -> bool + IsVertical(self) -> bool - + - __init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, + __init__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, int nOldSel=-1) -> ListbookEvent @@ -17103,166 +19682,178 @@ class NotebookPage(wx.Panel): #--------------------------------------------------------------------------- - + - __init__(BookCtrl nb) -> BookCtrlSizer + __init__(self, BookCtrl nb) -> BookCtrlSizer - RecalcSizes() + RecalcSizes(self) + Using the sizes calculated by `CalcMin` reposition and resize all the +items managed by this sizer. You should not need to call this directly as +it is called by `Layout`. - CalcMin() -> Size + CalcMin(self) -> Size + This method is where the sizer will do the actual calculation of its +children's minimal sizes. You should not need to call this directly as +it is called by `Layout`. - GetControl() -> BookCtrl + GetControl(self) -> BookCtrl - + - __init__(Notebook nb) -> NotebookSizer + __init__(self, Notebook nb) -> NotebookSizer - RecalcSizes() + RecalcSizes(self) + Using the sizes calculated by `CalcMin` reposition and resize all the +items managed by this sizer. You should not need to call this directly as +it is called by `Layout`. - CalcMin() -> Size + CalcMin(self) -> Size + This method is where the sizer will do the actual calculation of its +children's minimal sizes. You should not need to call this directly as +it is called by `Layout`. - GetNotebook() -> Notebook + GetNotebook(self) -> Notebook #--------------------------------------------------------------------------- - + - GetId() -> int + GetId(self) -> int - GetControl() -> Control + GetControl(self) -> Control - GetToolBar() -> ToolBarBase + GetToolBar(self) -> ToolBarBase - IsButton() -> int + IsButton(self) -> int - IsControl() -> int + IsControl(self) -> int - IsSeparator() -> int + IsSeparator(self) -> int - GetStyle() -> int + GetStyle(self) -> int - GetKind() -> int + GetKind(self) -> int - IsEnabled() -> bool + IsEnabled(self) -> bool - IsToggled() -> bool + IsToggled(self) -> bool - CanBeToggled() -> bool + CanBeToggled(self) -> bool - GetNormalBitmap() -> Bitmap + GetNormalBitmap(self) -> Bitmap - GetDisabledBitmap() -> Bitmap + GetDisabledBitmap(self) -> Bitmap - GetBitmap() -> Bitmap + GetBitmap(self) -> Bitmap - GetLabel() -> String + GetLabel(self) -> String - GetShortHelp() -> String + GetShortHelp(self) -> String - GetLongHelp() -> String + GetLongHelp(self) -> String - Enable(bool enable) -> bool + Enable(self, bool enable) -> bool - Toggle() + Toggle(self) - SetToggle(bool toggle) -> bool + SetToggle(self, bool toggle) -> bool - SetShortHelp(String help) -> bool + SetShortHelp(self, String help) -> bool - SetLongHelp(String help) -> bool + SetLongHelp(self, String help) -> bool - SetNormalBitmap(Bitmap bmp) + SetNormalBitmap(self, Bitmap bmp) - SetDisabledBitmap(Bitmap bmp) + SetDisabledBitmap(self, Bitmap bmp) - SetLabel(String label) + SetLabel(self, String label) - Detach() + Detach(self) - Attach(ToolBarBase tbar) + Attach(self, ToolBarBase tbar) - GetClientData() -> PyObject + GetClientData(self) -> PyObject - SetClientData(PyObject clientData) + SetClientData(self, PyObject clientData) - + - DoAddTool(int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap, + 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 @@ -17278,7 +19869,7 @@ class NotebookPage(wx.Panel): - DoInsertTool(size_t pos, int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap, + 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 @@ -17295,242 +19886,242 @@ class NotebookPage(wx.Panel): - AddToolItem(ToolBarToolBase tool) -> ToolBarToolBase + AddToolItem(self, ToolBarToolBase tool) -> ToolBarToolBase - InsertToolItem(size_t pos, ToolBarToolBase tool) -> ToolBarToolBase + InsertToolItem(self, size_t pos, ToolBarToolBase tool) -> ToolBarToolBase - AddControl(Control control) -> ToolBarToolBase + AddControl(self, Control control) -> ToolBarToolBase - InsertControl(size_t pos, Control control) -> ToolBarToolBase + InsertControl(self, size_t pos, Control control) -> ToolBarToolBase - FindControl(int id) -> Control + FindControl(self, int id) -> Control - AddSeparator() -> ToolBarToolBase + AddSeparator(self) -> ToolBarToolBase - InsertSeparator(size_t pos) -> ToolBarToolBase + InsertSeparator(self, size_t pos) -> ToolBarToolBase - RemoveTool(int id) -> ToolBarToolBase + RemoveTool(self, int id) -> ToolBarToolBase - DeleteToolByPos(size_t pos) -> bool + DeleteToolByPos(self, size_t pos) -> bool - DeleteTool(int id) -> bool + DeleteTool(self, int id) -> bool - ClearTools() + ClearTools(self) - Realize() -> bool + Realize(self) -> bool - EnableTool(int id, bool enable) + EnableTool(self, int id, bool enable) - ToggleTool(int id, bool toggle) + ToggleTool(self, int id, bool toggle) - SetToggle(int id, bool toggle) + SetToggle(self, int id, bool toggle) - GetToolClientData(int id) -> PyObject + GetToolClientData(self, int id) -> PyObject - SetToolClientData(int id, PyObject clientData) + SetToolClientData(self, int id, PyObject clientData) - GetToolPos(int id) -> int + GetToolPos(self, int id) -> int - GetToolState(int id) -> bool + GetToolState(self, int id) -> bool - GetToolEnabled(int id) -> bool + GetToolEnabled(self, int id) -> bool - SetToolShortHelp(int id, String helpString) + SetToolShortHelp(self, int id, String helpString) - GetToolShortHelp(int id) -> String + GetToolShortHelp(self, int id) -> String - SetToolLongHelp(int id, String helpString) + SetToolLongHelp(self, int id, String helpString) - GetToolLongHelp(int id) -> String + GetToolLongHelp(self, int id) -> String - SetMarginsXY(int x, int y) + SetMarginsXY(self, int x, int y) - SetMargins(Size size) + SetMargins(self, Size size) - SetToolPacking(int packing) + SetToolPacking(self, int packing) - SetToolSeparation(int separation) + SetToolSeparation(self, int separation) - GetToolMargins() -> Size + GetToolMargins(self) -> Size - GetMargins() -> Size + GetMargins(self) -> Size - GetToolPacking() -> int + GetToolPacking(self) -> int - GetToolSeparation() -> int + GetToolSeparation(self) -> int - SetRows(int nRows) + SetRows(self, int nRows) - SetMaxRowsCols(int rows, int cols) + SetMaxRowsCols(self, int rows, int cols) - GetMaxRows() -> int + GetMaxRows(self) -> int - GetMaxCols() -> int + GetMaxCols(self) -> int - SetToolBitmapSize(Size size) + SetToolBitmapSize(self, Size size) - GetToolBitmapSize() -> Size + GetToolBitmapSize(self) -> Size - GetToolSize() -> Size + GetToolSize(self) -> Size - FindToolForPosition(int x, int y) -> ToolBarToolBase + FindToolForPosition(self, int x, int y) -> ToolBarToolBase - FindById(int toolid) -> ToolBarToolBase + FindById(self, int toolid) -> ToolBarToolBase - IsVertical() -> bool + IsVertical(self) -> bool - + - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxNO_BORDER|wxTB_HORIZONTAL, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL, String name=wxPyToolBarNameStr) -> ToolBar - + @@ -17541,12 +20132,12 @@ class NotebookPage(wx.Panel): PreToolBar() -> ToolBar - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxNO_BORDER|wxTB_HORIZONTAL, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL, String name=wxPyToolBarNameStr) -> bool - + @@ -17554,12 +20145,28 @@ class NotebookPage(wx.Panel): - FindToolForPosition(int x, int y) -> ToolBarToolBase + FindToolForPosition(self, int x, int y) -> ToolBarToolBase + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- @@ -17567,9 +20174,9 @@ class NotebookPage(wx.Panel): #--------------------------------------------------------------------------- - + - __init__(Colour colText=wxNullColour, Colour colBack=wxNullColour, + __init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour, Font font=wxNullFont) -> ListItemAttr @@ -17578,181 +20185,181 @@ class NotebookPage(wx.Panel): - SetTextColour(Colour colText) + SetTextColour(self, Colour colText) - SetBackgroundColour(Colour colBack) + SetBackgroundColour(self, Colour colBack) - SetFont(Font font) + SetFont(self, Font font) - HasTextColour() -> bool + HasTextColour(self) -> bool - HasBackgroundColour() -> bool + HasBackgroundColour(self) -> bool - HasFont() -> bool + HasFont(self) -> bool - GetTextColour() -> Colour + GetTextColour(self) -> Colour - GetBackgroundColour() -> Colour + GetBackgroundColour(self) -> Colour - GetFont() -> Font + GetFont(self) -> Font - Destroy() + Destroy(self) #--------------------------------------------------------------------------- - + - __init__() -> ListItem + __init__(self) -> ListItem - __del__() + __del__(self) - Clear() + Clear(self) - ClearAttributes() + ClearAttributes(self) - SetMask(long mask) + SetMask(self, long mask) - SetId(long id) + SetId(self, long id) - SetColumn(int col) + SetColumn(self, int col) - SetState(long state) + SetState(self, long state) - SetStateMask(long stateMask) + SetStateMask(self, long stateMask) - SetText(String text) + SetText(self, String text) - SetImage(int image) + SetImage(self, int image) - SetData(long data) + SetData(self, long data) - SetWidth(int width) + SetWidth(self, int width) - SetAlign(int align) + SetAlign(self, int align) - SetTextColour(Colour colText) + SetTextColour(self, Colour colText) - SetBackgroundColour(Colour colBack) + SetBackgroundColour(self, Colour colBack) - SetFont(Font font) + SetFont(self, Font font) - GetMask() -> long + GetMask(self) -> long - GetId() -> long + GetId(self) -> long - GetColumn() -> int + GetColumn(self) -> int - GetState() -> long + GetState(self) -> long - GetText() -> String + GetText(self) -> String - GetImage() -> int + GetImage(self) -> int - GetData() -> long + GetData(self) -> long - GetWidth() -> int + GetWidth(self) -> int - GetAlign() -> int + GetAlign(self) -> int - GetAttributes() -> ListItemAttr + GetAttributes(self) -> ListItemAttr - HasAttributes() -> bool + HasAttributes(self) -> bool - GetTextColour() -> Colour + GetTextColour(self) -> Colour - GetBackgroundColour() -> Colour + GetBackgroundColour(self) -> Colour - GetFont() -> Font + GetFont(self) -> Font @@ -17768,10 +20375,10 @@ class NotebookPage(wx.Panel): #--------------------------------------------------------------------------- - + - __init__(wxEventType commandType=wxEVT_NULL, int id=0) -> ListEvent + __init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> ListEvent @@ -17784,46 +20391,46 @@ class NotebookPage(wx.Panel): - GetKeyCode() -> int + GetKeyCode(self) -> int - GetIndex() -> long + GetIndex(self) -> long - GetColumn() -> int + GetColumn(self) -> int - GetPoint() -> Point + GetPoint(self) -> Point - GetLabel() -> String + GetLabel(self) -> String - GetText() -> String + GetText(self) -> String - GetImage() -> int + GetImage(self) -> int - GetData() -> long + GetData(self) -> long - GetMask() -> long + GetMask(self) -> long - GetItem() -> ListItem + GetItem(self) -> ListItem - GetCacheFrom() -> long + GetCacheFrom(self) -> long - GetCacheTo() -> long + GetCacheTo(self) -> long - IsEditCancelled() -> bool + IsEditCancelled(self) -> bool - SetEditCanceled(bool editCancelled) + SetEditCanceled(self, bool editCancelled) @@ -17857,10 +20464,10 @@ EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=LC_ICON, Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListCtrl @@ -17877,7 +20484,7 @@ EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED PreListCtrl() -> ListCtrl - Create(Window parent, int id=-1, Point pos=DefaultPosition, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=LC_ICON, Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool Do the 2nd phase and create the GUI control. @@ -17892,71 +20499,71 @@ EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - SetForegroundColour(Colour col) -> bool + SetForegroundColour(self, Colour col) -> bool - SetBackgroundColour(Colour col) -> bool + SetBackgroundColour(self, Colour col) -> bool - GetColumn(int col) -> ListItem + GetColumn(self, int col) -> ListItem - SetColumn(int col, ListItem item) -> bool + SetColumn(self, int col, ListItem item) -> bool - GetColumnWidth(int col) -> int + GetColumnWidth(self, int col) -> int - SetColumnWidth(int col, int width) -> bool + SetColumnWidth(self, int col, int width) -> bool - GetCountPerPage() -> int + GetCountPerPage(self) -> int - GetViewRect() -> Rect + GetViewRect(self) -> Rect - GetItem(long itemId, int col=0) -> ListItem + GetItem(self, long itemId, int col=0) -> ListItem - SetItem(ListItem info) -> bool + SetItem(self, ListItem info) -> bool - SetStringItem(long index, int col, String label, int imageId=-1) -> long + SetStringItem(self, long index, int col, String label, int imageId=-1) -> long @@ -17965,14 +20572,14 @@ EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED - GetItemState(long item, long stateMask) -> int + GetItemState(self, long item, long stateMask) -> int - SetItemState(long item, long state, long stateMask) -> bool + SetItemState(self, long item, long state, long stateMask) -> bool @@ -17980,7 +20587,7 @@ EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED - SetItemImage(long item, int image, int selImage) -> bool + SetItemImage(self, long item, int image, int selImage) -> bool @@ -17988,100 +20595,101 @@ EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED - GetItemText(long item) -> String + GetItemText(self, long item) -> String - SetItemText(long item, String str) + SetItemText(self, long item, String str) - GetItemData(long item) -> long + GetItemData(self, long item) -> long - SetItemData(long item, long data) -> bool + SetItemData(self, long item, long data) -> bool - GetItemPosition(long item) -> Point + GetItemPosition(self, long item) -> Point - GetItemRect(long item, int code=LIST_RECT_BOUNDS) -> Rect + GetItemRect(self, long item, int code=LIST_RECT_BOUNDS) -> Rect - SetItemPosition(long item, Point pos) -> bool + SetItemPosition(self, long item, Point pos) -> bool - GetItemCount() -> int + GetItemCount(self) -> int - GetColumnCount() -> int + GetColumnCount(self) -> int - GetItemSpacing() -> Size + GetItemSpacing(self) -> Size - SetItemSpacing(int spacing, bool isSmall=False) + SetItemSpacing(self, int spacing, bool isSmall=False) - GetSelectedItemCount() -> int + GetSelectedItemCount(self) -> int - GetTextColour() -> Colour + GetTextColour(self) -> Colour - SetTextColour(Colour col) + SetTextColour(self, Colour col) - GetTopItem() -> long + GetTopItem(self) -> long - SetSingleStyle(long style, bool add=True) + SetSingleStyle(self, long style, bool add=True) - SetWindowStyleFlag(long style) + SetWindowStyleFlag(self, long style) 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. +changed after the window creation and that Refresh() might need to be +called after changing the others for the change to take place +immediately. - GetNextItem(long item, int geometry=LIST_NEXT_ALL, int state=LIST_STATE_DONTCARE) -> long + GetNextItem(self, long item, int geometry=LIST_NEXT_ALL, int state=LIST_STATE_DONTCARE) -> long @@ -18089,85 +20697,85 @@ after changing the others for the change to take place immediately. - GetImageList(int which) -> ImageList + GetImageList(self, int which) -> ImageList - SetImageList(ImageList imageList, int which) + SetImageList(self, ImageList imageList, int which) - AssignImageList(ImageList imageList, int which) + AssignImageList(self, ImageList imageList, int which) - InReportView() -> bool + InReportView(self) -> bool - IsVirtual() -> bool + IsVirtual(self) -> bool - RefreshItem(long item) + RefreshItem(self, long item) - RefreshItems(long itemFrom, long itemTo) + RefreshItems(self, long itemFrom, long itemTo) - Arrange(int flag=LIST_ALIGN_DEFAULT) -> bool + Arrange(self, int flag=LIST_ALIGN_DEFAULT) -> bool - DeleteItem(long item) -> bool + DeleteItem(self, long item) -> bool - DeleteAllItems() -> bool + DeleteAllItems(self) -> bool - DeleteColumn(int col) -> bool + DeleteColumn(self, int col) -> bool - DeleteAllColumns() -> bool + DeleteAllColumns(self) -> bool - ClearAll() + ClearAll(self) - EditLabel(long item) + EditLabel(self, long item) - EnsureVisible(long item) -> bool + EnsureVisible(self, long item) -> bool - FindItem(long start, String str, bool partial=False) -> long + FindItem(self, long start, String str, bool partial=False) -> long @@ -18175,14 +20783,14 @@ after changing the others for the change to take place immediately. - FindItemData(long start, long data) -> long + FindItemData(self, long start, long data) -> long - FindItemAtPos(long start, Point pt, int direction) -> long + FindItemAtPos(self, long start, Point pt, int direction) -> long @@ -18191,35 +20799,35 @@ after changing the others for the change to take place immediately. HitTest(Point point) -> (item, where) - Determines which item (if any) is at the specified point, -giving details in the second return value (see wxLIST_HITTEST_... flags.) + Determines which item (if any) is at the specified point, giving + in the second return value (see wxLIST_HITTEST_... flags.) - InsertItem(ListItem info) -> long + InsertItem(self, ListItem info) -> long - InsertStringItem(long index, String label) -> long + InsertStringItem(self, long index, String label) -> long - InsertImageItem(long index, int imageIndex) -> long + InsertImageItem(self, long index, int imageIndex) -> long - InsertImageStringItem(long index, String label, int imageIndex) -> long + InsertImageStringItem(self, long index, String label, int imageIndex) -> long @@ -18227,14 +20835,14 @@ giving details in the second return value (see wxLIST_HITTEST_... flags.) - InsertColumnInfo(long col, ListItem info) -> long + InsertColumnInfo(self, long col, ListItem info) -> long - InsertColumn(long col, String heading, int format=LIST_FORMAT_LEFT, + InsertColumn(self, long col, String heading, int format=LIST_FORMAT_LEFT, int width=-1) -> long @@ -18244,61 +20852,77 @@ giving details in the second return value (see wxLIST_HITTEST_... flags.) - SetItemCount(long count) + SetItemCount(self, long count) - ScrollList(int dx, int dy) -> bool + ScrollList(self, int dx, int dy) -> bool - SetItemTextColour(long item, Colour col) + SetItemTextColour(self, long item, Colour col) - GetItemTextColour(long item) -> Colour + GetItemTextColour(self, long item) -> Colour - SetItemBackgroundColour(long item, Colour col) + SetItemBackgroundColour(self, long item, Colour col) - GetItemBackgroundColour(long item) -> Colour + GetItemBackgroundColour(self, long item) -> Colour - SortItems(PyObject func) -> bool + SortItems(self, PyObject func) -> bool - GetMainWindow() -> Window + GetMainWindow(self) -> Window + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=LC_REPORT, Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListView @@ -18315,7 +20939,7 @@ giving details in the second return value (see wxLIST_HITTEST_... flags.)PreListView() -> ListView - Create(Window parent, int id=-1, Point pos=DefaultPosition, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=LC_REPORT, Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool Do the 2nd phase and create the GUI control. @@ -18330,45 +20954,45 @@ giving details in the second return value (see wxLIST_HITTEST_... flags.) - Select(long n, bool on=True) + Select(self, long n, bool on=True) - Focus(long index) + Focus(self, long index) - GetFocusedItem() -> long + GetFocusedItem(self) -> long - GetNextSelected(long item) -> long + GetNextSelected(self, long item) -> long - GetFirstSelected() -> long + GetFirstSelected(self) -> long - IsSelected(long index) -> bool + IsSelected(self, long index) -> bool - SetColumnImage(int col, int image) + SetColumnImage(self, int col, int image) - ClearColumnImage(int col) + ClearColumnImage(self, int col) @@ -18380,57 +21004,57 @@ giving details in the second return value (see wxLIST_HITTEST_... flags.) #--------------------------------------------------------------------------- - + - __init__() -> TreeItemId + __init__(self) -> TreeItemId - __del__() + __del__(self) - IsOk() -> bool + IsOk(self) -> bool - __eq__(TreeItemId other) -> bool + __eq__(self, TreeItemId other) -> bool - __ne__(TreeItemId other) -> bool + __ne__(self, TreeItemId other) -> bool - + - __init__(PyObject obj=None) -> TreeItemData + __init__(self, PyObject obj=None) -> TreeItemData - GetData() -> PyObject + GetData(self) -> PyObject - SetData(PyObject obj) + SetData(self, PyObject obj) - GetId() -> TreeItemId + GetId(self) -> TreeItemId - SetId(TreeItemId id) + SetId(self, TreeItemId id) - Destroy() + Destroy(self) @@ -18459,74 +21083,74 @@ EVT_TREE_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_DRAG 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) - + - __init__(wxEventType commandType=wxEVT_NULL, int id=0) -> TreeEvent + __init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> TreeEvent - GetItem() -> TreeItemId + GetItem(self) -> TreeItemId - SetItem(TreeItemId item) + SetItem(self, TreeItemId item) - GetOldItem() -> TreeItemId + GetOldItem(self) -> TreeItemId - SetOldItem(TreeItemId item) + SetOldItem(self, TreeItemId item) - GetPoint() -> Point + GetPoint(self) -> Point - SetPoint(Point pt) + SetPoint(self, Point pt) - GetKeyEvent() -> KeyEvent + GetKeyEvent(self) -> KeyEvent - GetKeyCode() -> int + GetKeyCode(self) -> int - SetKeyEvent(KeyEvent evt) + SetKeyEvent(self, KeyEvent evt) - GetLabel() -> String + GetLabel(self) -> String - SetLabel(String label) + SetLabel(self, String label) - IsEditCancelled() -> bool + IsEditCancelled(self) -> bool - SetEditCanceled(bool editCancelled) + SetEditCanceled(self, bool editCancelled) - SetToolTip(String toolTip) + SetToolTip(self, String toolTip) @@ -18535,10 +21159,10 @@ EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __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 @@ -18556,7 +21180,7 @@ EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP PreTreeCtrl() -> TreeCtrl - Create(Window parent, int id=-1, Point pos=DefaultPosition, + 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 @@ -18572,115 +21196,115 @@ EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - GetCount() -> size_t + GetCount(self) -> size_t - GetIndent() -> unsigned int + GetIndent(self) -> unsigned int - SetIndent(unsigned int indent) + SetIndent(self, unsigned int indent) - GetSpacing() -> unsigned int + GetSpacing(self) -> unsigned int - SetSpacing(unsigned int spacing) + SetSpacing(self, unsigned int spacing) - GetImageList() -> ImageList + GetImageList(self) -> ImageList - GetStateImageList() -> ImageList + GetStateImageList(self) -> ImageList - SetImageList(ImageList imageList) + SetImageList(self, ImageList imageList) - SetStateImageList(ImageList imageList) + SetStateImageList(self, ImageList imageList) - AssignImageList(ImageList imageList) + AssignImageList(self, ImageList imageList) - AssignStateImageList(ImageList imageList) + AssignStateImageList(self, ImageList imageList) - GetItemText(TreeItemId item) -> String + GetItemText(self, TreeItemId item) -> String - GetItemImage(TreeItemId item, int which=TreeItemIcon_Normal) -> int + GetItemImage(self, TreeItemId item, int which=TreeItemIcon_Normal) -> int - GetItemData(TreeItemId item) -> TreeItemData + GetItemData(self, TreeItemId item) -> TreeItemData - GetItemPyData(TreeItemId item) -> PyObject + GetItemPyData(self, TreeItemId item) -> PyObject - GetItemTextColour(TreeItemId item) -> Colour + GetItemTextColour(self, TreeItemId item) -> Colour - GetItemBackgroundColour(TreeItemId item) -> Colour + GetItemBackgroundColour(self, TreeItemId item) -> Colour - GetItemFont(TreeItemId item) -> Font + GetItemFont(self, TreeItemId item) -> Font - SetItemText(TreeItemId item, String text) + SetItemText(self, TreeItemId item, String text) - SetItemImage(TreeItemId item, int image, int which=TreeItemIcon_Normal) + SetItemImage(self, TreeItemId item, int image, int which=TreeItemIcon_Normal) @@ -18688,154 +21312,154 @@ EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP - SetItemData(TreeItemId item, TreeItemData data) + SetItemData(self, TreeItemId item, TreeItemData data) - SetItemPyData(TreeItemId item, PyObject obj) + SetItemPyData(self, TreeItemId item, PyObject obj) - SetItemHasChildren(TreeItemId item, bool has=True) + SetItemHasChildren(self, TreeItemId item, bool has=True) - SetItemBold(TreeItemId item, bool bold=True) + SetItemBold(self, TreeItemId item, bool bold=True) - SetItemTextColour(TreeItemId item, Colour col) + SetItemTextColour(self, TreeItemId item, Colour col) - SetItemBackgroundColour(TreeItemId item, Colour col) + SetItemBackgroundColour(self, TreeItemId item, Colour col) - SetItemFont(TreeItemId item, Font font) + SetItemFont(self, TreeItemId item, Font font) - IsVisible(TreeItemId item) -> bool + IsVisible(self, TreeItemId item) -> bool - ItemHasChildren(TreeItemId item) -> bool + ItemHasChildren(self, TreeItemId item) -> bool - IsExpanded(TreeItemId item) -> bool + IsExpanded(self, TreeItemId item) -> bool - IsSelected(TreeItemId item) -> bool + IsSelected(self, TreeItemId item) -> bool - IsBold(TreeItemId item) -> bool + IsBold(self, TreeItemId item) -> bool - GetChildrenCount(TreeItemId item, bool recursively=True) -> size_t + GetChildrenCount(self, TreeItemId item, bool recursively=True) -> size_t - GetRootItem() -> TreeItemId + GetRootItem(self) -> TreeItemId - GetSelection() -> TreeItemId + GetSelection(self) -> TreeItemId - GetSelections() -> PyObject + GetSelections(self) -> PyObject - GetItemParent(TreeItemId item) -> TreeItemId + GetItemParent(self, TreeItemId item) -> TreeItemId - GetFirstChild(TreeItemId item) -> PyObject + GetFirstChild(self, TreeItemId item) -> PyObject - GetNextChild(TreeItemId item, void cookie) -> PyObject + GetNextChild(self, TreeItemId item, void cookie) -> PyObject - GetLastChild(TreeItemId item) -> TreeItemId + GetLastChild(self, TreeItemId item) -> TreeItemId - GetNextSibling(TreeItemId item) -> TreeItemId + GetNextSibling(self, TreeItemId item) -> TreeItemId - GetPrevSibling(TreeItemId item) -> TreeItemId + GetPrevSibling(self, TreeItemId item) -> TreeItemId - GetFirstVisibleItem() -> TreeItemId + GetFirstVisibleItem(self) -> TreeItemId - GetNextVisible(TreeItemId item) -> TreeItemId + GetNextVisible(self, TreeItemId item) -> TreeItemId - GetPrevVisible(TreeItemId item) -> TreeItemId + GetPrevVisible(self, TreeItemId item) -> TreeItemId - AddRoot(String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId + AddRoot(self, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId @@ -18844,7 +21468,7 @@ EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP - PrependItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1, + PrependItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId @@ -18855,7 +21479,7 @@ EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP - InsertItem(TreeItemId parent, TreeItemId idPrevious, String text, + InsertItem(self, TreeItemId parent, TreeItemId idPrevious, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId @@ -18867,7 +21491,7 @@ EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP - InsertItemBefore(TreeItemId parent, size_t index, String text, int image=-1, + InsertItemBefore(self, TreeItemId parent, size_t index, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId @@ -18879,7 +21503,7 @@ EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP - AppendItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1, + AppendItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId @@ -18890,102 +21514,101 @@ EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP - Delete(TreeItemId item) + Delete(self, TreeItemId item) - DeleteChildren(TreeItemId item) + DeleteChildren(self, TreeItemId item) - DeleteAllItems() + DeleteAllItems(self) - Expand(TreeItemId item) + Expand(self, TreeItemId item) - Collapse(TreeItemId item) + Collapse(self, TreeItemId item) - CollapseAndReset(TreeItemId item) + CollapseAndReset(self, TreeItemId item) - Toggle(TreeItemId item) + Toggle(self, TreeItemId item) - Unselect() + Unselect(self) - UnselectItem(TreeItemId item) + UnselectItem(self, TreeItemId item) - UnselectAll() + UnselectAll(self) - SelectItem(TreeItemId item, bool select=True) + SelectItem(self, TreeItemId item, bool select=True) - ToggleItemSelection(TreeItemId item) + ToggleItemSelection(self, TreeItemId item) - EnsureVisible(TreeItemId item) + EnsureVisible(self, TreeItemId item) - ScrollTo(TreeItemId item) + ScrollTo(self, TreeItemId item) - EditLabel(TreeItemId item) + EditLabel(self, TreeItemId item) - GetEditControl() -> TextCtrl + GetEditControl(self) -> TextCtrl - SortChildren(TreeItemId item) + SortChildren(self, TreeItemId item) HitTest(Point point) -> (item, where) - 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. + 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. @@ -18993,20 +21616,36 @@ constants. - GetBoundingRect(TreeItemId item, bool textOnly=False) -> PyObject + GetBoundingRect(self, TreeItemId item, bool textOnly=False) -> PyObject + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- - + - __init__(Window parent, int id=-1, String dir=DirDialogDefaultFolderStr, + __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, @@ -19027,7 +21666,7 @@ constants. PreGenericDirCtrl() -> GenericDirCtrl - Create(Window parent, int id=-1, String dir=DirDialogDefaultFolderStr, + 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, @@ -19045,73 +21684,74 @@ constants. - ExpandPath(String path) -> bool + ExpandPath(self, String path) -> bool - GetDefaultPath() -> String + GetDefaultPath(self) -> String - SetDefaultPath(String path) + SetDefaultPath(self, String path) - GetPath() -> String + GetPath(self) -> String - GetFilePath() -> String + GetFilePath(self) -> String - SetPath(String path) + SetPath(self, String path) - ShowHidden(bool show) + ShowHidden(self, bool show) - GetShowHidden() -> bool + GetShowHidden(self) -> bool - GetFilter() -> String + GetFilter(self) -> String - SetFilter(String filter) + SetFilter(self, String filter) - GetFilterIndex() -> int + GetFilterIndex(self) -> int - SetFilterIndex(int n) + SetFilterIndex(self, int n) - GetRootId() -> TreeItemId + GetRootId(self) -> TreeItemId - GetTreeCtrl() -> TreeCtrl + GetTreeCtrl(self) -> TreeCtrl - GetFilterListCtrl() -> DirFilterListCtrl + GetFilterListCtrl(self) -> DirFilterListCtrl FindChild(wxTreeItemId parentId, wxString path) -> (item, done) - 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 + 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. @@ -19120,16 +21760,16 @@ If the path string has been used (we're at the leaf), done is set to True - DoResize() + DoResize(self) - ReCreateTree() + ReCreateTree(self) - + - __init__(GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, + __init__(self, GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=0) -> DirFilterListCtrl @@ -19143,7 +21783,7 @@ If the path string has been used (we're at the leaf), done is set to True PreDirFilterListCtrl() -> DirFilterListCtrl - Create(GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, + Create(self, GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=0) -> bool @@ -19154,7 +21794,7 @@ If the path string has been used (we're at the leaf), done is set to True - FillFilterList(String filter, int defaultFilter) + FillFilterList(self, String filter, int defaultFilter) @@ -19164,15 +21804,15 @@ If the path string has been used (we're at the leaf), done is set to True #--------------------------------------------------------------------------- - + - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, Validator validator=DefaultValidator, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, String name=ControlNameStr) -> PyControl - + @@ -19180,15 +21820,24 @@ If the path string has been used (we're at the leaf), done is set to True + + PrePyControl() -> PyControl + - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) + + SetBestSize(self, Size size) + + + + - base_DoMoveWindow(int x, int y, int width, int height) + base_DoMoveWindow(self, int x, int y, int width, int height) @@ -19197,7 +21846,7 @@ If the path string has been used (we're at the leaf), done is set to True - base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) + base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) @@ -19207,14 +21856,14 @@ If the path string has been used (we're at the leaf), done is set to True - base_DoSetClientSize(int width, int height) + base_DoSetClientSize(self, int width, int height) - base_DoSetVirtualSize(int x, int y) + base_DoSetVirtualSize(self, int x, int y) @@ -19242,44 +21891,56 @@ If the path string has been used (we're at the leaf), done is set to True - base_DoGetVirtualSize() -> Size + base_DoGetVirtualSize(self) -> Size - base_DoGetBestSize() -> Size + base_DoGetBestSize(self) -> Size - base_InitDialog() + base_InitDialog(self) - base_TransferDataToWindow() -> bool + base_TransferDataToWindow(self) -> bool - base_TransferDataFromWindow() -> bool + base_TransferDataFromWindow(self) -> bool - base_Validate() -> bool + base_Validate(self) -> bool - base_AcceptsFocus() -> bool + base_AcceptsFocus(self) -> bool - base_AcceptsFocusFromKeyboard() -> bool + base_AcceptsFocusFromKeyboard(self) -> bool - base_GetMaxSize() -> Size + base_GetMaxSize(self) -> Size - base_AddChild(Window child) + base_AddChild(self, Window child) - base_RemoveChild(Window child) + base_RemoveChild(self, Window child) + + base_ShouldInheritColours(self) -> bool + + + base_ApplyParentThemeBackground(self, Colour c) + + + + + + base_GetDefaultAttributes(self) -> VisualAttributes + #--------------------------------------------------------------------------- @@ -19290,33 +21951,36 @@ EVT_HELP_RANGE = wx.PyEventBinder( wxEVT_HELP, 2) EVT_DETAILED_HELP = wx.PyEventBinder( wxEVT_DETAILED_HELP, 1) EVT_DETAILED_HELP_RANGE = wx.PyEventBinder( wxEVT_DETAILED_HELP, 2) - - 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 + + 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 + ============== ========================================= + +:see: `wx.ContextHelp`, `wx.ContextHelpButton` - __init__(wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> HelpEvent + __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> HelpEvent @@ -19324,67 +21988,68 @@ would stop after the first window found. - GetPosition() -> Point + GetPosition(self) -> Point Returns the left-click position of the mouse, in screen coordinates. This allows the application to position the help appropriately. - SetPosition(Point pos) + SetPosition(self, Point pos) Sets the left-click position of the mouse, in screen coordinates. - GetLink() -> String + GetLink(self) -> String Get an optional link to further help - SetLink(String link) + SetLink(self, String link) Set an optional link to further help - GetTarget() -> String + GetTarget(self) -> String Get an optional target to display help in. E.g. a window specification - SetTarget(String target) + SetTarget(self, String target) Set an optional target to display help in. E.g. a window specification - - 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. + + 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` - __init__(Window window=None, bool doNow=True) -> ContextHelp - Constructs a context help object, calling BeginContextHelp if -doNow is true (the default). + __init__(self, Window window=None, bool doNow=True) -> ContextHelp + Constructs a context help object, calling BeginContextHelp if doNow is +true (the default). If window is None, the top window is used. @@ -19393,42 +22058,43 @@ If window is None, the top window is used. - __del__() + __del__(self) - BeginContextHelp(Window window=None) -> bool - 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. + BeginContextHelp(self, Window window=None) -> bool + 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. +context-sensitive help mode. This function only returns when the event +loop has finished. - EndContextHelp() -> bool + EndContextHelp(self) -> bool Ends context-sensitive help mode. Not normally called by the application. - - 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. + + 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` - __init__(Window parent, int id=ID_CONTEXT_HELP, Point pos=DefaultPosition, + __init__(self, Window parent, int id=ID_CONTEXT_HELP, Point pos=DefaultPosition, Size size=DefaultSize, long style=BU_AUTODRAW) -> ContextHelpButton Constructor, creating and showing a context help button. @@ -19440,7 +22106,7 @@ to OK, Cancel or similar buttons. - + wx.HelpProvider is an abstract class used by a program implementing context-sensitive help to show the help text for the given window. @@ -19449,10 +22115,9 @@ The current help provider must be explicitly set by the application using wx.HelpProvider.Set(). Set(HelpProvider helpProvider) -> HelpProvider - 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. + 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. @@ -19462,27 +22127,25 @@ application. Return the current application-wide help provider. - GetHelp(Window window) -> String - 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. + GetHelp(self, Window window) -> String + 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. - ShowHelp(Window window) -> bool + ShowHelp(self, Window window) -> bool 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. +applicable. Returns True if it was done, or False if no help was +available for this window. - AddHelp(Window window, String text) + AddHelp(self, Window window, String text) Associates the text with the given window. @@ -19490,48 +22153,48 @@ for this window. - AddHelpById(int id, String text) + AddHelpById(self, int id, String text) 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. +id. May be used to set the same help string for all Cancel buttons in +the application, for example. - RemoveHelp(Window window) + RemoveHelp(self, Window window) 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. +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. - Destroy() + Destroy(self) - - 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. + + 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. - __init__() -> SimpleHelpProvider - 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. + __init__(self) -> SimpleHelpProvider + 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. #--------------------------------------------------------------------------- - + - __init__(Bitmap image, Cursor cursor=wxNullCursor) -> DragImage + __init__(self, Bitmap image, Cursor cursor=wxNullCursor) -> DragImage @@ -19566,16 +22229,16 @@ associated with the control (if any) in a tooltip. - __del__() + __del__(self) - SetBackingBitmap(Bitmap bitmap) + SetBackingBitmap(self, Bitmap bitmap) - BeginDrag(Point hotspot, Window window, bool fullScreen=False, + BeginDrag(self, Point hotspot, Window window, bool fullScreen=False, Rect rect=None) -> bool @@ -19585,7 +22248,7 @@ associated with the control (if any) in a tooltip. - BeginDragBounded(Point hotspot, Window window, Window boundingWindow) -> bool + BeginDragBounded(self, Point hotspot, Window window, Window boundingWindow) -> bool @@ -19593,35 +22256,35 @@ associated with the control (if any) in a tooltip. - EndDrag() -> bool + EndDrag(self) -> bool - Move(Point pt) -> bool + Move(self, Point pt) -> bool - Show() -> bool + Show(self) -> bool - Hide() -> bool + Hide(self) -> bool - GetImageRect(Point pos) -> Rect + GetImageRect(self, Point pos) -> Rect - DoDrawImage(DC dc, Point pos) -> bool + DoDrawImage(self, DC dc, Point pos) -> bool - UpdateBackingFromWindow(DC windowDC, MemoryDC destDC, Rect sourceRect, Rect destRect) -> bool + UpdateBackingFromWindow(self, DC windowDC, MemoryDC destDC, Rect sourceRect, Rect destRect) -> bool @@ -19630,7 +22293,7 @@ associated with the control (if any) in a tooltip. - RedrawImage(Point oldPos, Point newPos, bool eraseOld, bool drawNew) -> bool + RedrawImage(self, Point oldPos, Point newPos, bool eraseOld, bool drawNew) -> bool @@ -19640,13 +22303,13 @@ associated with the control (if any) in a tooltip. - - - wx = core + + + wx = _core #--------------------------------------------------------------------------- - + GetColour(int index) -> Colour @@ -19681,10 +22344,10 @@ associated with the control (if any) in a tooltip. - + - __init__() -> SystemOptions + __init__(self) -> SystemOptions SetOption(String name, String value) @@ -19793,12 +22456,19 @@ associated with the control (if any) in a tooltip. - - Usleep(unsigned long milliseconds) + + MilliSleep(unsigned long milliseconds) + + MicroSleep(unsigned long microseconds) + + + + + Usleep = MilliSleep EnableTopLevelWindows(bool enable) @@ -20054,6 +22724,10 @@ associated with the control (if any) in a tooltip. GetKeyState(int key) -> bool + 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. + @@ -20067,12 +22741,12 @@ associated with the control (if any) in a tooltip. MutexGuiLeave() - + - __init__() -> MutexGuiLocker + __init__(self) -> MutexGuiLocker - __del__() + __del__(self) @@ -20081,25 +22755,25 @@ associated with the control (if any) in a tooltip. #--------------------------------------------------------------------------- - + - __init__(String tip) -> ToolTip + __init__(self, String tip) -> ToolTip - SetTip(String tip) + SetTip(self, String tip) - GetTip() -> String + GetTip(self) -> String - GetWindow() -> Window + GetWindow(self) -> Window Enable(bool flag) @@ -20114,25 +22788,25 @@ associated with the control (if any) in a tooltip. - + - __init__(Window window, Size size) -> Caret + __init__(self, Window window, Size size) -> Caret - __del__() + __del__(self) - IsOk() -> bool + IsOk(self) -> bool - IsVisible() -> bool + IsVisible(self) -> bool - GetPosition() -> Point + GetPosition(self) -> Point GetPositionTuple() -> (x,y) @@ -20142,7 +22816,7 @@ associated with the control (if any) in a tooltip. - GetSize() -> Size + GetSize(self) -> Size GetSizeTuple() -> (width, height) @@ -20152,42 +22826,42 @@ associated with the control (if any) in a tooltip. - GetWindow() -> Window + GetWindow(self) -> Window - MoveXY(int x, int y) + MoveXY(self, int x, int y) - Move(Point pt) + Move(self, Point pt) - SetSizeWH(int width, int height) + SetSizeWH(self, int width, int height) - SetSize(Size size) + SetSize(self, Size size) - Show(int show=True) + Show(self, int show=True) - Hide() + Hide(self) @@ -20199,132 +22873,133 @@ associated with the control (if any) in a tooltip. - + - __init__(Cursor cursor=wxHOURGLASS_CURSOR) -> BusyCursor + __init__(self, Cursor cursor=wxHOURGLASS_CURSOR) -> BusyCursor - __del__() + __del__(self) - + - __init__(Window winToSkip=None) -> WindowDisabler + __init__(self, Window winToSkip=None) -> WindowDisabler - __del__() + __del__(self) - + - __init__(String message) -> BusyInfo + __init__(self, String message) -> BusyInfo - __del__() + __del__(self) - + - __init__() -> StopWatch + __init__(self) -> StopWatch - Start(long t0=0) + Start(self, long t0=0) - Pause() + Pause(self) - Resume() + Resume(self) - Time() -> long + Time(self) -> long - + - __init__(int maxFiles=9) -> FileHistory + __init__(self, int maxFiles=9, int idBase=ID_FILE1) -> FileHistory + - __del__() + __del__(self) - AddFileToHistory(String file) + AddFileToHistory(self, String file) - RemoveFileFromHistory(int i) + RemoveFileFromHistory(self, int i) - GetMaxFiles() -> int + GetMaxFiles(self) -> int - UseMenu(Menu menu) + UseMenu(self, Menu menu) - RemoveMenu(Menu menu) + RemoveMenu(self, Menu menu) - Load(ConfigBase config) + Load(self, ConfigBase config) - Save(ConfigBase config) + Save(self, ConfigBase config) - AddFilesToMenu() + AddFilesToMenu(self) - AddFilesToThisMenu(Menu menu) + AddFilesToThisMenu(self, Menu menu) - GetHistoryFile(int i) -> String + GetHistoryFile(self, int i) -> String - GetCount() -> int + GetCount(self) -> int - + - __init__(String name, String path=EmptyString) -> SingleInstanceChecker + __init__(self, String name, String path=EmptyString) -> SingleInstanceChecker @@ -20334,17 +23009,17 @@ associated with the control (if any) in a tooltip. PreSingleInstanceChecker() -> SingleInstanceChecker - __del__() + __del__(self) - Create(String name, String path=EmptyString) -> bool + Create(self, String name, String path=EmptyString) -> bool - IsAnotherRunning() -> bool + IsAnotherRunning(self) -> bool @@ -20358,33 +23033,33 @@ associated with the control (if any) in a tooltip. #--------------------------------------------------------------------------- - + - __del__() + __del__(self) - GetTip() -> String + GetTip(self) -> String - GetCurrentTip() -> size_t + GetCurrentTip(self) -> size_t - PreprocessTip(String tip) -> String + PreprocessTip(self, String tip) -> String - + - __init__(size_t currentTip) -> PyTipProvider + __init__(self, size_t currentTip) -> PyTipProvider - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) @@ -20409,20 +23084,20 @@ associated with the control (if any) in a tooltip. #--------------------------------------------------------------------------- - + - __init__(EvtHandler owner=None, int id=-1) -> Timer + __init__(self, EvtHandler owner=None, int id=-1) -> Timer - __del__() + __del__(self) - _setCallbackInfo(PyObject self, PyObject _class, int incref=1) + _setCallbackInfo(self, PyObject self, PyObject _class, int incref=1) @@ -20430,33 +23105,36 @@ associated with the control (if any) in a tooltip. - SetOwner(EvtHandler owner, int id=-1) + SetOwner(self, EvtHandler owner, int id=-1) + + GetOwner(self) -> EvtHandler + - Start(int milliseconds=-1, bool oneShot=False) -> bool + Start(self, int milliseconds=-1, bool oneShot=False) -> bool - Stop() + Stop(self) - IsRunning() -> bool + IsRunning(self) -> bool - GetInterval() -> int + GetInterval(self) -> int - IsOneShot() -> bool + IsOneShot(self) -> bool - GetId() -> int + GetId(self) -> int @@ -20474,28 +23152,28 @@ class PyTimer(Timer): EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 ) - + - __init__(int timerid=0, int interval=0) -> TimerEvent + __init__(self, int timerid=0, int interval=0) -> TimerEvent - GetInterval() -> int + GetInterval(self) -> int - + - __init__(wxTimer timer) -> TimerRunner -__init__(wxTimer timer, int milli, bool oneShot=False) -> TimerRunner + __init__(self, wxTimer timer) -> TimerRunner +__init__(self, wxTimer timer, int milli, bool oneShot=False) -> TimerRunner @@ -20503,10 +23181,10 @@ __init__(wxTimer timer, int milli, bool oneShot=False) -> TimerRunner - __del__() + __del__(self) - Start(int milli, bool oneShot=False) + Start(self, int milli, bool oneShot=False) @@ -20516,9 +23194,9 @@ __init__(wxTimer timer, int milli, bool oneShot=False) -> TimerRunner #--------------------------------------------------------------------------- - + - __init__() -> Log + __init__(self) -> Log IsEnabled() -> bool @@ -20538,7 +23216,7 @@ __init__(wxTimer timer, int milli, bool oneShot=False) -> TimerRunner - Flush() + Flush(self) FlushActive() @@ -20625,34 +23303,34 @@ __init__(wxTimer timer, int milli, bool oneShot=False) -> TimerRunnerTimeStamp() -> String - Destroy() + Destroy(self) - + - __init__() -> LogStderr + __init__(self) -> LogStderr - + - __init__(wxTextCtrl pTextCtrl) -> LogTextCtrl + __init__(self, wxTextCtrl pTextCtrl) -> LogTextCtrl - + - __init__() -> LogGui + __init__(self) -> LogGui - + - __init__(wxFrame pParent, String szTitle, bool bShow=True, bool bPassToOld=True) -> LogWindow + __init__(self, wxFrame pParent, String szTitle, bool bShow=True, bool bPassToOld=True) -> LogWindow @@ -20661,52 +23339,52 @@ __init__(wxTimer timer, int milli, bool oneShot=False) -> TimerRunner - Show(bool bShow=True) + Show(self, bool bShow=True) - GetFrame() -> wxFrame + GetFrame(self) -> wxFrame - GetOldLog() -> Log + GetOldLog(self) -> Log - IsPassingMessages() -> bool + IsPassingMessages(self) -> bool - PassMessages(bool bDoPass) + PassMessages(self, bool bDoPass) - + - __init__(Log logger) -> LogChain + __init__(self, Log logger) -> LogChain - SetLog(Log logger) + SetLog(self, Log logger) - PassMessages(bool bDoPass) + PassMessages(self, bool bDoPass) - IsPassingMessages() -> bool + IsPassingMessages(self) -> bool - GetOldLog() -> Log + GetOldLog(self) -> Log @@ -20807,21 +23485,21 @@ LogTrace(String mask, String msg) - + - __init__() -> LogNull + __init__(self) -> LogNull - __del__() + __del__(self) - + - __init__() -> PyLog + __init__(self) -> PyLog - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) @@ -20831,10 +23509,10 @@ LogTrace(String mask, String msg) #--------------------------------------------------------------------------- - + - __init__(EvtHandler parent=None, int id=-1) -> Process + __init__(self, EvtHandler parent=None, int id=-1) -> Process @@ -20861,54 +23539,54 @@ LogTrace(String mask, String msg) - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - base_OnTerminate(int pid, int status) + base_OnTerminate(self, int pid, int status) - Redirect() + Redirect(self) - IsRedirected() -> bool + IsRedirected(self) -> bool - Detach() + Detach(self) - GetInputStream() -> InputStream + GetInputStream(self) -> InputStream - GetErrorStream() -> InputStream + GetErrorStream(self) -> InputStream - GetOutputStream() -> OutputStream + GetOutputStream(self) -> OutputStream - CloseOutput() + CloseOutput(self) - IsInputOpened() -> bool + IsInputOpened(self) -> bool - IsInputAvailable() -> bool + IsInputAvailable(self) -> bool - IsErrorAvailable() -> bool + IsErrorAvailable(self) -> bool - + - __init__(int id=0, int pid=0, int exitcode=0) -> ProcessEvent + __init__(self, int id=0, int pid=0, int exitcode=0) -> ProcessEvent @@ -20916,10 +23594,10 @@ LogTrace(String mask, String msg) - GetPid() -> int + GetPid(self) -> int - GetExitCode() -> int + GetExitCode(self) -> int @@ -20938,154 +23616,154 @@ EVT_END_PROCESS = wx.PyEventBinder( wxEVT_END_PROCESS, 1 ) #--------------------------------------------------------------------------- - + - __init__(int joystick=JOYSTICK1) -> Joystick + __init__(self, int joystick=JOYSTICK1) -> Joystick - __del__() + __del__(self) - GetPosition() -> Point + GetPosition(self) -> Point - GetZPosition() -> int + GetZPosition(self) -> int - GetButtonState() -> int + GetButtonState(self) -> int - GetPOVPosition() -> int + GetPOVPosition(self) -> int - GetPOVCTSPosition() -> int + GetPOVCTSPosition(self) -> int - GetRudderPosition() -> int + GetRudderPosition(self) -> int - GetUPosition() -> int + GetUPosition(self) -> int - GetVPosition() -> int + GetVPosition(self) -> int - GetMovementThreshold() -> int + GetMovementThreshold(self) -> int - SetMovementThreshold(int threshold) + SetMovementThreshold(self, int threshold) - IsOk() -> bool + IsOk(self) -> bool - GetNumberJoysticks() -> int + GetNumberJoysticks(self) -> int - GetManufacturerId() -> int + GetManufacturerId(self) -> int - GetProductId() -> int + GetProductId(self) -> int - GetProductName() -> String + GetProductName(self) -> String - GetXMin() -> int + GetXMin(self) -> int - GetYMin() -> int + GetYMin(self) -> int - GetZMin() -> int + GetZMin(self) -> int - GetXMax() -> int + GetXMax(self) -> int - GetYMax() -> int + GetYMax(self) -> int - GetZMax() -> int + GetZMax(self) -> int - GetNumberButtons() -> int + GetNumberButtons(self) -> int - GetNumberAxes() -> int + GetNumberAxes(self) -> int - GetMaxButtons() -> int + GetMaxButtons(self) -> int - GetMaxAxes() -> int + GetMaxAxes(self) -> int - GetPollingMin() -> int + GetPollingMin(self) -> int - GetPollingMax() -> int + GetPollingMax(self) -> int - GetRudderMin() -> int + GetRudderMin(self) -> int - GetRudderMax() -> int + GetRudderMax(self) -> int - GetUMin() -> int + GetUMin(self) -> int - GetUMax() -> int + GetUMax(self) -> int - GetVMin() -> int + GetVMin(self) -> int - GetVMax() -> int + GetVMax(self) -> int - HasRudder() -> bool + HasRudder(self) -> bool - HasZ() -> bool + HasZ(self) -> bool - HasU() -> bool + HasU(self) -> bool - HasV() -> bool + HasV(self) -> bool - HasPOV() -> bool + HasPOV(self) -> bool - HasPOV4Dir() -> bool + HasPOV4Dir(self) -> bool - HasPOVCTS() -> bool + HasPOVCTS(self) -> bool - SetCapture(Window win, int pollingFreq=0) -> bool + SetCapture(self, Window win, int pollingFreq=0) -> bool - ReleaseCapture() -> bool + ReleaseCapture(self) -> bool - + - __init__(wxEventType type=wxEVT_NULL, int state=0, int joystick=JOYSTICK1, + __init__(self, wxEventType type=wxEVT_NULL, int state=0, int joystick=JOYSTICK1, int change=0) -> JoystickEvent @@ -21100,73 +23778,73 @@ EVT_END_PROCESS = wx.PyEventBinder( wxEVT_END_PROCESS, 1 ) - GetPosition() -> Point + GetPosition(self) -> Point - GetZPosition() -> int + GetZPosition(self) -> int - GetButtonState() -> int + GetButtonState(self) -> int - GetButtonChange() -> int + GetButtonChange(self) -> int - GetJoystick() -> int + GetJoystick(self) -> int - SetJoystick(int stick) + SetJoystick(self, int stick) - SetButtonState(int state) + SetButtonState(self, int state) - SetButtonChange(int change) + SetButtonChange(self, int change) - SetPosition(Point pos) + SetPosition(self, Point pos) - SetZPosition(int zPos) + SetZPosition(self, int zPos) - IsButton() -> bool + IsButton(self) -> bool - IsMove() -> bool + IsMove(self) -> bool - IsZMove() -> bool + IsZMove(self) -> bool - ButtonDown(int but=JOY_BUTTON_ANY) -> bool + ButtonDown(self, int but=JOY_BUTTON_ANY) -> bool - ButtonUp(int but=JOY_BUTTON_ANY) -> bool + ButtonUp(self, int but=JOY_BUTTON_ANY) -> bool - ButtonIsDown(int but=JOY_BUTTON_ANY) -> bool + ButtonIsDown(self, int but=JOY_BUTTON_ANY) -> bool @@ -21188,45 +23866,39 @@ EVT_JOYSTICK_EVENTS = wx.PyEventBinder([ wxEVT_JOY_BUTTON_DOWN, #--------------------------------------------------------------------------- - - - + + + __init__(self, String fileName=EmptyString) -> Sound - - + - - __init__() -> Sound -__init__(String fileName, bool isResource=false) -> Sound -__init__(int size, wxByte data) -> Sound + + SoundFromData(PyObject data) -> Sound - - + - __del__() + __del__(self) - + + Create(self, String fileName) -> bool - - - Create(String fileName, bool isResource=false) -> bool -Create(int size, wxByte data) -> bool + + CreateFromData(self, PyObject data) -> bool - - + - IsOk() -> bool + IsOk(self) -> bool - Play(unsigned int flags=SOUND_ASYNC) -> bool + Play(self, unsigned int flags=SOUND_ASYNC) -> bool @@ -21245,9 +23917,9 @@ Create(int size, wxByte data) -> bool #--------------------------------------------------------------------------- - + - __init__(String mimeType, String openCmd, String printCmd, String desc) -> FileTypeInfo + __init__(self, String mimeType, String openCmd, String printCmd, String desc) -> FileTypeInfo @@ -21265,100 +23937,100 @@ Create(int size, wxByte data) -> bool NullFileTypeInfo() -> FileTypeInfo - IsValid() -> bool + IsValid(self) -> bool - SetIcon(String iconFile, int iconIndex=0) + SetIcon(self, String iconFile, int iconIndex=0) - SetShortDesc(String shortDesc) + SetShortDesc(self, String shortDesc) - GetMimeType() -> String + GetMimeType(self) -> String - GetOpenCommand() -> String + GetOpenCommand(self) -> String - GetPrintCommand() -> String + GetPrintCommand(self) -> String - GetShortDesc() -> String + GetShortDesc(self) -> String - GetDescription() -> String + GetDescription(self) -> String - GetExtensions() -> wxArrayString + GetExtensions(self) -> wxArrayString - GetExtensionsCount() -> int + GetExtensionsCount(self) -> int - GetIconFile() -> String + GetIconFile(self) -> String - GetIconIndex() -> int + GetIconIndex(self) -> int - + - __init__(FileTypeInfo ftInfo) -> FileType + __init__(self, FileTypeInfo ftInfo) -> FileType - __del__() + __del__(self) - GetMimeType() -> PyObject + GetMimeType(self) -> PyObject - GetMimeTypes() -> PyObject + GetMimeTypes(self) -> PyObject - GetExtensions() -> PyObject + GetExtensions(self) -> PyObject - GetIcon() -> Icon + GetIcon(self) -> Icon - GetIconInfo() -> PyObject + GetIconInfo(self) -> PyObject - GetDescription() -> PyObject + GetDescription(self) -> PyObject - GetOpenCommand(String filename, String mimetype=EmptyString) -> PyObject + GetOpenCommand(self, String filename, String mimetype=EmptyString) -> PyObject - GetPrintCommand(String filename, String mimetype=EmptyString) -> PyObject + GetPrintCommand(self, String filename, String mimetype=EmptyString) -> PyObject - GetAllCommands(String filename, String mimetype=EmptyString) -> PyObject + GetAllCommands(self, String filename, String mimetype=EmptyString) -> PyObject - SetCommand(String cmd, String verb, bool overwriteprompt=True) -> bool + SetCommand(self, String cmd, String verb, bool overwriteprompt=True) -> bool @@ -21366,14 +24038,14 @@ Create(int size, wxByte data) -> bool - SetDefaultIcon(String cmd=EmptyString, int index=0) -> bool + SetDefaultIcon(self, String cmd=EmptyString, int index=0) -> bool - Unassociate() -> bool + Unassociate(self) -> bool ExpandCommand(String command, String filename, String mimetype=EmptyString) -> String @@ -21384,12 +24056,12 @@ Create(int size, wxByte data) -> bool - + - __init__() -> MimeTypesManager + __init__(self) -> MimeTypesManager - __del__() + __del__(self) IsOfType(String mimeType, String wildcard) -> bool @@ -21399,57 +24071,57 @@ Create(int size, wxByte data) -> bool - Initialize(int mailcapStyle=MAILCAP_ALL, String extraDir=EmptyString) + Initialize(self, int mailcapStyle=MAILCAP_ALL, String extraDir=EmptyString) - ClearData() + ClearData(self) - GetFileTypeFromExtension(String ext) -> FileType + GetFileTypeFromExtension(self, String ext) -> FileType - GetFileTypeFromMimeType(String mimeType) -> FileType + GetFileTypeFromMimeType(self, String mimeType) -> FileType - ReadMailcap(String filename, bool fallback=False) -> bool + ReadMailcap(self, String filename, bool fallback=False) -> bool - ReadMimeTypes(String filename) -> bool + ReadMimeTypes(self, String filename) -> bool - EnumAllFileTypes() -> PyObject + EnumAllFileTypes(self) -> PyObject - AddFallback(FileTypeInfo ft) + AddFallback(self, FileTypeInfo ft) - Associate(FileTypeInfo ftInfo) -> FileType + Associate(self, FileTypeInfo ftInfo) -> FileType - Unassociate(FileType ft) -> bool + Unassociate(self, FileType ft) -> bool @@ -21458,12 +24130,198 @@ Create(int size, wxByte data) -> bool #--------------------------------------------------------------------------- - + + 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 + + +Identifying art resources +------------------------- + +Every bitmap is known to wx.ArtProvider under an unique ID that is +used when requesting a resource from it. The IDs can have one of the +following predefined values. Additionally, any string recognized by +custom art providers registered using `PushProvider` may be used. + +GTK+ Note +--------- + +When running under GTK+ 2, GTK+ stock item IDs (e.g. 'gtk-cdrom') may be used +as well. Additionally, if wxGTK was compiled against GTK+ >= 2.4, then it is +also possible to load icons from current icon theme by specifying their name +without the extension and directory components. Icon themes recognized by GTK+ +follow the freedesktop.org Icon Themes specification. Note that themes are +not guaranteed to contain all icons, so wx.ArtProvider may return wx.NullBitmap +or wx.NullIcon. The default theme is typically installed in /usr/share/icons/hicolor. + + + * wx.ART_ADD_BOOKMARK + * wx.ART_DEL_BOOKMARK + * wx.ART_HELP_SIDE_PANEL + * wx.ART_HELP_SETTINGS + * wx.ART_HELP_BOOK + * wx.ART_HELP_FOLDER + * wx.ART_HELP_PAGE + * wx.ART_GO_BACK + * wx.ART_GO_FORWARD + * wx.ART_GO_UP + * wx.ART_GO_DOWN + * wx.ART_GO_TO_PARENT + * wx.ART_GO_HOME + * wx.ART_FILE_OPEN + * wx.ART_PRINT + * wx.ART_HELP + * wx.ART_TIP + * wx.ART_REPORT_VIEW + * wx.ART_LIST_VIEW + * wx.ART_NEW_DIR + * wx.ART_FOLDER + * wx.ART_GO_DIR_UP + * wx.ART_EXECUTABLE_FILE + * wx.ART_NORMAL_FILE + * wx.ART_TICK_MARK + * wx.ART_CROSS_MARK + * wx.ART_ERROR + * wx.ART_QUESTION + * wx.ART_WARNING + * wx.ART_INFORMATION + * wx.ART_MISSING_IMAGE + + +Clients +------- + +The Client is the entity that calls wx.ArtProvider's `GetBitmap` or +`GetIcon` function. Client IDs serve as a hint to wx.ArtProvider +that is supposed to help it to choose the best looking bitmap. For +example it is often desirable to use slightly different icons in menus +and toolbars even though they represent the same action (e.g. +wx.ART_FILE_OPEN). Remember that this is really only a hint for +wx.ArtProvider -- it is common that `wx.ArtProvider.GetBitmap` returns +identical bitmap for different client values! + + * wx.ART_TOOLBAR + * wx.ART_MENU + * wx.ART_FRAME_ICON + * wx.ART_CMN_DIALOG + * wx.ART_HELP_BROWSER + * wx.ART_MESSAGE_BOX + * wx.ART_BUTTON + * wx.ART_OTHER (used for all requests that don't fit into any + of the categories above) + - __init__() -> ArtProvider + __init__(self) -> ArtProvider + 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 + + +Identifying art resources +------------------------- + +Every bitmap is known to wx.ArtProvider under an unique ID that is +used when requesting a resource from it. The IDs can have one of the +following predefined values. Additionally, any string recognized by +custom art providers registered using `PushProvider` may be used. + +GTK+ Note +--------- + +When running under GTK+ 2, GTK+ stock item IDs (e.g. 'gtk-cdrom') may be used +as well. Additionally, if wxGTK was compiled against GTK+ >= 2.4, then it is +also possible to load icons from current icon theme by specifying their name +without the extension and directory components. Icon themes recognized by GTK+ +follow the freedesktop.org Icon Themes specification. Note that themes are +not guaranteed to contain all icons, so wx.ArtProvider may return wx.NullBitmap +or wx.NullIcon. The default theme is typically installed in /usr/share/icons/hicolor. + + + * wx.ART_ADD_BOOKMARK + * wx.ART_DEL_BOOKMARK + * wx.ART_HELP_SIDE_PANEL + * wx.ART_HELP_SETTINGS + * wx.ART_HELP_BOOK + * wx.ART_HELP_FOLDER + * wx.ART_HELP_PAGE + * wx.ART_GO_BACK + * wx.ART_GO_FORWARD + * wx.ART_GO_UP + * wx.ART_GO_DOWN + * wx.ART_GO_TO_PARENT + * wx.ART_GO_HOME + * wx.ART_FILE_OPEN + * wx.ART_PRINT + * wx.ART_HELP + * wx.ART_TIP + * wx.ART_REPORT_VIEW + * wx.ART_LIST_VIEW + * wx.ART_NEW_DIR + * wx.ART_FOLDER + * wx.ART_GO_DIR_UP + * wx.ART_EXECUTABLE_FILE + * wx.ART_NORMAL_FILE + * wx.ART_TICK_MARK + * wx.ART_CROSS_MARK + * wx.ART_ERROR + * wx.ART_QUESTION + * wx.ART_WARNING + * wx.ART_INFORMATION + * wx.ART_MISSING_IMAGE + + +Clients +------- + +The Client is the entity that calls wx.ArtProvider's `GetBitmap` or +`GetIcon` function. Client IDs serve as a hint to wx.ArtProvider +that is supposed to help it to choose the best looking bitmap. For +example it is often desirable to use slightly different icons in menus +and toolbars even though they represent the same action (e.g. +wx.ART_FILE_OPEN). Remember that this is really only a hint for +wx.ArtProvider -- it is common that `wx.ArtProvider.GetBitmap` returns +identical bitmap for different client values! + + * wx.ART_TOOLBAR + * wx.ART_MENU + * wx.ART_FRAME_ICON + * wx.ART_CMN_DIALOG + * wx.ART_HELP_BROWSER + * wx.ART_MESSAGE_BOX + * wx.ART_BUTTON + * wx.ART_OTHER (used for all requests that don't fit into any + of the categories above) + - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) @@ -21482,8 +24340,8 @@ Create(int size, wxByte data) -> bool RemoveProvider(ArtProvider provider) -> bool - Remove provider. The provider must have been added previously! -The provider is _not_ deleted. + Remove provider. The provider must have been added previously! The +provider is _not_ deleted. @@ -21500,7 +24358,7 @@ wx.NullBitmap if no provider provides it. GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -> Icon - Query the providers for icon with given ID and return it. Return + Query the providers for icon with given ID and return it. Return wx.NullIcon if no provider provides it. @@ -21509,39 +24367,38 @@ wx.NullIcon if no provider provides it. - Destroy() + Destroy(self) #--------------------------------------------------------------------------- - + 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. - __del__() + __del__(self) Set(ConfigBase config) -> ConfigBase - Sets the global config object (the one returned by Get) and -returns a reference to the previous global config object. + Sets the global config object (the one returned by Get) and returns a +reference to the previous global config object. @@ -21561,34 +24418,35 @@ current platform. DontCreateOnDemand() - Should Get() try to create a new log object if there isn't a current one? + Should Get() try to create a new log object if there isn't a current +one? - SetPath(String path) - 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. + SetPath(self, String path) + 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. - GetPath() -> String + GetPath(self) -> String Retrieve the current path (always as absolute path) GetFirstGroup() -> (more, value, index) - 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. + 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. GetNextGroup(long index) -> (more, value, index) - 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. + 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. @@ -21596,66 +24454,66 @@ fetch the next item. GetFirstEntry() -> (more, value, index) 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. GetNextEntry(long index) -> (more, value, index) 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. - GetNumberOfEntries(bool recursive=False) -> size_t - Get the number of entries in the current group, with or -without its subgroups. + GetNumberOfEntries(self, bool recursive=False) -> size_t + Get the number of entries in the current group, with or without its +subgroups. - GetNumberOfGroups(bool recursive=False) -> size_t - Get the number of subgroups in the current group, with or -without its subgroups. + GetNumberOfGroups(self, bool recursive=False) -> size_t + Get the number of subgroups in the current group, with or without its +subgroups. - HasGroup(String name) -> bool + HasGroup(self, String name) -> bool Returns True if the group by this name exists - HasEntry(String name) -> bool + HasEntry(self, String name) -> bool Returns True if the entry by this name exists - Exists(String name) -> bool + Exists(self, String name) -> bool Returns True if either a group or an entry with a given name exists - GetEntryType(String name) -> int + GetEntryType(self, String name) -> int Get the type of the entry. Returns one of the wx.Config.Type_XXX values. - Read(String key, String defaultVal=EmptyString) -> String + Read(self, String key, String defaultVal=EmptyString) -> String Returns the value of key if it exists, defaultVal otherwise. @@ -21663,7 +24521,7 @@ without its subgroups. - ReadInt(String key, long defaultVal=0) -> long + ReadInt(self, String key, long defaultVal=0) -> long Returns the value of key if it exists, defaultVal otherwise. @@ -21671,7 +24529,7 @@ without its subgroups. - ReadFloat(String key, double defaultVal=0.0) -> double + ReadFloat(self, String key, double defaultVal=0.0) -> double Returns the value of key if it exists, defaultVal otherwise. @@ -21679,7 +24537,7 @@ without its subgroups. - ReadBool(String key, bool defaultVal=False) -> bool + ReadBool(self, String key, bool defaultVal=False) -> bool Returns the value of key if it exists, defaultVal otherwise. @@ -21687,7 +24545,7 @@ without its subgroups. - Write(String key, String value) -> bool + Write(self, String key, String value) -> bool write the value (return True on success) @@ -21695,7 +24553,7 @@ without its subgroups. - WriteInt(String key, long value) -> bool + WriteInt(self, String key, long value) -> bool write the value (return True on success) @@ -21703,7 +24561,7 @@ without its subgroups. - WriteFloat(String key, double value) -> bool + WriteFloat(self, String key, double value) -> bool write the value (return True on success) @@ -21711,7 +24569,7 @@ without its subgroups. - WriteBool(String key, bool value) -> bool + WriteBool(self, String key, bool value) -> bool write the value (return True on success) @@ -21719,14 +24577,14 @@ without its subgroups. - Flush(bool currentOnly=False) -> bool + Flush(self, bool currentOnly=False) -> bool permanently writes all changes - RenameEntry(String oldName, String newName) -> bool + RenameEntry(self, String oldName, String newName) -> bool Rename an entry. Returns False on failure (probably because the new name is already taken by an existing entry) @@ -21735,8 +24593,8 @@ name is already taken by an existing entry) - RenameGroup(String oldName, String newName) -> bool - Rename aa group. Returns False on failure (probably because the new + RenameGroup(self, String oldName, String newName) -> bool + Rename a group. Returns False on failure (probably because the new name is already taken by an existing entry) @@ -21744,90 +24602,91 @@ name is already taken by an existing entry) - DeleteEntry(String key, bool deleteGroupIfEmpty=True) -> bool - Deletes the specified entry and the group it belongs to if -it was the last key in it and the second parameter is True + DeleteEntry(self, String key, bool deleteGroupIfEmpty=True) -> bool + Deletes the specified entry and the group it belongs to if it was the +last key in it and the second parameter is True - DeleteGroup(String key) -> bool + DeleteGroup(self, String key) -> bool Delete the group (with all subgroups) - DeleteAll() -> bool + DeleteAll(self) -> bool Delete the whole underlying object (disk file, registry key, ...) -primarly intended for use by desinstallation routine. +primarly intended for use by deinstallation routine. - SetExpandEnvVars(bool doIt=True) - 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) + SetExpandEnvVars(self, bool doIt=True) + 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) - IsExpandingEnvVars() -> bool + IsExpandingEnvVars(self) -> bool Are we currently expanding environment variables? - SetRecordDefaults(bool doIt=True) + SetRecordDefaults(self, bool doIt=True) Set whether the config objec should record default values. - IsRecordingDefaults() -> bool + IsRecordingDefaults(self) -> bool Are we currently recording default values? - ExpandEnvVars(String str) -> String + ExpandEnvVars(self, String str) -> String Expand any environment variables in str and return the result - GetAppName() -> String + GetAppName(self) -> String - GetVendorName() -> String + GetVendorName(self) -> String - SetAppName(String appName) + SetAppName(self, String appName) - SetVendorName(String vendorName) + SetVendorName(self, String vendorName) - SetStyle(long style) + SetStyle(self, long style) - GetStyle() -> long + GetStyle(self) -> long - + This ConfigBase-derived class will use the registry on Windows, and will be a wx.FileConfig on other platforms. - __init__(String appName=EmptyString, String vendorName=EmptyString, + __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 @@ -21839,14 +24698,14 @@ and will be a wx.FileConfig on other platforms. - __del__() + __del__(self) - + This config class will use a file for storage on all platforms. - __init__(String appName=EmptyString, String vendorName=EmptyString, + __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 @@ -21858,35 +24717,35 @@ and will be a wx.FileConfig on other platforms. - __del__() + __del__(self) - - 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. + + 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. - __init__(ConfigBase config, String entry) -> ConfigPathChanger + __init__(self, ConfigBase config, String entry) -> ConfigPathChanger - __del__() + __del__(self) - Name() -> String + Name(self) -> String Get the key name ExpandEnvVars(String sz) -> String 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. +format is $VARNAME or ${VARNAME} where VARNAME contains alphanumeric +characters and '_' only. '$' must be escaped ('\\$') in order to be +taken literally. @@ -21894,9 +24753,9 @@ in order to be taken literally. #--------------------------------------------------------------------------- - + - __init__() -> DateTime + __init__(self) -> DateTime DateTimeFromTimeT(time_t timet) -> DateTime @@ -21933,7 +24792,7 @@ in order to be taken literally. - __del__() + __del__(self) SetCountry(int country) @@ -22049,22 +24908,22 @@ in order to be taken literally. Today() -> DateTime - SetToCurrent() -> DateTime + SetToCurrent(self) -> DateTime - SetTimeT(time_t timet) -> DateTime + SetTimeT(self, time_t timet) -> DateTime - SetJDN(double jdn) -> DateTime + SetJDN(self, double jdn) -> DateTime - SetHMS(int hour, int minute=0, int second=0, int millisec=0) -> DateTime + SetHMS(self, int hour, int minute=0, int second=0, int millisec=0) -> DateTime @@ -22073,7 +24932,7 @@ in order to be taken literally. - Set(int day, int month=Inv_Month, int year=Inv_Year, int hour=0, + 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 @@ -22086,90 +24945,90 @@ in order to be taken literally. - ResetTime() -> DateTime + ResetTime(self) -> DateTime - SetYear(int year) -> DateTime + SetYear(self, int year) -> DateTime - SetMonth(int month) -> DateTime + SetMonth(self, int month) -> DateTime - SetDay(int day) -> DateTime + SetDay(self, int day) -> DateTime - SetHour(int hour) -> DateTime + SetHour(self, int hour) -> DateTime - SetMinute(int minute) -> DateTime + SetMinute(self, int minute) -> DateTime - SetSecond(int second) -> DateTime + SetSecond(self, int second) -> DateTime - SetMillisecond(int millisecond) -> DateTime + SetMillisecond(self, int millisecond) -> DateTime - SetToWeekDayInSameWeek(int weekday, int flags=Monday_First) -> DateTime + SetToWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime - GetWeekDayInSameWeek(int weekday, int flags=Monday_First) -> DateTime + GetWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime - SetToNextWeekDay(int weekday) -> DateTime + SetToNextWeekDay(self, int weekday) -> DateTime - GetNextWeekDay(int weekday) -> DateTime + GetNextWeekDay(self, int weekday) -> DateTime - SetToPrevWeekDay(int weekday) -> DateTime + SetToPrevWeekDay(self, int weekday) -> DateTime - GetPrevWeekDay(int weekday) -> DateTime + GetPrevWeekDay(self, int weekday) -> DateTime - SetToWeekDay(int weekday, int n=1, int month=Inv_Month, int year=Inv_Year) -> bool + SetToWeekDay(self, int weekday, int n=1, int month=Inv_Month, int year=Inv_Year) -> bool @@ -22178,7 +25037,7 @@ in order to be taken literally. - SetToLastWeekDay(int weekday, int month=Inv_Month, int year=Inv_Year) -> bool + SetToLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> bool @@ -22186,7 +25045,7 @@ in order to be taken literally. - GetLastWeekDay(int weekday, int month=Inv_Month, int year=Inv_Year) -> DateTime + GetLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> DateTime @@ -22194,7 +25053,7 @@ in order to be taken literally. - SetToTheWeek(int numWeek, int weekday=Mon, int flags=Monday_First) -> bool + SetToTheWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> bool @@ -22202,7 +25061,7 @@ in order to be taken literally. - GetWeek(int numWeek, int weekday=Mon, int flags=Monday_First) -> DateTime + GetWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> DateTime @@ -22210,235 +25069,235 @@ in order to be taken literally. - SetToLastMonthDay(int month=Inv_Month, int year=Inv_Year) -> DateTime + SetToLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime - GetLastMonthDay(int month=Inv_Month, int year=Inv_Year) -> DateTime + GetLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime - SetToYearDay(int yday) -> DateTime + SetToYearDay(self, int yday) -> DateTime - GetYearDay(int yday) -> DateTime + GetYearDay(self, int yday) -> DateTime - GetJulianDayNumber() -> double + GetJulianDayNumber(self) -> double - GetJDN() -> double + GetJDN(self) -> double - GetModifiedJulianDayNumber() -> double + GetModifiedJulianDayNumber(self) -> double - GetMJD() -> double + GetMJD(self) -> double - GetRataDie() -> double + GetRataDie(self) -> double - ToTimezone(wxDateTime::TimeZone tz, bool noDST=False) -> DateTime + ToTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime - MakeTimezone(wxDateTime::TimeZone tz, bool noDST=False) -> DateTime + MakeTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime - ToGMT(bool noDST=False) -> DateTime + ToGMT(self, bool noDST=False) -> DateTime - MakeGMT(bool noDST=False) -> DateTime + MakeGMT(self, bool noDST=False) -> DateTime - IsDST(int country=Country_Default) -> int + IsDST(self, int country=Country_Default) -> int - IsValid() -> bool + IsValid(self) -> bool - GetTicks() -> time_t + GetTicks(self) -> time_t - GetYear(wxDateTime::TimeZone tz=LOCAL_TZ) -> int + GetYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - GetMonth(wxDateTime::TimeZone tz=LOCAL_TZ) -> int + GetMonth(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - GetDay(wxDateTime::TimeZone tz=LOCAL_TZ) -> int + GetDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - GetWeekDay(wxDateTime::TimeZone tz=LOCAL_TZ) -> int + GetWeekDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - GetHour(wxDateTime::TimeZone tz=LOCAL_TZ) -> int + GetHour(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - GetMinute(wxDateTime::TimeZone tz=LOCAL_TZ) -> int + GetMinute(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - GetSecond(wxDateTime::TimeZone tz=LOCAL_TZ) -> int + GetSecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - GetMillisecond(wxDateTime::TimeZone tz=LOCAL_TZ) -> int + GetMillisecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - GetDayOfYear(wxDateTime::TimeZone tz=LOCAL_TZ) -> int + GetDayOfYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - GetWeekOfYear(int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + GetWeekOfYear(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - GetWeekOfMonth(int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + GetWeekOfMonth(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - IsWorkDay(int country=Country_Default) -> bool + IsWorkDay(self, int country=Country_Default) -> bool - IsEqualTo(DateTime datetime) -> bool + IsEqualTo(self, DateTime datetime) -> bool - IsEarlierThan(DateTime datetime) -> bool + IsEarlierThan(self, DateTime datetime) -> bool - IsLaterThan(DateTime datetime) -> bool + IsLaterThan(self, DateTime datetime) -> bool - IsStrictlyBetween(DateTime t1, DateTime t2) -> bool + IsStrictlyBetween(self, DateTime t1, DateTime t2) -> bool - IsBetween(DateTime t1, DateTime t2) -> bool + IsBetween(self, DateTime t1, DateTime t2) -> bool - IsSameDate(DateTime dt) -> bool + IsSameDate(self, DateTime dt) -> bool - IsSameTime(DateTime dt) -> bool + IsSameTime(self, DateTime dt) -> bool - IsEqualUpTo(DateTime dt, TimeSpan ts) -> bool + IsEqualUpTo(self, DateTime dt, TimeSpan ts) -> bool - AddTS(TimeSpan diff) -> DateTime + AddTS(self, TimeSpan diff) -> DateTime - AddDS(DateSpan diff) -> DateTime + AddDS(self, DateSpan diff) -> DateTime - SubtractTS(TimeSpan diff) -> DateTime + SubtractTS(self, TimeSpan diff) -> DateTime - SubtractDS(DateSpan diff) -> DateTime + SubtractDS(self, DateSpan diff) -> DateTime - Subtract(DateTime dt) -> TimeSpan + Subtract(self, DateTime dt) -> TimeSpan @@ -22449,8 +25308,8 @@ in order to be taken literally. - __iadd__(TimeSpan diff) -> DateTime -__iadd__(DateSpan diff) -> DateTime + __iadd__(self, TimeSpan diff) -> DateTime +__iadd__(self, DateSpan diff) -> DateTime @@ -22461,8 +25320,8 @@ __iadd__(DateSpan diff) -> DateTime - __isub__(TimeSpan diff) -> DateTime -__isub__(DateSpan diff) -> DateTime + __isub__(self, TimeSpan diff) -> DateTime +__isub__(self, DateSpan diff) -> DateTime @@ -22473,8 +25332,8 @@ __isub__(DateSpan diff) -> DateTime - __add__(TimeSpan other) -> DateTime -__add__(DateSpan other) -> DateTime + __add__(self, TimeSpan other) -> DateTime +__add__(self, DateSpan other) -> DateTime @@ -22490,57 +25349,57 @@ __add__(DateSpan other) -> DateTime - __sub__(DateTime other) -> TimeSpan -__sub__(TimeSpan other) -> DateTime -__sub__(DateSpan other) -> DateTime + __sub__(self, DateTime other) -> TimeSpan +__sub__(self, TimeSpan other) -> DateTime +__sub__(self, DateSpan other) -> DateTime - __lt__(DateTime other) -> bool + __lt__(self, DateTime other) -> bool - __le__(DateTime other) -> bool + __le__(self, DateTime other) -> bool - __gt__(DateTime other) -> bool + __gt__(self, DateTime other) -> bool - __ge__(DateTime other) -> bool + __ge__(self, DateTime other) -> bool - __eq__(DateTime other) -> bool + __eq__(self, DateTime other) -> bool - __ne__(DateTime other) -> bool + __ne__(self, DateTime other) -> bool - ParseRfc822Date(String date) -> int + ParseRfc822Date(self, String date) -> int - ParseFormat(String date, String format=DateFormatStr, DateTime dateDef=DefaultDateTime) -> int + ParseFormat(self, String date, String format=DateFormatStr, DateTime dateDef=DefaultDateTime) -> int @@ -22548,46 +25407,46 @@ __sub__(DateSpan other) -> DateTime - ParseDateTime(String datetime) -> int + ParseDateTime(self, String datetime) -> int - ParseDate(String date) -> int + ParseDate(self, String date) -> int - ParseTime(String time) -> int + ParseTime(self, String time) -> int - Format(String format=DateFormatStr, wxDateTime::TimeZone tz=LOCAL_TZ) -> String + Format(self, String format=DateFormatStr, wxDateTime::TimeZone tz=LOCAL_TZ) -> String - FormatDate() -> String + FormatDate(self) -> String - FormatTime() -> String + FormatTime(self) -> String - FormatISODate() -> String + FormatISODate(self) -> String - FormatISOTime() -> String + FormatISOTime(self) -> String - + - __init__(long hours=0, long minutes=0, long seconds=0, long milliseconds=0) -> TimeSpan + __init__(self, long hours=0, long minutes=0, long seconds=0, long milliseconds=0) -> TimeSpan @@ -22596,7 +25455,7 @@ __sub__(DateSpan other) -> DateTime - __del__() + __del__(self) Seconds(long sec) -> TimeSpan @@ -22644,165 +25503,165 @@ __sub__(DateSpan other) -> DateTime Week() -> TimeSpan - Add(TimeSpan diff) -> TimeSpan + Add(self, TimeSpan diff) -> TimeSpan - Subtract(TimeSpan diff) -> TimeSpan + Subtract(self, TimeSpan diff) -> TimeSpan - Multiply(int n) -> TimeSpan + Multiply(self, int n) -> TimeSpan - Neg() -> TimeSpan + Neg(self) -> TimeSpan - Abs() -> TimeSpan + Abs(self) -> TimeSpan - __iadd__(TimeSpan diff) -> TimeSpan + __iadd__(self, TimeSpan diff) -> TimeSpan - __isub__(TimeSpan diff) -> TimeSpan + __isub__(self, TimeSpan diff) -> TimeSpan - __imul__(int n) -> TimeSpan + __imul__(self, int n) -> TimeSpan - __neg__() -> TimeSpan + __neg__(self) -> TimeSpan - __add__(TimeSpan other) -> TimeSpan + __add__(self, TimeSpan other) -> TimeSpan - __sub__(TimeSpan other) -> TimeSpan + __sub__(self, TimeSpan other) -> TimeSpan - __mul__(int n) -> TimeSpan + __mul__(self, int n) -> TimeSpan - __rmul__(int n) -> TimeSpan + __rmul__(self, int n) -> TimeSpan - __lt__(TimeSpan other) -> bool + __lt__(self, TimeSpan other) -> bool - __le__(TimeSpan other) -> bool + __le__(self, TimeSpan other) -> bool - __gt__(TimeSpan other) -> bool + __gt__(self, TimeSpan other) -> bool - __ge__(TimeSpan other) -> bool + __ge__(self, TimeSpan other) -> bool - __eq__(TimeSpan other) -> bool + __eq__(self, TimeSpan other) -> bool - __ne__(TimeSpan other) -> bool + __ne__(self, TimeSpan other) -> bool - IsNull() -> bool + IsNull(self) -> bool - IsPositive() -> bool + IsPositive(self) -> bool - IsNegative() -> bool + IsNegative(self) -> bool - IsEqualTo(TimeSpan ts) -> bool + IsEqualTo(self, TimeSpan ts) -> bool - IsLongerThan(TimeSpan ts) -> bool + IsLongerThan(self, TimeSpan ts) -> bool - IsShorterThan(TimeSpan t) -> bool + IsShorterThan(self, TimeSpan t) -> bool - GetWeeks() -> int + GetWeeks(self) -> int - GetDays() -> int + GetDays(self) -> int - GetHours() -> int + GetHours(self) -> int - GetMinutes() -> int + GetMinutes(self) -> int - GetSeconds() -> wxLongLong + GetSeconds(self) -> wxLongLong - GetMilliseconds() -> wxLongLong + GetMilliseconds(self) -> wxLongLong - Format(String format=TimeSpanFormatStr) -> String + Format(self, String format=TimeSpanFormatStr) -> String - + - __init__(int years=0, int months=0, int weeks=0, int days=0) -> DateSpan + __init__(self, int years=0, int months=0, int weeks=0, int days=0) -> DateSpan @@ -22811,7 +25670,7 @@ __sub__(DateSpan other) -> DateTime - __del__() + __del__(self) Days(int days) -> DateSpan @@ -22850,118 +25709,118 @@ __sub__(DateSpan other) -> DateTime Year() -> DateSpan - SetYears(int n) -> DateSpan + SetYears(self, int n) -> DateSpan - SetMonths(int n) -> DateSpan + SetMonths(self, int n) -> DateSpan - SetWeeks(int n) -> DateSpan + SetWeeks(self, int n) -> DateSpan - SetDays(int n) -> DateSpan + SetDays(self, int n) -> DateSpan - GetYears() -> int + GetYears(self) -> int - GetMonths() -> int + GetMonths(self) -> int - GetWeeks() -> int + GetWeeks(self) -> int - GetDays() -> int + GetDays(self) -> int - GetTotalDays() -> int + GetTotalDays(self) -> int - Add(DateSpan other) -> DateSpan + Add(self, DateSpan other) -> DateSpan - Subtract(DateSpan other) -> DateSpan + Subtract(self, DateSpan other) -> DateSpan - Neg() -> DateSpan + Neg(self) -> DateSpan - Multiply(int factor) -> DateSpan + Multiply(self, int factor) -> DateSpan - __iadd__(DateSpan other) -> DateSpan + __iadd__(self, DateSpan other) -> DateSpan - __isub__(DateSpan other) -> DateSpan + __isub__(self, DateSpan other) -> DateSpan - __neg__() -> DateSpan + __neg__(self) -> DateSpan - __imul__(int factor) -> DateSpan + __imul__(self, int factor) -> DateSpan - __add__(DateSpan other) -> DateSpan + __add__(self, DateSpan other) -> DateSpan - __sub__(DateSpan other) -> DateSpan + __sub__(self, DateSpan other) -> DateSpan - __mul__(int n) -> DateSpan + __mul__(self, int n) -> DateSpan - __rmul__(int n) -> DateSpan + __rmul__(self, int n) -> DateSpan - __eq__(DateSpan other) -> bool + __eq__(self, DateSpan other) -> bool - __ne__(DateSpan other) -> bool + __ne__(self, DateSpan other) -> bool @@ -22982,34 +25841,54 @@ __sub__(DateSpan other) -> DateTime #--------------------------------------------------------------------------- - + 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). +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, (which +may be the CLIPFORMAT under Windows or Atom under X11, for example.) + +The standard format IDs are: + + ================ ===================================== + wx.DF_INVALID An invalid format + wx.DF_TEXT Text format + wx.DF_BITMAP A bitmap (wx.Bitmap) + wx.DF_METAFILE A metafile (wx.Metafile, Windows only) + wx.DF_FILENAME A list of filenames + wx.DF_HTML An HTML string. This is only valid on + Windows and non-unicode builds + ================ ===================================== + +Aside the standard formats, the application may also use custom +formats which are identified by their names (strings) and not numeric +identifiers. Although internally custom format must be created (or +registered) first, you shouldn't care about it because it is done +automatically the first time the wxDataFormat object corresponding to +a given format name is created. + + - __init__(int type) -> DataFormat - 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) + __init__(self, int type) -> DataFormat + 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) CustomDataFormat(String format) -> DataFormat - Constructs a data format object for a custom format identified by its name. + Constructs a data format object for a custom format identified by its +name. - __del__() + __del__(self) @@ -23022,273 +25901,533 @@ this case) - __eq__(int format) -> bool -__eq__(DataFormat format) -> bool + __eq__(self, int format) -> bool +__eq__(self, DataFormat format) -> bool - __ne__(int format) -> bool -__ne__(DataFormat format) -> bool + __ne__(self, int format) -> bool +__ne__(self, DataFormat format) -> bool - SetType(int format) - Sets the format to the given value, which should be one of wx.DF_XXX constants. + SetType(self, int format) + Sets the format to the given value, which should be one of wx.DF_XXX +constants. - GetType() -> int + GetType(self) -> int Returns the platform-specific number identifying the format. - GetId() -> String - Returns the name of a custom format (this function will fail for a standard format). + GetId(self) -> String + Returns the name of a custom format (this function will fail for a +standard format). - SetId(String format) + SetId(self, String format) Sets the format to be the custom format identified by the given name. - + + 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`. + +Not surprisingly, being 'smart' comes at a price of added +complexity. This is reasonable for the situations when you really need +to support multiple formats, but may be annoying if you only want to +do something simple like cut and paste text. + +To provide a solution for both cases, wxWidgets has two predefined +classes which derive from wx.DataObject: `wx.DataObjectSimple` and +`wx.DataObjectComposite`. `wx.DataObjectSimple` is the simplest +wx.DataObject possible and only holds data in a single format (such as +text or bitmap) and `wx.DataObjectComposite` is the simplest way to +implement a wx.DataObject which supports multiple simultaneous formats +because it achievs this by simply holding several +`wx.DataObjectSimple` objects. + +Please note that the easiest way to use drag and drop and the +clipboard with multiple formats is by using `wx.DataObjectComposite`, +but it is not the most efficient one as each `wx.DataObjectSimple` +would contain the whole data in its respective formats. Now imagine +that you want to paste 200 pages of text in your proprietary format, +as well as Word, RTF, HTML, Unicode and plain text to the clipboard +and even today's computers are in trouble. For this case, you will +have to derive from wx.DataObject directly and make it enumerate its +formats and provide the data in the requested format on +demand. (**TODO**: This is currently not possible from Python. Make +it so.) + +Note that the platform transfer mechanisms for the clipboard and drag +and drop, do not copy any data out of the source application until +another application actually requests the data. This is in contrast to +the 'feel' offered to the user of a program who would normally think +that the data resides in the clipboard after having pressed 'Copy' - +in reality it is only declared to be available. + - __del__() + __del__(self) - GetPreferredFormat(int dir=Get) -> DataFormat + GetPreferredFormat(self, int dir=Get) -> DataFormat + 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. - GetFormatCount(int dir=Get) -> size_t + GetFormatCount(self, int dir=Get) -> size_t + Returns the number of available formats for rendering or setting the +data. - IsSupported(DataFormat format, int dir=Get) -> bool + IsSupported(self, DataFormat format, int dir=Get) -> bool + Returns True if this format is supported. - GetDataSize(DataFormat format) -> size_t + GetDataSize(self, DataFormat format) -> size_t + Get the (total) size of data for the given format - - GetAllFormats(DataFormat formats, int dir=Get) + + GetAllFormats(self, int dir=Get) -> [formats] + Returns a list of all the wx.DataFormats that this dataobject supports +in the given direction. - - - GetDataHere(DataFormat format, void buf) -> bool + + GetDataHere(self, DataFormat format) -> String + Get the data bytes in the specified format, returns None on failure. + +:todo: This should use the python buffer interface isntead... - - SetData(DataFormat format, size_t len, void buf) -> bool + SetData(self, DataFormat format, String data) -> bool + Set the data in the specified format from the bytes in the the data string. + +:todo: This should use the python buffer interface isntead... - - + - + + 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`. + - __init__(DataFormat format=FormatInvalid) -> DataObjectSimple + __init__(self, DataFormat format=FormatInvalid) -> DataObjectSimple + Constructor accepts the supported format (none by default) which may +also be set later with `SetFormat`. - GetFormat() -> DataFormat + GetFormat(self) -> DataFormat + Returns the (one and only one) format supported by this object. It is +assumed that the format is supported in both directions. - SetFormat(DataFormat format) + SetFormat(self, DataFormat format) + Sets the supported format. + + GetDataSize(self) -> size_t + Get the size of our data. + + + GetDataHere(self) -> String + 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. + + + SetData(self, String data) -> bool + Copy the data value to the data object. Must be implemented in the +derived class if the object supports setting its data. + + + + + - + + 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`. + +Here is a simple example:: + + class MyDataObject(wx.PyDataObjectSimple): + def __init__(self): + wx.PyDataObjectSimple.__init__( + self, wx.CustomDataFormat('MyDOFormat')) + self.data = '' + + def GetDataSize(self): + return len(self.data) + def GetDataHere(self): + return self.data # returns a string + def SetData(self, data): + self.data = data + return True + +Note that there is already a `wx.CustomDataObject` class that behaves +very similarly to this example. The value of creating your own +derived class like this is to be able to do additional things when the +data is requested or given via the clipboard or drag and drop +operation, such as generate the data value or decode it into needed +data structures. + - __init__(DataFormat format=FormatInvalid) -> PyDataObjectSimple + __init__(self, DataFormat format=FormatInvalid) -> PyDataObjectSimple + 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`. + +Here is a simple example:: + + class MyDataObject(wx.PyDataObjectSimple): + def __init__(self): + wx.PyDataObjectSimple.__init__( + self, wx.CustomDataFormat('MyDOFormat')) + self.data = '' + + def GetDataSize(self): + return len(self.data) + def GetDataHere(self): + return self.data # returns a string + def SetData(self, data): + self.data = data + return True + +Note that there is already a `wx.CustomDataObject` class that behaves +very similarly to this example. The value of creating your own +derived class like this is to be able to do additional things when the +data is requested or given via the clipboard or drag and drop +operation, such as generate the data value or decode it into needed +data structures. + - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - + + 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. + - __init__() -> DataObjectComposite + __init__(self) -> DataObjectComposite + 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. + - Add(DataObjectSimple dataObject, int preferred=False) + Add(self, DataObjectSimple dataObject, bool preferred=False) + Adds the dataObject to the list of supported objects and it becomes +the preferred object if preferred is True. - + - + + 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. - __init__(String text=EmptyString) -> TextDataObject + __init__(self, String text=EmptyString) -> TextDataObject + Constructor, may be used to initialise the text (otherwise `SetText` +should be used later). - GetTextLength() -> size_t + GetTextLength(self) -> size_t + 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. - GetText() -> String + GetText(self) -> String + Returns the text associated with the data object. - SetText(String text) + SetText(self, String text) + 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`.) - + + 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. - __init__(String text=EmptyString) -> PyTextDataObject + __init__(self, String text=EmptyString) -> PyTextDataObject + 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. - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - + + 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`. + +:see: `wx.PyBitmapDataObject` if you wish to override `GetBitmap` to increase efficiency. - __init__(Bitmap bitmap=wxNullBitmap) -> BitmapDataObject + __init__(self, Bitmap bitmap=wxNullBitmap) -> BitmapDataObject + Constructor, optionally passing a bitmap (otherwise use `SetBitmap` +later). - GetBitmap() -> Bitmap + GetBitmap(self) -> Bitmap + 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`. - SetBitmap(Bitmap bitmap) + SetBitmap(self, Bitmap bitmap) + 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. - + + 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`. - __init__(Bitmap bitmap=wxNullBitmap) -> PyBitmapDataObject + __init__(self, Bitmap bitmap=wxNullBitmap) -> PyBitmapDataObject + 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`. - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - + + 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. + - __init__() -> FileDataObject + __init__(self) -> FileDataObject - GetFilenames() -> wxArrayString + GetFilenames(self) -> [names] + Returns a list of file names. - AddFile(String filename) + AddFile(self, String filename) + Adds a file to the list of files represented by this data object. - + + 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. - __init__(DataFormat format=FormatInvalid) -> CustomDataObject + __init__(self, DataFormat format=FormatInvalid) -> CustomDataObject + 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. - - TakeData(PyObject data) - - - - - SetData(PyObject data) -> bool + SetData(self, String data) -> bool + Copy the data value to the data object. - GetSize() -> size_t + GetSize(self) -> size_t + Get the size of the data. - GetData() -> PyObject + GetData(self) -> String + Returns the data bytes from the data object as a string. - + + 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. - __init__() -> URLDataObject + __init__(self) -> URLDataObject + 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. - GetURL() -> String + GetURL(self) -> String + Returns a string containing the current URL. - SetURL(String url) + SetURL(self, String url) + Set the URL. - + - __init__() -> MetafileDataObject + __init__(self) -> MetafileDataObject @@ -23300,9 +26439,9 @@ __ne__(DataFormat format) -> bool - + - __init__(Window win, Icon copy=wxNullIcon, Icon move=wxNullIcon, + __init__(self, Window win, Icon copy=wxNullIcon, Icon move=wxNullIcon, Icon none=wxNullIcon) -> DropSource @@ -23312,10 +26451,10 @@ __ne__(DataFormat format) -> bool - __del__() + __del__(self) - _setCallbackInfo(PyObject self, PyObject _class, int incref) + _setCallbackInfo(self, PyObject self, PyObject _class, int incref) @@ -23323,62 +26462,62 @@ __ne__(DataFormat format) -> bool - SetData(DataObject data) + SetData(self, DataObject data) - GetDataObject() -> DataObject + GetDataObject(self) -> DataObject - SetCursor(int res, Cursor cursor) + SetCursor(self, int res, Cursor cursor) - DoDragDrop(int flags=Drag_CopyOnly) -> int + DoDragDrop(self, int flags=Drag_CopyOnly) -> int - base_GiveFeedback(int effect) -> bool + base_GiveFeedback(self, int effect) -> bool - + - __init__(DataObject dataObject=None) -> DropTarget + __init__(self, DataObject dataObject=None) -> DropTarget - __del__() + __del__(self) - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - GetDataObject() -> DataObject + GetDataObject(self) -> DataObject - SetDataObject(DataObject dataObject) + SetDataObject(self, DataObject dataObject) - base_OnEnter(int x, int y, int def) -> int + base_OnEnter(self, int x, int y, int def) -> int @@ -23386,7 +26525,7 @@ __ne__(DataFormat format) -> bool - base_OnDragOver(int x, int y, int def) -> int + base_OnDragOver(self, int x, int y, int def) -> int @@ -23394,34 +26533,34 @@ __ne__(DataFormat format) -> bool - base_OnLeave() + base_OnLeave(self) - base_OnDrop(int x, int y) -> bool + base_OnDrop(self, int x, int y) -> bool - GetData() -> bool + GetData(self) -> bool PyDropTarget = DropTarget - + - __init__() -> TextDropTarget + __init__(self) -> TextDropTarget - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - base_OnEnter(int x, int y, int def) -> int + base_OnEnter(self, int x, int y, int def) -> int @@ -23429,7 +26568,7 @@ __ne__(DataFormat format) -> bool - base_OnDragOver(int x, int y, int def) -> int + base_OnDragOver(self, int x, int y, int def) -> int @@ -23437,17 +26576,17 @@ __ne__(DataFormat format) -> bool - base_OnLeave() + base_OnLeave(self) - base_OnDrop(int x, int y) -> bool + base_OnDrop(self, int x, int y) -> bool - base_OnData(int x, int y, int def) -> int + base_OnData(self, int x, int y, int def) -> int @@ -23455,20 +26594,20 @@ __ne__(DataFormat format) -> bool - + - __init__() -> FileDropTarget + __init__(self) -> FileDropTarget - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - base_OnEnter(int x, int y, int def) -> int + base_OnEnter(self, int x, int y, int def) -> int @@ -23476,7 +26615,7 @@ __ne__(DataFormat format) -> bool - base_OnDragOver(int x, int y, int def) -> int + base_OnDragOver(self, int x, int y, int def) -> int @@ -23484,17 +26623,17 @@ __ne__(DataFormat format) -> bool - base_OnLeave() + base_OnLeave(self) - base_OnDrop(int x, int y) -> bool + base_OnDrop(self, int x, int y) -> bool - base_OnData(int x, int y, int def) -> int + base_OnData(self, int x, int y, int def) -> int @@ -23505,58 +26644,67 @@ __ne__(DataFormat format) -> bool #--------------------------------------------------------------------------- - - 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. + + 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` - __init__() -> Clipboard + __init__(self) -> Clipboard - __del__() + __del__(self) - Open() -> bool - 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. + Open(self) -> bool + 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. - Close() + Close(self) Closes the clipboard. - IsOpened() -> bool + IsOpened(self) -> bool Query whether the clipboard is opened - AddData(DataObject data) -> bool - Call this function to add the data object to the clipboard. You -may call this function repeatedly after having cleared the clipboard. + AddData(self, DataObject data) -> bool + 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. +do not delete the data explicitly. + +:see: `wx.DataObject` - SetData(DataObject data) -> bool - Set the clipboard data, this is the same as Clear followed by AddData. + SetData(self, DataObject data) -> bool + Set the clipboard data, this is the same as `Clear` followed by +`AddData`. + +:see: `wx.DataObject` - IsSupported(DataFormat format) -> bool + IsSupported(self, DataFormat format) -> bool Returns True if the given format is available in the data object(s) on the clipboard. @@ -23564,51 +26712,73 @@ the clipboard. - GetData(DataObject data) -> bool - Call this function to fill data with data on the clipboard, if available -in the required format. Returns true on success. + GetData(self, DataObject data) -> bool + Call this function to fill data with data on the clipboard, if +available in the required format. Returns true on success. - Clear() - Clears data from the clipboard object and also the system's clipboard + Clear(self) + Clears data from the clipboard object and also the system's clipboard if possible. - Flush() -> bool + Flush(self) -> bool 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. +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. - UsePrimarySelection(bool primary=True) - 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. + UsePrimarySelection(self, bool primary=True) + 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. + + Get() -> Clipboard + Returns global instance (wxTheClipboard) of the object. + - - A helpful class for opening the clipboard and automatically closing it when -the locker is destroyed. + + class _wxPyDelayedInitWrapper(object): + def __init__(self, initfunc, *args, **kwargs): + self._initfunc = initfunc + self._args = args + self._kwargs = kwargs + self._instance = None + def _checkInstance(self): + if self._instance is None: + self._instance = self._initfunc(*self._args, **self._kwargs) + def __getattr__(self, name): + self._checkInstance() + return getattr(self._instance, name) + def __repr__(self): + self._checkInstance() + return repr(self._instance) + TheClipboard = _wxPyDelayedInitWrapper(Clipboard.Get) + + + A helpful class for opening the clipboard and automatically +closing it when the locker is destroyed. - __init__(Clipboard clipboard=None) -> ClipboardLocker - A helpful class for opening the clipboard and automatically closing it when -the locker is destroyed. + __init__(self, Clipboard clipboard=None) -> ClipboardLocker + A helpful class for opening the clipboard and automatically +closing it when the locker is destroyed. - __del__() + __del__(self) - __nonzero__() -> bool + __nonzero__(self) -> bool A ClipboardLocker instance evaluates to True if the clipboard was successfully opened. @@ -23616,10 +26786,10 @@ successfully opened. #--------------------------------------------------------------------------- - + A simple struct containing video mode parameters for a display - __init__(int width=0, int height=0, int depth=0, int freq=0) -> VideoMode + __init__(self, int width=0, int height=0, int depth=0, int freq=0) -> VideoMode A simple struct containing video mode parameters for a display @@ -23629,44 +26799,43 @@ successfully opened. - __del__() + __del__(self) - Matches(VideoMode other) -> bool - 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 + Matches(self, VideoMode other) -> bool + 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) - GetWidth() -> int - Returns the screen width in pixels (e.g. 640*480), 0 means -unspecified + GetWidth(self) -> int + Returns the screen width in pixels (e.g. 640*480), 0 means unspecified - GetHeight() -> int + GetHeight(self) -> int Returns the screen width in pixels (e.g. 640*480), 0 means unspecified - GetDepth() -> int - Returns the screen's bits per pixel (e.g. 32), 1 is monochrome -and 0 means unspecified/known + GetDepth(self) -> int + Returns the screen's bits per pixel (e.g. 32), 1 is monochrome and 0 +means unspecified/known - IsOk() -> bool + IsOk(self) -> bool returns true if the object has been initialized - __eq__(VideoMode other) -> bool + __eq__(self, VideoMode other) -> bool - __ne__(VideoMode other) -> bool + __ne__(self, VideoMode other) -> bool @@ -23676,19 +26845,19 @@ and 0 means unspecified/known - + Represents a display/monitor attached to the system - __init__(size_t index=0) -> Display - 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 + __init__(self, size_t index=0) -> Display + 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 - __del__() + __del__(self) GetCount() -> size_t @@ -23696,77 +26865,92 @@ primary display and the only one which is always supported GetFromPoint(Point pt) -> int - Find the display where the given point lies, return wx.NOT_FOUND -if it doesn't belong to any display + Find the display where the given point lies, return wx.NOT_FOUND if it +doesn't belong to any display GetFromWindow(Window window) -> int - Find the display where the given window lies, return wx.NOT_FOUND -if it is not shown at all. + Find the display where the given window lies, return wx.NOT_FOUND if +it is not shown at all. - IsOk() -> bool + IsOk(self) -> bool Return true if the object was initialized successfully - GetGeometry() -> Rect - Returns the bounding rectangle of the display whose index was -passed to the constructor. + GetGeometry(self) -> Rect + Returns the bounding rectangle of the display whose index was passed +to the constructor. - GetName() -> String + GetName(self) -> String Returns the display's name. A name is not available on all platforms. - IsPrimary() -> bool + IsPrimary(self) -> bool Returns true if the display is the primary display. The primary display is the one whose index is 0. GetModes(VideoMode mode=DefaultVideoMode) -> [videoMode...] - Enumerate all video modes supported by this display matching the -given one (in the sense of VideoMode.Match()). + 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. +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. - GetCurrentMode() -> VideoMode + GetCurrentMode(self) -> VideoMode Get the current video mode. - ChangeMode(VideoMode mode=DefaultVideoMode) -> bool - Change current mode, return true if succeeded, false otherwise + ChangeMode(self, VideoMode mode=DefaultVideoMode) -> bool + Changes the video mode of this display to the mode specified in the +mode parameter. + +If wx.DefaultVideoMode is passed in as the mode parameter, the defined +behaviour is that wx.Display will reset the video mode to the default +mode used by the display. On Windows, the behavior is normal. +However, there are differences on other platforms. On Unix variations +using X11 extensions it should behave as defined, but some +irregularities may occur. + +On wxMac passing in wx.DefaultVideoMode as the mode parameter does +nothing. This happens because Carbon no longer has access to +DMUseScreenPrefs, an undocumented function that changed the video mode +to the system default by using the system's 'scrn' resource. + +Returns True if succeeded, False otherwise - ResetMode() + ResetMode(self) Restore the default video mode (just a more readable synonym) - - wx = core + + wx = _core + __docfilter__ = wx.__DocFilter(globals()) - A set of customization attributes for a calendar date, which can be used to -control the look of the Calendar object. + A set of customization attributes for a calendar date, which can be +used to control the look of the Calendar object. - __init__(Colour colText=wxNullColour, Colour colBack=wxNullColour, + __init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour, Colour colBorder=wxNullColour, Font font=wxNullFont, int border=CAL_BORDER_NONE) -> CalendarDateAttr Create a CalendarDateAttr. @@ -23779,101 +26963,101 @@ control the look of the Calendar object. - SetTextColour(Colour colText) + SetTextColour(self, Colour colText) - SetBackgroundColour(Colour colBack) + SetBackgroundColour(self, Colour colBack) - SetBorderColour(Colour col) + SetBorderColour(self, Colour col) - SetFont(Font font) + SetFont(self, Font font) - SetBorder(int border) + SetBorder(self, int border) - SetHoliday(bool holiday) + SetHoliday(self, bool holiday) - HasTextColour() -> bool + HasTextColour(self) -> bool - HasBackgroundColour() -> bool + HasBackgroundColour(self) -> bool - HasBorderColour() -> bool + HasBorderColour(self) -> bool - HasFont() -> bool + HasFont(self) -> bool - HasBorder() -> bool + HasBorder(self) -> bool - IsHoliday() -> bool + IsHoliday(self) -> bool - GetTextColour() -> Colour + GetTextColour(self) -> Colour - GetBackgroundColour() -> Colour + GetBackgroundColour(self) -> Colour - GetBorderColour() -> Colour + GetBorderColour(self) -> Colour - GetFont() -> Font + GetFont(self) -> Font - GetBorder() -> int + GetBorder(self) -> int - __init__(CalendarCtrl cal, wxEventType type) -> CalendarEvent + __init__(self, CalendarCtrl cal, wxEventType type) -> CalendarEvent - GetDate() -> DateTime + GetDate(self) -> DateTime - SetDate(DateTime date) + SetDate(self, DateTime date) - SetWeekDay(int wd) + SetWeekDay(self, int wd) - GetWeekDay() -> int + GetWeekDay(self) -> int @@ -23885,63 +27069,80 @@ EVT_CALENDAR_YEAR = wx.PyEventBinder( wxEVT_CALENDAR_YEAR_CHANGED, 1) EVT_CALENDAR_WEEKDAY_CLICKED = wx.PyEventBinder( wxEVT_CALENDAR_WEEKDAY_CLICKED, 1) - 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. - - 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. + 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. + +Window 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 CAL_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 one of +EVT_CALENDAR_DAY, MONTH or YEAR events and an EVT_CALENDAR_SEL_CHANGED +event. - + - __init__(Window parent, int id, DateTime date=DefaultDateTime, + __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 Create and show a calendar control. - + @@ -23954,11 +27155,12 @@ EVT_CALENDAR_DAY, MONTH or YEAR events and an EVT_CALENDAR_SEL_CHANGED event. Precreate a CalendarCtrl for 2-phase creation. - Create(Window parent, int id, DateTime date=DefaultDateTime, + 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 - Acutally create the GUI portion of the CalendarCtrl for 2-phase creation. + Acutally create the GUI portion of the CalendarCtrl for 2-phase +creation. @@ -23970,40 +27172,40 @@ EVT_CALENDAR_DAY, MONTH or YEAR events and an EVT_CALENDAR_SEL_CHANGED event. - SetDate(DateTime date) + SetDate(self, DateTime date) Sets the current date. - GetDate() -> DateTime + GetDate(self) -> DateTime Gets the currently selected date. - SetLowerDateLimit(DateTime date=DefaultDateTime) -> bool + SetLowerDateLimit(self, DateTime date=DefaultDateTime) -> bool set the range in which selection can occur - SetUpperDateLimit(DateTime date=DefaultDateTime) -> bool + SetUpperDateLimit(self, DateTime date=DefaultDateTime) -> bool set the range in which selection can occur - GetLowerDateLimit() -> DateTime + GetLowerDateLimit(self) -> DateTime get the range in which selection can occur - GetUpperDateLimit() -> DateTime + GetUpperDateLimit(self) -> DateTime get the range in which selection can occur - SetDateRange(DateTime lowerdate=DefaultDateTime, DateTime upperdate=DefaultDateTime) -> bool + SetDateRange(self, DateTime lowerdate=DefaultDateTime, DateTime upperdate=DefaultDateTime) -> bool set the range in which selection can occur @@ -24011,7 +27213,7 @@ EVT_CALENDAR_DAY, MONTH or YEAR events and an EVT_CALENDAR_SEL_CHANGED event. - EnableYearChange(bool enable=True) + EnableYearChange(self, bool enable=True) 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. @@ -24020,149 +27222,176 @@ interactively. - EnableMonthChange(bool enable=True) - 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. + EnableMonthChange(self, bool enable=True) + 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. - EnableHolidayDisplay(bool display=True) - This function should be used instead of changing CAL_SHOW_HOLIDAYS style -bit directly. It enables or disables the special highlighting of the holidays. + EnableHolidayDisplay(self, bool display=True) + This function should be used instead of changing CAL_SHOW_HOLIDAYS +style bit directly. It enables or disables the special highlighting of +the holidays. - SetHeaderColours(Colour colFg, Colour colBg) - header colours are used for painting the weekdays at the top + SetHeaderColours(self, Colour colFg, Colour colBg) + Header colours are used for painting the weekdays at the top. - GetHeaderColourFg() -> Colour - header colours are used for painting the weekdays at the top + GetHeaderColourFg(self) -> Colour + Header colours are used for painting the weekdays at the top. - GetHeaderColourBg() -> Colour - header colours are used for painting the weekdays at the top + GetHeaderColourBg(self) -> Colour + Header colours are used for painting the weekdays at the top. - SetHighlightColours(Colour colFg, Colour colBg) - highlight colour is used for the currently selected date + SetHighlightColours(self, Colour colFg, Colour colBg) + Highlight colour is used for the currently selected date. - GetHighlightColourFg() -> Colour - highlight colour is used for the currently selected date + GetHighlightColourFg(self) -> Colour + Highlight colour is used for the currently selected date. - GetHighlightColourBg() -> Colour - highlight colour is used for the currently selected date + GetHighlightColourBg(self) -> Colour + Highlight colour is used for the currently selected date. - SetHolidayColours(Colour colFg, Colour colBg) - holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used) + SetHolidayColours(self, Colour colFg, Colour colBg) + Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is +used). - GetHolidayColourFg() -> Colour - holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used) + GetHolidayColourFg(self) -> Colour + Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is +used). - GetHolidayColourBg() -> Colour - holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is used) + GetHolidayColourBg(self) -> Colour + Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is +used). - GetAttr(size_t day) -> CalendarDateAttr - Returns the attribute for the given date (should be in the range 1...31). -The returned value may be None + GetAttr(self, size_t day) -> CalendarDateAttr + Returns the attribute for the given date (should be in the range +1...31). The returned value may be None - SetAttr(size_t day, CalendarDateAttr attr) - Associates the attribute with the specified date (in the range 1...31). -If the attribute passed is None, the items attribute is cleared. + SetAttr(self, size_t day, CalendarDateAttr attr) + Associates the attribute with the specified date (in the range +1...31). If the attribute passed is None, the items attribute is +cleared. - SetHoliday(size_t day) + SetHoliday(self, size_t day) Marks the specified day as being a holiday in the current month. - ResetAttr(size_t day) - Clears any attributes associated with the given day (in the range 1...31). + ResetAttr(self, size_t day) + Clears any attributes associated with the given day (in the range +1...31). HitTest(Point pos) -> (result, date, weekday) - 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. + 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. + =================== ============================================ - GetMonthControl() -> Control - get the currently shown control for month + GetMonthControl(self) -> Control + Get the currently shown control for month. - GetYearControl() -> Control - get the currently shown control for year + GetYearControl(self) -> Control + Get the currently shown control for year. + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + - - wx = core + + wx = _core + __docfilter__ = wx.__DocFilter(globals()) - _setOORInfo(PyObject _self) + _setOORInfo(self, PyObject _self) - SetParameters(String params) + SetParameters(self, String params) - IncRef() + IncRef(self) - DecRef() + DecRef(self) - Draw(Grid grid, GridCellAttr attr, DC dc, Rect rect, int row, + Draw(self, Grid grid, GridCellAttr attr, DC dc, Rect rect, int row, int col, bool isSelected) @@ -24175,7 +27404,7 @@ validity of the remaining two values. The result codes are: - GetBestSize(Grid grid, GridCellAttr attr, DC dc, int row, int col) -> Size + GetBestSize(self, Grid grid, GridCellAttr attr, DC dc, int row, int col) -> Size @@ -24185,23 +27414,23 @@ validity of the remaining two values. The result codes are: - Clone() -> GridCellRenderer + Clone(self) -> GridCellRenderer - __init__() -> PyGridCellRenderer + __init__(self) -> PyGridCellRenderer - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - base_SetParameters(String params) + base_SetParameters(self, String params) @@ -24210,38 +27439,38 @@ validity of the remaining two values. The result codes are: - __init__() -> GridCellStringRenderer + __init__(self) -> GridCellStringRenderer - __init__() -> GridCellNumberRenderer + __init__(self) -> GridCellNumberRenderer - __init__(int width=-1, int precision=-1) -> GridCellFloatRenderer + __init__(self, int width=-1, int precision=-1) -> GridCellFloatRenderer - GetWidth() -> int + GetWidth(self) -> int - SetWidth(int width) + SetWidth(self, int width) - GetPrecision() -> int + GetPrecision(self) -> int - SetPrecision(int precision) + SetPrecision(self, int precision) @@ -24250,13 +27479,13 @@ validity of the remaining two values. The result codes are: - __init__() -> GridCellBoolRenderer + __init__(self) -> GridCellBoolRenderer - __init__(String outformat=DateTimeFormatStr, String informat=DateTimeFormatStr) -> GridCellDateTimeRenderer + __init__(self, String outformat=DateTimeFormatStr, String informat=DateTimeFormatStr) -> GridCellDateTimeRenderer @@ -24266,7 +27495,7 @@ validity of the remaining two values. The result codes are: - __init__(String choices=EmptyString) -> GridCellEnumRenderer + __init__(self, String choices=EmptyString) -> GridCellEnumRenderer @@ -24275,51 +27504,51 @@ validity of the remaining two values. The result codes are: - __init__() -> GridCellAutoWrapStringRenderer + __init__(self) -> GridCellAutoWrapStringRenderer - _setOORInfo(PyObject _self) + _setOORInfo(self, PyObject _self) - IsCreated() -> bool + IsCreated(self) -> bool - GetControl() -> Control + GetControl(self) -> Control - SetControl(Control control) + SetControl(self, Control control) - GetCellAttr() -> GridCellAttr + GetCellAttr(self) -> GridCellAttr - SetCellAttr(GridCellAttr attr) + SetCellAttr(self, GridCellAttr attr) - SetParameters(String params) + SetParameters(self, String params) - IncRef() + IncRef(self) - DecRef() + DecRef(self) - Create(Window parent, int id, EvtHandler evtHandler) + Create(self, Window parent, int id, EvtHandler evtHandler) @@ -24327,7 +27556,7 @@ validity of the remaining two values. The result codes are: - BeginEdit(int row, int col, Grid grid) + BeginEdit(self, int row, int col, Grid grid) @@ -24335,7 +27564,7 @@ validity of the remaining two values. The result codes are: - EndEdit(int row, int col, Grid grid) -> bool + EndEdit(self, int row, int col, Grid grid) -> bool @@ -24343,114 +27572,114 @@ validity of the remaining two values. The result codes are: - Reset() + Reset(self) - Clone() -> GridCellEditor + Clone(self) -> GridCellEditor - SetSize(Rect rect) + SetSize(self, Rect rect) - Show(bool show, GridCellAttr attr=None) + Show(self, bool show, GridCellAttr attr=None) - PaintBackground(Rect rectCell, GridCellAttr attr) + PaintBackground(self, Rect rectCell, GridCellAttr attr) - IsAcceptedKey(KeyEvent event) -> bool + IsAcceptedKey(self, KeyEvent event) -> bool - StartingKey(KeyEvent event) + StartingKey(self, KeyEvent event) - StartingClick() + StartingClick(self) - HandleReturn(KeyEvent event) + HandleReturn(self, KeyEvent event) - Destroy() + Destroy(self) - __init__() -> PyGridCellEditor + __init__(self) -> PyGridCellEditor - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - base_SetSize(Rect rect) + base_SetSize(self, Rect rect) - base_Show(bool show, GridCellAttr attr=None) + base_Show(self, bool show, GridCellAttr attr=None) - base_PaintBackground(Rect rectCell, GridCellAttr attr) + base_PaintBackground(self, Rect rectCell, GridCellAttr attr) - base_IsAcceptedKey(KeyEvent event) -> bool + base_IsAcceptedKey(self, KeyEvent event) -> bool - base_StartingKey(KeyEvent event) + base_StartingKey(self, KeyEvent event) - base_StartingClick() + base_StartingClick(self) - base_HandleReturn(KeyEvent event) + base_HandleReturn(self, KeyEvent event) - base_Destroy() + base_Destroy(self) - base_SetParameters(String params) + base_SetParameters(self, String params) @@ -24459,47 +27688,51 @@ validity of the remaining two values. The result codes are: - __init__() -> GridCellTextEditor + __init__(self) -> GridCellTextEditor - GetValue() -> String + GetValue(self) -> String - __init__(int min=-1, int max=-1) -> GridCellNumberEditor + __init__(self, int min=-1, int max=-1) -> GridCellNumberEditor - GetValue() -> String + GetValue(self) -> String - __init__() -> GridCellFloatEditor + __init__(self, int width=-1, int precision=-1) -> GridCellFloatEditor + + + + - GetValue() -> String + GetValue(self) -> String - __init__() -> GridCellBoolEditor + __init__(self) -> GridCellBoolEditor - GetValue() -> String + GetValue(self) -> String - __init__(int choices=0, String choices_array=None, bool allowOthers=False) -> GridCellChoiceEditor + __init__(self, int choices=0, String choices_array=None, bool allowOthers=False) -> GridCellChoiceEditor @@ -24507,152 +27740,152 @@ validity of the remaining two values. The result codes are: - GetValue() -> String + GetValue(self) -> String - __init__(String choices=EmptyString) -> GridCellEnumEditor + __init__(self, String choices=EmptyString) -> GridCellEnumEditor - GetValue() -> String + GetValue(self) -> String - __init__() -> GridCellAutoWrapStringEditor + __init__(self) -> GridCellAutoWrapStringEditor - GetValue() -> String + GetValue(self) -> String - __init__(GridCellAttr attrDefault=None) -> GridCellAttr + __init__(self, GridCellAttr attrDefault=None) -> GridCellAttr - _setOORInfo(PyObject _self) + _setOORInfo(self, PyObject _self) - Clone() -> GridCellAttr + Clone(self) -> GridCellAttr - MergeWith(GridCellAttr mergefrom) + MergeWith(self, GridCellAttr mergefrom) - IncRef() + IncRef(self) - DecRef() + DecRef(self) - SetTextColour(Colour colText) + SetTextColour(self, Colour colText) - SetBackgroundColour(Colour colBack) + SetBackgroundColour(self, Colour colBack) - SetFont(Font font) + SetFont(self, Font font) - SetAlignment(int hAlign, int vAlign) + SetAlignment(self, int hAlign, int vAlign) - SetSize(int num_rows, int num_cols) + SetSize(self, int num_rows, int num_cols) - SetOverflow(bool allow=True) + SetOverflow(self, bool allow=True) - SetReadOnly(bool isReadOnly=True) + SetReadOnly(self, bool isReadOnly=True) - SetRenderer(GridCellRenderer renderer) + SetRenderer(self, GridCellRenderer renderer) - SetEditor(GridCellEditor editor) + SetEditor(self, GridCellEditor editor) - SetKind(int kind) + SetKind(self, int kind) - HasTextColour() -> bool + HasTextColour(self) -> bool - HasBackgroundColour() -> bool + HasBackgroundColour(self) -> bool - HasFont() -> bool + HasFont(self) -> bool - HasAlignment() -> bool + HasAlignment(self) -> bool - HasRenderer() -> bool + HasRenderer(self) -> bool - HasEditor() -> bool + HasEditor(self) -> bool - HasReadWriteMode() -> bool + HasReadWriteMode(self) -> bool - HasOverflowMode() -> bool + HasOverflowMode(self) -> bool - GetTextColour() -> Colour + GetTextColour(self) -> Colour - GetBackgroundColour() -> Colour + GetBackgroundColour(self) -> Colour - GetFont() -> Font + GetFont(self) -> Font GetAlignment() -> (hAlign, vAlign) @@ -24669,10 +27902,10 @@ validity of the remaining two values. The result codes are: - GetOverflow() -> bool + GetOverflow(self) -> bool - GetRenderer(Grid grid, int row, int col) -> GridCellRenderer + GetRenderer(self, Grid grid, int row, int col) -> GridCellRenderer @@ -24680,7 +27913,7 @@ validity of the remaining two values. The result codes are: - GetEditor(Grid grid, int row, int col) -> GridCellEditor + GetEditor(self, Grid grid, int row, int col) -> GridCellEditor @@ -24688,10 +27921,13 @@ validity of the remaining two values. The result codes are: - IsReadOnly() -> bool + IsReadOnly(self) -> bool + + + GetKind(self) -> int - SetDefAttr(GridCellAttr defAttr) + SetDefAttr(self, GridCellAttr defAttr) @@ -24699,16 +27935,16 @@ validity of the remaining two values. The result codes are: - __init__() -> GridCellAttrProvider + __init__(self) -> GridCellAttrProvider - _setOORInfo(PyObject _self) + _setOORInfo(self, PyObject _self) - GetAttr(int row, int col, int kind) -> GridCellAttr + GetAttr(self, int row, int col, int kind) -> GridCellAttr @@ -24716,7 +27952,7 @@ validity of the remaining two values. The result codes are: - SetAttr(GridCellAttr attr, int row, int col) + SetAttr(self, GridCellAttr attr, int row, int col) @@ -24724,28 +27960,28 @@ validity of the remaining two values. The result codes are: - SetRowAttr(GridCellAttr attr, int row) + SetRowAttr(self, GridCellAttr attr, int row) - SetColAttr(GridCellAttr attr, int col) + SetColAttr(self, GridCellAttr attr, int col) - UpdateAttrRows(size_t pos, int numRows) + UpdateAttrRows(self, size_t pos, int numRows) - UpdateAttrCols(size_t pos, int numCols) + UpdateAttrCols(self, size_t pos, int numCols) @@ -24755,17 +27991,17 @@ validity of the remaining two values. The result codes are: - __init__() -> PyGridCellAttrProvider + __init__(self) -> PyGridCellAttrProvider - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - base_GetAttr(int row, int col, int kind) -> GridCellAttr + base_GetAttr(self, int row, int col, int kind) -> GridCellAttr @@ -24773,7 +28009,7 @@ validity of the remaining two values. The result codes are: - base_SetAttr(GridCellAttr attr, int row, int col) + base_SetAttr(self, GridCellAttr attr, int row, int col) @@ -24781,14 +28017,14 @@ validity of the remaining two values. The result codes are: - base_SetRowAttr(GridCellAttr attr, int row) + base_SetRowAttr(self, GridCellAttr attr, int row) - base_SetColAttr(GridCellAttr attr, int col) + base_SetColAttr(self, GridCellAttr attr, int col) @@ -24798,51 +28034,51 @@ validity of the remaining two values. The result codes are: - _setOORInfo(PyObject _self) + _setOORInfo(self, PyObject _self) - SetAttrProvider(GridCellAttrProvider attrProvider) + SetAttrProvider(self, GridCellAttrProvider attrProvider) - GetAttrProvider() -> GridCellAttrProvider + GetAttrProvider(self) -> GridCellAttrProvider - SetView(Grid grid) + SetView(self, Grid grid) - GetView() -> Grid + GetView(self) -> Grid - GetNumberRows() -> int + GetNumberRows(self) -> int - GetNumberCols() -> int + GetNumberCols(self) -> int - IsEmptyCell(int row, int col) -> bool + IsEmptyCell(self, int row, int col) -> bool - GetValue(int row, int col) -> String + GetValue(self, int row, int col) -> String - SetValue(int row, int col, String value) + SetValue(self, int row, int col, String value) @@ -24850,14 +28086,14 @@ validity of the remaining two values. The result codes are: - GetTypeName(int row, int col) -> String + GetTypeName(self, int row, int col) -> String - CanGetValueAs(int row, int col, String typeName) -> bool + CanGetValueAs(self, int row, int col, String typeName) -> bool @@ -24865,7 +28101,7 @@ validity of the remaining two values. The result codes are: - CanSetValueAs(int row, int col, String typeName) -> bool + CanSetValueAs(self, int row, int col, String typeName) -> bool @@ -24873,28 +28109,28 @@ validity of the remaining two values. The result codes are: - GetValueAsLong(int row, int col) -> long + GetValueAsLong(self, int row, int col) -> long - GetValueAsDouble(int row, int col) -> double + GetValueAsDouble(self, int row, int col) -> double - GetValueAsBool(int row, int col) -> bool + GetValueAsBool(self, int row, int col) -> bool - SetValueAsLong(int row, int col, long value) + SetValueAsLong(self, int row, int col, long value) @@ -24902,7 +28138,7 @@ validity of the remaining two values. The result codes are: - SetValueAsDouble(int row, int col, double value) + SetValueAsDouble(self, int row, int col, double value) @@ -24910,7 +28146,7 @@ validity of the remaining two values. The result codes are: - SetValueAsBool(int row, int col, bool value) + SetValueAsBool(self, int row, int col, bool value) @@ -24918,79 +28154,79 @@ validity of the remaining two values. The result codes are: - Clear() + Clear(self) - InsertRows(size_t pos=0, size_t numRows=1) -> bool + InsertRows(self, size_t pos=0, size_t numRows=1) -> bool - AppendRows(size_t numRows=1) -> bool + AppendRows(self, size_t numRows=1) -> bool - DeleteRows(size_t pos=0, size_t numRows=1) -> bool + DeleteRows(self, size_t pos=0, size_t numRows=1) -> bool - InsertCols(size_t pos=0, size_t numCols=1) -> bool + InsertCols(self, size_t pos=0, size_t numCols=1) -> bool - AppendCols(size_t numCols=1) -> bool + AppendCols(self, size_t numCols=1) -> bool - DeleteCols(size_t pos=0, size_t numCols=1) -> bool + DeleteCols(self, size_t pos=0, size_t numCols=1) -> bool - GetRowLabelValue(int row) -> String + GetRowLabelValue(self, int row) -> String - GetColLabelValue(int col) -> String + GetColLabelValue(self, int col) -> String - SetRowLabelValue(int row, String value) + SetRowLabelValue(self, int row, String value) - SetColLabelValue(int col, String value) + SetColLabelValue(self, int col, String value) - CanHaveAttributes() -> bool + CanHaveAttributes(self) -> bool - GetAttr(int row, int col, int kind) -> GridCellAttr + GetAttr(self, int row, int col, int kind) -> GridCellAttr @@ -24998,7 +28234,7 @@ validity of the remaining two values. The result codes are: - SetAttr(GridCellAttr attr, int row, int col) + SetAttr(self, GridCellAttr attr, int row, int col) @@ -25006,14 +28242,14 @@ validity of the remaining two values. The result codes are: - SetRowAttr(GridCellAttr attr, int row) + SetRowAttr(self, GridCellAttr attr, int row) - SetColAttr(GridCellAttr attr, int col) + SetColAttr(self, GridCellAttr attr, int col) @@ -25023,28 +28259,28 @@ validity of the remaining two values. The result codes are: - __init__() -> PyGridTableBase + __init__(self) -> PyGridTableBase - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - Destroy() + Destroy(self) Deletes the C++ object this Python object is a proxy for. - base_GetTypeName(int row, int col) -> String + base_GetTypeName(self, int row, int col) -> String - base_CanGetValueAs(int row, int col, String typeName) -> bool + base_CanGetValueAs(self, int row, int col, String typeName) -> bool @@ -25052,7 +28288,7 @@ validity of the remaining two values. The result codes are: - base_CanSetValueAs(int row, int col, String typeName) -> bool + base_CanSetValueAs(self, int row, int col, String typeName) -> bool @@ -25060,79 +28296,79 @@ validity of the remaining two values. The result codes are: - base_Clear() + base_Clear(self) - base_InsertRows(size_t pos=0, size_t numRows=1) -> bool + base_InsertRows(self, size_t pos=0, size_t numRows=1) -> bool - base_AppendRows(size_t numRows=1) -> bool + base_AppendRows(self, size_t numRows=1) -> bool - base_DeleteRows(size_t pos=0, size_t numRows=1) -> bool + base_DeleteRows(self, size_t pos=0, size_t numRows=1) -> bool - base_InsertCols(size_t pos=0, size_t numCols=1) -> bool + base_InsertCols(self, size_t pos=0, size_t numCols=1) -> bool - base_AppendCols(size_t numCols=1) -> bool + base_AppendCols(self, size_t numCols=1) -> bool - base_DeleteCols(size_t pos=0, size_t numCols=1) -> bool + base_DeleteCols(self, size_t pos=0, size_t numCols=1) -> bool - base_GetRowLabelValue(int row) -> String + base_GetRowLabelValue(self, int row) -> String - base_GetColLabelValue(int col) -> String + base_GetColLabelValue(self, int col) -> String - base_SetRowLabelValue(int row, String value) + base_SetRowLabelValue(self, int row, String value) - base_SetColLabelValue(int col, String value) + base_SetColLabelValue(self, int col, String value) - base_CanHaveAttributes() -> bool + base_CanHaveAttributes(self) -> bool - base_GetAttr(int row, int col, int kind) -> GridCellAttr + base_GetAttr(self, int row, int col, int kind) -> GridCellAttr @@ -25140,7 +28376,7 @@ validity of the remaining two values. The result codes are: - base_SetAttr(GridCellAttr attr, int row, int col) + base_SetAttr(self, GridCellAttr attr, int row, int col) @@ -25148,14 +28384,14 @@ validity of the remaining two values. The result codes are: - base_SetRowAttr(GridCellAttr attr, int row) + base_SetRowAttr(self, GridCellAttr attr, int row) - base_SetColAttr(GridCellAttr attr, int col) + base_SetColAttr(self, GridCellAttr attr, int col) @@ -25165,7 +28401,7 @@ validity of the remaining two values. The result codes are: - __init__(int numRows=0, int numCols=0) -> GridStringTable + __init__(self, int numRows=0, int numCols=0) -> GridStringTable @@ -25174,7 +28410,7 @@ validity of the remaining two values. The result codes are: - __init__(GridTableBase table, int id, int comInt1=-1, int comInt2=-1) -> GridTableMessage + __init__(self, GridTableBase table, int id, int comInt1=-1, int comInt2=-1) -> GridTableMessage @@ -25183,114 +28419,130 @@ validity of the remaining two values. The result codes are: - __del__() + __del__(self) - SetTableObject(GridTableBase table) + SetTableObject(self, GridTableBase table) - GetTableObject() -> GridTableBase + GetTableObject(self) -> GridTableBase - SetId(int id) + SetId(self, int id) - GetId() -> int + GetId(self) -> int - SetCommandInt(int comInt1) + SetCommandInt(self, int comInt1) - GetCommandInt() -> int + GetCommandInt(self) -> int - SetCommandInt2(int comInt2) + SetCommandInt2(self, int comInt2) - GetCommandInt2() -> int + GetCommandInt2(self) -> int - __init__(int r=-1, int c=-1) -> GridCellCoords + __init__(self, int r=-1, int c=-1) -> GridCellCoords - __del__() + __del__(self) - GetRow() -> int + GetRow(self) -> int - SetRow(int n) + SetRow(self, int n) - GetCol() -> int + GetCol(self) -> int - SetCol(int n) + SetCol(self, int n) - Set(int row, int col) + Set(self, int row, int col) - __eq__(GridCellCoords other) -> bool + __eq__(self, GridCellCoords other) -> bool - __ne__(GridCellCoords other) -> bool + __ne__(self, GridCellCoords other) -> bool - - asTuple() -> PyObject + + Get(self) -> PyObject - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=WANTS_CHARS, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=WANTS_CHARS, String name=PanelNameStr) -> Grid - + + + PreGrid() -> Grid + + + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=WANTS_CHARS, + String name=PanelNameStr) -> bool + + + + + + + + + - CreateGrid(int numRows, int numCols, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool + CreateGrid(self, int numRows, int numCols, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool @@ -25298,31 +28550,31 @@ validity of the remaining two values. The result codes are: - SetSelectionMode(WXGRIDSELECTIONMODES selmode) + SetSelectionMode(self, WXGRIDSELECTIONMODES selmode) - GetSelectionMode() -> WXGRIDSELECTIONMODES + GetSelectionMode(self) -> WXGRIDSELECTIONMODES - GetNumberRows() -> int + GetNumberRows(self) -> int - GetNumberCols() -> int + GetNumberCols(self) -> int - ProcessTableMessage(GridTableMessage ??) -> bool + ProcessTableMessage(self, GridTableMessage ??) -> bool - GetTable() -> GridTableBase + GetTable(self) -> GridTableBase - SetTable(GridTableBase table, bool takeOwnership=False, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool + SetTable(self, GridTableBase table, bool takeOwnership=False, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool @@ -25330,10 +28582,10 @@ validity of the remaining two values. The result codes are: - ClearGrid() + ClearGrid(self) - InsertRows(int pos=0, int numRows=1, bool updateLabels=True) -> bool + InsertRows(self, int pos=0, int numRows=1, bool updateLabels=True) -> bool @@ -25341,14 +28593,14 @@ validity of the remaining two values. The result codes are: - AppendRows(int numRows=1, bool updateLabels=True) -> bool + AppendRows(self, int numRows=1, bool updateLabels=True) -> bool - DeleteRows(int pos=0, int numRows=1, bool updateLabels=True) -> bool + DeleteRows(self, int pos=0, int numRows=1, bool updateLabels=True) -> bool @@ -25356,7 +28608,7 @@ validity of the remaining two values. The result codes are: - InsertCols(int pos=0, int numCols=1, bool updateLabels=True) -> bool + InsertCols(self, int pos=0, int numCols=1, bool updateLabels=True) -> bool @@ -25364,14 +28616,14 @@ validity of the remaining two values. The result codes are: - AppendCols(int numCols=1, bool updateLabels=True) -> bool + AppendCols(self, int numCols=1, bool updateLabels=True) -> bool - DeleteCols(int pos=0, int numCols=1, bool updateLabels=True) -> bool + DeleteCols(self, int pos=0, int numCols=1, bool updateLabels=True) -> bool @@ -25379,14 +28631,14 @@ validity of the remaining two values. The result codes are: - DrawCellHighlight(DC dc, GridCellAttr attr) + DrawCellHighlight(self, DC dc, GridCellAttr attr) - DrawTextRectangle(DC dc, String ??, Rect ??, int horizontalAlignment=LEFT, + DrawTextRectangle(self, DC dc, String ??, Rect ??, int horizontalAlignment=LEFT, int verticalAlignment=TOP, int textOrientation=HORIZONTAL) @@ -25407,102 +28659,102 @@ validity of the remaining two values. The result codes are: - BeginBatch() + BeginBatch(self) - EndBatch() + EndBatch(self) - GetBatchCount() -> int + GetBatchCount(self) -> int - ForceRefresh() + ForceRefresh(self) - IsEditable() -> bool + IsEditable(self) -> bool - EnableEditing(bool edit) + EnableEditing(self, bool edit) - EnableCellEditControl(bool enable=True) + EnableCellEditControl(self, bool enable=True) - DisableCellEditControl() + DisableCellEditControl(self) - CanEnableCellControl() -> bool + CanEnableCellControl(self) -> bool - IsCellEditControlEnabled() -> bool + IsCellEditControlEnabled(self) -> bool - IsCellEditControlShown() -> bool + IsCellEditControlShown(self) -> bool - IsCurrentCellReadOnly() -> bool + IsCurrentCellReadOnly(self) -> bool - ShowCellEditControl() + ShowCellEditControl(self) - HideCellEditControl() + HideCellEditControl(self) - SaveEditControlValue() + SaveEditControlValue(self) - XYToCell(int x, int y) -> GridCellCoords + XYToCell(self, int x, int y) -> GridCellCoords - YToRow(int y) -> int + YToRow(self, int y) -> int - XToCol(int x) -> int + XToCol(self, int x) -> int - YToEdgeOfRow(int y) -> int + YToEdgeOfRow(self, int y) -> int - XToEdgeOfCol(int x) -> int + XToEdgeOfCol(self, int x) -> int - CellToRect(int row, int col) -> Rect + CellToRect(self, int row, int col) -> Rect - GetGridCursorRow() -> int + GetGridCursorRow(self) -> int - GetGridCursorCol() -> int + GetGridCursorCol(self) -> int - IsVisible(int row, int col, bool wholeCellVisible=True) -> bool + IsVisible(self, int row, int col, bool wholeCellVisible=True) -> bool @@ -25510,93 +28762,93 @@ validity of the remaining two values. The result codes are: - MakeCellVisible(int row, int col) + MakeCellVisible(self, int row, int col) - SetGridCursor(int row, int col) + SetGridCursor(self, int row, int col) - MoveCursorUp(bool expandSelection) -> bool + MoveCursorUp(self, bool expandSelection) -> bool - MoveCursorDown(bool expandSelection) -> bool + MoveCursorDown(self, bool expandSelection) -> bool - MoveCursorLeft(bool expandSelection) -> bool + MoveCursorLeft(self, bool expandSelection) -> bool - MoveCursorRight(bool expandSelection) -> bool + MoveCursorRight(self, bool expandSelection) -> bool - MovePageDown() -> bool + MovePageDown(self) -> bool - MovePageUp() -> bool + MovePageUp(self) -> bool - MoveCursorUpBlock(bool expandSelection) -> bool + MoveCursorUpBlock(self, bool expandSelection) -> bool - MoveCursorDownBlock(bool expandSelection) -> bool + MoveCursorDownBlock(self, bool expandSelection) -> bool - MoveCursorLeftBlock(bool expandSelection) -> bool + MoveCursorLeftBlock(self, bool expandSelection) -> bool - MoveCursorRightBlock(bool expandSelection) -> bool + MoveCursorRightBlock(self, bool expandSelection) -> bool - GetDefaultRowLabelSize() -> int + GetDefaultRowLabelSize(self) -> int - GetRowLabelSize() -> int + GetRowLabelSize(self) -> int - GetDefaultColLabelSize() -> int + GetDefaultColLabelSize(self) -> int - GetColLabelSize() -> int + GetColLabelSize(self) -> int - GetLabelBackgroundColour() -> Colour + GetLabelBackgroundColour(self) -> Colour - GetLabelTextColour() -> Colour + GetLabelTextColour(self) -> Colour - GetLabelFont() -> Font + GetLabelFont(self) -> Font GetRowLabelAlignment() -> (horiz, vert) @@ -25613,158 +28865,170 @@ validity of the remaining two values. The result codes are: - GetColLabelTextOrientation() -> int + GetColLabelTextOrientation(self) -> int - GetRowLabelValue(int row) -> String + GetRowLabelValue(self, int row) -> String - GetColLabelValue(int col) -> String + GetColLabelValue(self, int col) -> String - GetGridLineColour() -> Colour + GetGridLineColour(self) -> Colour - GetCellHighlightColour() -> Colour + GetCellHighlightColour(self) -> Colour - GetCellHighlightPenWidth() -> int + GetCellHighlightPenWidth(self) -> int - GetCellHighlightROPenWidth() -> int + GetCellHighlightROPenWidth(self) -> int - SetRowLabelSize(int width) + SetRowLabelSize(self, int width) - SetColLabelSize(int height) + SetColLabelSize(self, int height) - SetLabelBackgroundColour(Colour ??) + SetLabelBackgroundColour(self, Colour ??) - SetLabelTextColour(Colour ??) + SetLabelTextColour(self, Colour ??) - SetLabelFont(Font ??) + SetLabelFont(self, Font ??) - SetRowLabelAlignment(int horiz, int vert) + SetRowLabelAlignment(self, int horiz, int vert) - SetColLabelAlignment(int horiz, int vert) + SetColLabelAlignment(self, int horiz, int vert) - SetColLabelTextOrientation(int textOrientation) + SetColLabelTextOrientation(self, int textOrientation) - SetRowLabelValue(int row, String ??) + SetRowLabelValue(self, int row, String ??) - SetColLabelValue(int col, String ??) + SetColLabelValue(self, int col, String ??) - SetGridLineColour(Colour ??) + SetGridLineColour(self, Colour ??) - SetCellHighlightColour(Colour ??) + SetCellHighlightColour(self, Colour ??) - SetCellHighlightPenWidth(int width) + SetCellHighlightPenWidth(self, int width) - SetCellHighlightROPenWidth(int width) + SetCellHighlightROPenWidth(self, int width) - EnableDragRowSize(bool enable=True) + EnableDragRowSize(self, bool enable=True) - DisableDragRowSize() + DisableDragRowSize(self) - CanDragRowSize() -> bool + CanDragRowSize(self) -> bool - EnableDragColSize(bool enable=True) + EnableDragColSize(self, bool enable=True) - DisableDragColSize() + DisableDragColSize(self) - CanDragColSize() -> bool + CanDragColSize(self) -> bool - EnableDragGridSize(bool enable=True) + EnableDragGridSize(self, bool enable=True) - DisableDragGridSize() + DisableDragGridSize(self) - CanDragGridSize() -> bool + CanDragGridSize(self) -> bool + + + EnableDragCell(self, bool enable=True) + + + + + + DisableDragCell(self) + + + CanDragCell(self) -> bool - SetAttr(int row, int col, GridCellAttr attr) + SetAttr(self, int row, int col, GridCellAttr attr) @@ -25772,33 +29036,33 @@ validity of the remaining two values. The result codes are: - SetRowAttr(int row, GridCellAttr attr) + SetRowAttr(self, int row, GridCellAttr attr) - SetColAttr(int col, GridCellAttr attr) + SetColAttr(self, int col, GridCellAttr attr) - SetColFormatBool(int col) + SetColFormatBool(self, int col) - SetColFormatNumber(int col) + SetColFormatNumber(self, int col) - SetColFormatFloat(int col, int width=-1, int precision=-1) + SetColFormatFloat(self, int col, int width=-1, int precision=-1) @@ -25806,64 +29070,64 @@ validity of the remaining two values. The result codes are: - SetColFormatCustom(int col, String typeName) + SetColFormatCustom(self, int col, String typeName) - EnableGridLines(bool enable=True) + EnableGridLines(self, bool enable=True) - GridLinesEnabled() -> bool + GridLinesEnabled(self) -> bool - GetDefaultRowSize() -> int + GetDefaultRowSize(self) -> int - GetRowSize(int row) -> int + GetRowSize(self, int row) -> int - GetDefaultColSize() -> int + GetDefaultColSize(self) -> int - GetColSize(int col) -> int + GetColSize(self, int col) -> int - GetDefaultCellBackgroundColour() -> Colour + GetDefaultCellBackgroundColour(self) -> Colour - GetCellBackgroundColour(int row, int col) -> Colour + GetCellBackgroundColour(self, int row, int col) -> Colour - GetDefaultCellTextColour() -> Colour + GetDefaultCellTextColour(self) -> Colour - GetCellTextColour(int row, int col) -> Colour + GetCellTextColour(self, int row, int col) -> Colour - GetDefaultCellFont() -> Font + GetDefaultCellFont(self) -> Font - GetCellFont(int row, int col) -> Font + GetCellFont(self, int row, int col) -> Font @@ -25886,10 +29150,10 @@ validity of the remaining two values. The result codes are: - GetDefaultCellOverflow() -> bool + GetDefaultCellOverflow(self) -> bool - GetCellOverflow(int row, int col) -> bool + GetCellOverflow(self, int row, int col) -> bool @@ -25905,114 +29169,114 @@ validity of the remaining two values. The result codes are: - SetDefaultRowSize(int height, bool resizeExistingRows=False) + SetDefaultRowSize(self, int height, bool resizeExistingRows=False) - SetRowSize(int row, int height) + SetRowSize(self, int row, int height) - SetDefaultColSize(int width, bool resizeExistingCols=False) + SetDefaultColSize(self, int width, bool resizeExistingCols=False) - SetColSize(int col, int width) + SetColSize(self, int col, int width) - AutoSizeColumn(int col, bool setAsMin=True) + AutoSizeColumn(self, int col, bool setAsMin=True) - AutoSizeRow(int row, bool setAsMin=True) + AutoSizeRow(self, int row, bool setAsMin=True) - AutoSizeColumns(bool setAsMin=True) + AutoSizeColumns(self, bool setAsMin=True) - AutoSizeRows(bool setAsMin=True) + AutoSizeRows(self, bool setAsMin=True) - AutoSize() + AutoSize(self) - AutoSizeRowLabelSize(int row) + AutoSizeRowLabelSize(self, int row) - AutoSizeColLabelSize(int col) + AutoSizeColLabelSize(self, int col) - SetColMinimalWidth(int col, int width) + SetColMinimalWidth(self, int col, int width) - SetRowMinimalHeight(int row, int width) + SetRowMinimalHeight(self, int row, int width) - SetColMinimalAcceptableWidth(int width) + SetColMinimalAcceptableWidth(self, int width) - SetRowMinimalAcceptableHeight(int width) + SetRowMinimalAcceptableHeight(self, int width) - GetColMinimalAcceptableWidth() -> int + GetColMinimalAcceptableWidth(self) -> int - GetRowMinimalAcceptableHeight() -> int + GetRowMinimalAcceptableHeight(self) -> int - SetDefaultCellBackgroundColour(Colour ??) + SetDefaultCellBackgroundColour(self, Colour ??) - SetCellBackgroundColour(int row, int col, Colour ??) + SetCellBackgroundColour(self, int row, int col, Colour ??) @@ -26020,13 +29284,13 @@ validity of the remaining two values. The result codes are: - SetDefaultCellTextColour(Colour ??) + SetDefaultCellTextColour(self, Colour ??) - SetCellTextColour(int row, int col, Colour ??) + SetCellTextColour(self, int row, int col, Colour ??) @@ -26034,13 +29298,13 @@ validity of the remaining two values. The result codes are: - SetDefaultCellFont(Font ??) + SetDefaultCellFont(self, Font ??) - SetCellFont(int row, int col, Font ??) + SetCellFont(self, int row, int col, Font ??) @@ -26048,14 +29312,14 @@ validity of the remaining two values. The result codes are: - SetDefaultCellAlignment(int horiz, int vert) + SetDefaultCellAlignment(self, int horiz, int vert) - SetCellAlignment(int row, int col, int horiz, int vert) + SetCellAlignment(self, int row, int col, int horiz, int vert) @@ -26064,13 +29328,13 @@ validity of the remaining two values. The result codes are: - SetDefaultCellOverflow(bool allow) + SetDefaultCellOverflow(self, bool allow) - SetCellOverflow(int row, int col, bool allow) + SetCellOverflow(self, int row, int col, bool allow) @@ -26078,7 +29342,7 @@ validity of the remaining two values. The result codes are: - SetCellSize(int row, int col, int num_rows, int num_cols) + SetCellSize(self, int row, int col, int num_rows, int num_cols) @@ -26087,13 +29351,13 @@ validity of the remaining two values. The result codes are: - SetDefaultRenderer(GridCellRenderer renderer) + SetDefaultRenderer(self, GridCellRenderer renderer) - SetCellRenderer(int row, int col, GridCellRenderer renderer) + SetCellRenderer(self, int row, int col, GridCellRenderer renderer) @@ -26101,23 +29365,23 @@ validity of the remaining two values. The result codes are: - GetDefaultRenderer() -> GridCellRenderer + GetDefaultRenderer(self) -> GridCellRenderer - GetCellRenderer(int row, int col) -> GridCellRenderer + GetCellRenderer(self, int row, int col) -> GridCellRenderer - SetDefaultEditor(GridCellEditor editor) + SetDefaultEditor(self, GridCellEditor editor) - SetCellEditor(int row, int col, GridCellEditor editor) + SetCellEditor(self, int row, int col, GridCellEditor editor) @@ -26125,24 +29389,24 @@ validity of the remaining two values. The result codes are: - GetDefaultEditor() -> GridCellEditor + GetDefaultEditor(self) -> GridCellEditor - GetCellEditor(int row, int col) -> GridCellEditor + GetCellEditor(self, int row, int col) -> GridCellEditor - GetCellValue(int row, int col) -> String + GetCellValue(self, int row, int col) -> String - SetCellValue(int row, int col, String s) + SetCellValue(self, int row, int col, String s) @@ -26150,14 +29414,14 @@ validity of the remaining two values. The result codes are: - IsReadOnly(int row, int col) -> bool + IsReadOnly(self, int row, int col) -> bool - SetReadOnly(int row, int col, bool isReadOnly=True) + SetReadOnly(self, int row, int col, bool isReadOnly=True) @@ -26165,21 +29429,21 @@ validity of the remaining two values. The result codes are: - SelectRow(int row, bool addToSelected=False) + SelectRow(self, int row, bool addToSelected=False) - SelectCol(int col, bool addToSelected=False) + SelectCol(self, int col, bool addToSelected=False) - SelectBlock(int topRow, int leftCol, int bottomRow, int rightCol, + SelectBlock(self, int topRow, int leftCol, int bottomRow, int rightCol, bool addToSelected=False) @@ -26190,82 +29454,82 @@ validity of the remaining two values. The result codes are: - SelectAll() + SelectAll(self) - IsSelection() -> bool + IsSelection(self) -> bool - ClearSelection() + ClearSelection(self) - IsInSelection(int row, int col) -> bool + IsInSelection(self, int row, int col) -> bool - GetSelectedCells() -> wxGridCellCoordsArray + GetSelectedCells(self) -> wxGridCellCoordsArray - GetSelectionBlockTopLeft() -> wxGridCellCoordsArray + GetSelectionBlockTopLeft(self) -> wxGridCellCoordsArray - GetSelectionBlockBottomRight() -> wxGridCellCoordsArray + GetSelectionBlockBottomRight(self) -> wxGridCellCoordsArray - GetSelectedRows() -> wxArrayInt + GetSelectedRows(self) -> wxArrayInt - GetSelectedCols() -> wxArrayInt + GetSelectedCols(self) -> wxArrayInt - DeselectRow(int row) + DeselectRow(self, int row) - DeselectCol(int col) + DeselectCol(self, int col) - DeselectCell(int row, int col) + DeselectCell(self, int row, int col) - BlockToDeviceRect(GridCellCoords topLeft, GridCellCoords bottomRight) -> Rect + BlockToDeviceRect(self, GridCellCoords topLeft, GridCellCoords bottomRight) -> Rect - GetSelectionBackground() -> Colour + GetSelectionBackground(self) -> Colour - GetSelectionForeground() -> Colour + GetSelectionForeground(self) -> Colour - SetSelectionBackground(Colour c) + SetSelectionBackground(self, Colour c) - SetSelectionForeground(Colour c) + SetSelectionForeground(self, Colour c) - RegisterDataType(String typeName, GridCellRenderer renderer, GridCellEditor editor) + RegisterDataType(self, String typeName, GridCellRenderer renderer, GridCellEditor editor) @@ -26273,55 +29537,71 @@ validity of the remaining two values. The result codes are: - GetDefaultEditorForCell(int row, int col) -> GridCellEditor + GetDefaultEditorForCell(self, int row, int col) -> GridCellEditor - GetDefaultRendererForCell(int row, int col) -> GridCellRenderer + GetDefaultRendererForCell(self, int row, int col) -> GridCellRenderer - GetDefaultEditorForType(String typeName) -> GridCellEditor + GetDefaultEditorForType(self, String typeName) -> GridCellEditor - GetDefaultRendererForType(String typeName) -> GridCellRenderer + GetDefaultRendererForType(self, String typeName) -> GridCellRenderer - SetMargins(int extraWidth, int extraHeight) + SetMargins(self, int extraWidth, int extraHeight) - GetGridWindow() -> Window + GetGridWindow(self) -> Window - GetGridRowLabelWindow() -> Window + GetGridRowLabelWindow(self) -> Window - GetGridColLabelWindow() -> Window + GetGridColLabelWindow(self) -> Window - GetGridCornerLabelWindow() -> Window + GetGridCornerLabelWindow(self) -> Window + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + - __init__(int id, wxEventType type, Grid obj, int row=-1, int col=-1, + __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 @@ -26341,34 +29621,34 @@ validity of the remaining two values. The result codes are: - GetRow() -> int + GetRow(self) -> int - GetCol() -> int + GetCol(self) -> int - GetPosition() -> Point + GetPosition(self) -> Point - Selecting() -> bool + Selecting(self) -> bool - ControlDown() -> bool + ControlDown(self) -> bool - MetaDown() -> bool + MetaDown(self) -> bool - ShiftDown() -> bool + ShiftDown(self) -> bool - AltDown() -> bool + AltDown(self) -> bool - __init__(int id, wxEventType type, Grid obj, int rowOrCol=-1, + __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 @@ -26385,28 +29665,28 @@ validity of the remaining two values. The result codes are: - GetRowOrCol() -> int + GetRowOrCol(self) -> int - GetPosition() -> Point + GetPosition(self) -> Point - ControlDown() -> bool + ControlDown(self) -> bool - MetaDown() -> bool + MetaDown(self) -> bool - ShiftDown() -> bool + ShiftDown(self) -> bool - AltDown() -> bool + AltDown(self) -> bool - __init__(int id, wxEventType type, Grid obj, GridCellCoords topLeft, + __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 @@ -26424,43 +29704,43 @@ validity of the remaining two values. The result codes are: - GetTopLeftCoords() -> GridCellCoords + GetTopLeftCoords(self) -> GridCellCoords - GetBottomRightCoords() -> GridCellCoords + GetBottomRightCoords(self) -> GridCellCoords - GetTopRow() -> int + GetTopRow(self) -> int - GetBottomRow() -> int + GetBottomRow(self) -> int - GetLeftCol() -> int + GetLeftCol(self) -> int - GetRightCol() -> int + GetRightCol(self) -> int - Selecting() -> bool + Selecting(self) -> bool - ControlDown() -> bool + ControlDown(self) -> bool - MetaDown() -> bool + MetaDown(self) -> bool - ShiftDown() -> bool + ShiftDown(self) -> bool - AltDown() -> bool + AltDown(self) -> bool - __init__(int id, wxEventType type, Object obj, int row, int col, + __init__(self, int id, wxEventType type, Object obj, int row, int col, Control ctrl) -> GridEditorCreatedEvent @@ -26472,28 +29752,28 @@ validity of the remaining two values. The result codes are: - GetRow() -> int + GetRow(self) -> int - GetCol() -> int + GetCol(self) -> int - GetControl() -> Control + GetControl(self) -> Control - SetRow(int row) + SetRow(self, int row) - SetCol(int col) + SetCol(self, int col) - SetControl(Control ctrl) + SetControl(self, Control ctrl) @@ -26516,43 +29796,66 @@ EVT_GRID_SELECT_CELL = wx.PyEventBinder( wxEVT_GRID_SELECT_CELL ) EVT_GRID_EDITOR_SHOWN = wx.PyEventBinder( wxEVT_GRID_EDITOR_SHOWN ) EVT_GRID_EDITOR_HIDDEN = wx.PyEventBinder( wxEVT_GRID_EDITOR_HIDDEN ) EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) +EVT_GRID_CELL_BEGIN_DRAG = wx.PyEventBinder( wxEVT_GRID_CELL_BEGIN_DRAG ) + + +# The same as above but with the ability to specify an identifier +EVT_GRID_CMD_CELL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_CLICK, 1 ) +EVT_GRID_CMD_CELL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_CLICK, 1 ) +EVT_GRID_CMD_CELL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_DCLICK, 1 ) +EVT_GRID_CMD_CELL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_DCLICK, 1 ) +EVT_GRID_CMD_LABEL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_CLICK, 1 ) +EVT_GRID_CMD_LABEL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_CLICK, 1 ) +EVT_GRID_CMD_LABEL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_DCLICK, 1 ) +EVT_GRID_CMD_LABEL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_DCLICK, 1 ) +EVT_GRID_CMD_ROW_SIZE = wx.PyEventBinder( wxEVT_GRID_ROW_SIZE, 1 ) +EVT_GRID_CMD_COL_SIZE = wx.PyEventBinder( wxEVT_GRID_COL_SIZE, 1 ) +EVT_GRID_CMD_RANGE_SELECT = wx.PyEventBinder( wxEVT_GRID_RANGE_SELECT, 1 ) +EVT_GRID_CMD_CELL_CHANGE = wx.PyEventBinder( wxEVT_GRID_CELL_CHANGE, 1 ) +EVT_GRID_CMD_SELECT_CELL = wx.PyEventBinder( wxEVT_GRID_SELECT_CELL, 1 ) +EVT_GRID_CMD_EDITOR_SHOWN = wx.PyEventBinder( wxEVT_GRID_EDITOR_SHOWN, 1 ) +EVT_GRID_CMD_EDITOR_HIDDEN = wx.PyEventBinder( wxEVT_GRID_EDITOR_HIDDEN, 1 ) +EVT_GRID_CMD_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED, 1 ) +EVT_GRID_CMD_CELL_BEGIN_DRAG = wx.PyEventBinder( wxEVT_GRID_CELL_BEGIN_DRAG, 1 ) + - - wx = core + + wx = _core + __docfilter__ = wx.__DocFilter(globals()) #--------------------------------------------------------------------------- - __init__(String href, String target=EmptyString) -> HtmlLinkInfo + __init__(self, String href, String target=EmptyString) -> HtmlLinkInfo - GetHref() -> String + GetHref(self) -> String - GetTarget() -> String + GetTarget(self) -> String - GetEvent() -> MouseEvent + GetEvent(self) -> MouseEvent - GetHtmlCell() -> HtmlCell + GetHtmlCell(self) -> HtmlCell - SetEvent(MouseEvent e) + SetEvent(self, MouseEvent e) - SetHtmlCell(HtmlCell e) + SetHtmlCell(self, HtmlCell e) @@ -26561,250 +29864,256 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - GetName() -> String + GetName(self) -> String - HasParam(String par) -> bool + HasParam(self, String par) -> bool - GetParam(String par, int with_commas=False) -> String + GetParam(self, String par, int with_commas=False) -> String - GetAllParams() -> String + GetAllParams(self) -> String - HasEnding() -> bool + HasEnding(self) -> bool - GetBeginPos() -> int + GetBeginPos(self) -> int - GetEndPos1() -> int + GetEndPos1(self) -> int - GetEndPos2() -> int + GetEndPos2(self) -> int - SetFS(FileSystem fs) + SetFS(self, FileSystem fs) - GetFS() -> FileSystem + GetFS(self) -> FileSystem - Parse(String source) -> Object + Parse(self, String source) -> Object - InitParser(String source) + InitParser(self, String source) - DoneParser() + DoneParser(self) - DoParsing(int begin_pos, int end_pos) + DoParsing(self, int begin_pos, int end_pos) - StopParsing() + StopParsing(self) - AddTagHandler(HtmlTagHandler handler) + AddTagHandler(self, HtmlTagHandler handler) - GetSource() -> String + GetSource(self) -> String - PushTagHandler(HtmlTagHandler handler, String tags) + PushTagHandler(self, HtmlTagHandler handler, String tags) - PopTagHandler() + PopTagHandler(self) - __init__(HtmlWindow wnd=None) -> HtmlWinParser + __init__(self, HtmlWindow wnd=None) -> HtmlWinParser - SetDC(DC dc) + SetDC(self, DC dc) - GetDC() -> DC + GetDC(self) -> DC - GetCharHeight() -> int + GetCharHeight(self) -> int - GetCharWidth() -> int + GetCharWidth(self) -> int - GetWindow() -> HtmlWindow + GetWindow(self) -> HtmlWindow - SetFonts(String normal_face, String fixed_face, PyObject sizes=None) + SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None) + + NormalizeFontSizes(self, int size=-1) + + + + - GetContainer() -> HtmlContainerCell + GetContainer(self) -> HtmlContainerCell - OpenContainer() -> HtmlContainerCell + OpenContainer(self) -> HtmlContainerCell - SetContainer(HtmlContainerCell c) -> HtmlContainerCell + SetContainer(self, HtmlContainerCell c) -> HtmlContainerCell - CloseContainer() -> HtmlContainerCell + CloseContainer(self) -> HtmlContainerCell - GetFontSize() -> int + GetFontSize(self) -> int - SetFontSize(int s) + SetFontSize(self, int s) - GetFontBold() -> int + GetFontBold(self) -> int - SetFontBold(int x) + SetFontBold(self, int x) - GetFontItalic() -> int + GetFontItalic(self) -> int - SetFontItalic(int x) + SetFontItalic(self, int x) - GetFontUnderlined() -> int + GetFontUnderlined(self) -> int - SetFontUnderlined(int x) + SetFontUnderlined(self, int x) - GetFontFixed() -> int + GetFontFixed(self) -> int - SetFontFixed(int x) + SetFontFixed(self, int x) - GetAlign() -> int + GetAlign(self) -> int - SetAlign(int a) + SetAlign(self, int a) - GetLinkColor() -> Colour + GetLinkColor(self) -> Colour - SetLinkColor(Colour clr) + SetLinkColor(self, Colour clr) - GetActualColor() -> Colour + GetActualColor(self) -> Colour - SetActualColor(Colour clr) + SetActualColor(self, Colour clr) - SetLink(String link) + SetLink(self, String link) - CreateCurrentFont() -> Font + CreateCurrentFont(self) -> Font - GetLink() -> HtmlLinkInfo + GetLink(self) -> HtmlLinkInfo - __init__() -> HtmlTagHandler + __init__(self) -> HtmlTagHandler - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - SetParser(HtmlParser parser) + SetParser(self, HtmlParser parser) - GetParser() -> HtmlParser + GetParser(self) -> HtmlParser - ParseInner(HtmlTag tag) + ParseInner(self, HtmlTag tag) @@ -26813,26 +30122,26 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__() -> HtmlWinTagHandler + __init__(self) -> HtmlWinTagHandler - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - SetParser(HtmlParser parser) + SetParser(self, HtmlParser parser) - GetParser() -> HtmlWinParser + GetParser(self) -> HtmlWinParser - ParseInner(HtmlTag tag) + ParseInner(self, HtmlTag tag) @@ -26849,13 +30158,13 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__() -> HtmlSelection + __init__(self) -> HtmlSelection - __del__() + __del__(self) - Set(Point fromPos, HtmlCell fromCell, Point toPos, HtmlCell toCell) + Set(self, Point fromPos, HtmlCell fromCell, Point toPos, HtmlCell toCell) @@ -26864,93 +30173,93 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - SetCells(HtmlCell fromCell, HtmlCell toCell) + SetCells(self, HtmlCell fromCell, HtmlCell toCell) - GetFromCell() -> HtmlCell + GetFromCell(self) -> HtmlCell - GetToCell() -> HtmlCell + GetToCell(self) -> HtmlCell - GetFromPos() -> Point + GetFromPos(self) -> Point - GetToPos() -> Point + GetToPos(self) -> Point - GetFromPrivPos() -> Point + GetFromPrivPos(self) -> Point - GetToPrivPos() -> Point + GetToPrivPos(self) -> Point - SetFromPrivPos(Point pos) + SetFromPrivPos(self, Point pos) - SetToPrivPos(Point pos) + SetToPrivPos(self, Point pos) - ClearPrivPos() + ClearPrivPos(self) - IsEmpty() -> bool + IsEmpty(self) -> bool - __init__() -> HtmlRenderingState + __init__(self) -> HtmlRenderingState - __del__() + __del__(self) - SetSelectionState(int s) + SetSelectionState(self, int s) - GetSelectionState() -> int + GetSelectionState(self) -> int - SetFgColour(Colour c) + SetFgColour(self, Colour c) - GetFgColour() -> Colour + GetFgColour(self) -> Colour - SetBgColour(Colour c) + SetBgColour(self, Colour c) - GetBgColour() -> Colour + GetBgColour(self) -> Colour - GetSelectedTextColour(Colour clr) -> Colour + GetSelectedTextColour(self, Colour clr) -> Colour - GetSelectedTextBgColour(Colour clr) -> Colour + GetSelectedTextBgColour(self, Colour clr) -> Colour @@ -26959,13 +30268,13 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - GetSelectedTextColour(Colour clr) -> Colour + GetSelectedTextColour(self, Colour clr) -> Colour - GetSelectedTextBgColour(Colour clr) -> Colour + GetSelectedTextBgColour(self, Colour clr) -> Colour @@ -26973,31 +30282,31 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__() -> HtmlRenderingInfo + __init__(self) -> HtmlRenderingInfo - __del__() + __del__(self) - SetSelection(HtmlSelection s) + SetSelection(self, HtmlSelection s) - GetSelection() -> HtmlSelection + GetSelection(self) -> HtmlSelection - SetStyle(HtmlRenderingStyle style) + SetStyle(self, HtmlRenderingStyle style) - GetStyle() -> HtmlRenderingStyle + GetStyle(self) -> HtmlRenderingStyle - GetState() -> HtmlRenderingState + GetState(self) -> HtmlRenderingState @@ -27006,90 +30315,90 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__() -> HtmlCell + __init__(self) -> HtmlCell - GetPosX() -> int + GetPosX(self) -> int - GetPosY() -> int + GetPosY(self) -> int - GetWidth() -> int + GetWidth(self) -> int - GetHeight() -> int + GetHeight(self) -> int - GetDescent() -> int + GetDescent(self) -> int - GetMaxTotalWidth() -> int + GetMaxTotalWidth(self) -> int - GetId() -> String + GetId(self) -> String - SetId(String id) + SetId(self, String id) - GetLink(int x=0, int y=0) -> HtmlLinkInfo + GetLink(self, int x=0, int y=0) -> HtmlLinkInfo - GetNext() -> HtmlCell + GetNext(self) -> HtmlCell - GetParent() -> HtmlContainerCell + GetParent(self) -> HtmlContainerCell - GetFirstChild() -> HtmlCell + GetFirstChild(self) -> HtmlCell - GetCursor() -> Cursor + GetCursor(self) -> Cursor - IsFormattingCell() -> bool + IsFormattingCell(self) -> bool - SetLink(HtmlLinkInfo link) + SetLink(self, HtmlLinkInfo link) - SetNext(HtmlCell cell) + SetNext(self, HtmlCell cell) - SetParent(HtmlContainerCell p) + SetParent(self, HtmlContainerCell p) - SetPos(int x, int y) + SetPos(self, int x, int y) - Layout(int w) + Layout(self, int w) - Draw(DC dc, int x, int y, int view_y1, int view_y2, HtmlRenderingInfo info) + Draw(self, DC dc, int x, int y, int view_y1, int view_y2, HtmlRenderingInfo info) @@ -27100,7 +30409,7 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - DrawInvisible(DC dc, int x, int y, HtmlRenderingInfo info) + DrawInvisible(self, DC dc, int x, int y, HtmlRenderingInfo info) @@ -27109,32 +30418,32 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - Find(int condition, void param) -> HtmlCell + Find(self, int condition, void param) -> HtmlCell - AdjustPagebreak(int INOUT) -> bool + AdjustPagebreak(self, int INOUT) -> bool - SetCanLiveOnPagebreak(bool can) + SetCanLiveOnPagebreak(self, bool can) - IsLinebreakAllowed() -> bool + IsLinebreakAllowed(self) -> bool - IsTerminalCell() -> bool + IsTerminalCell(self) -> bool - FindCellByPos(int x, int y, unsigned int flags=HTML_FIND_EXACT) -> HtmlCell + FindCellByPos(self, int x, int y, unsigned int flags=HTML_FIND_EXACT) -> HtmlCell @@ -27142,25 +30451,25 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - GetAbsPos() -> Point + GetAbsPos(self) -> Point - GetFirstTerminal() -> HtmlCell + GetFirstTerminal(self) -> HtmlCell - GetLastTerminal() -> HtmlCell + GetLastTerminal(self) -> HtmlCell - GetDepth() -> unsigned int + GetDepth(self) -> unsigned int - IsBefore(HtmlCell cell) -> bool + IsBefore(self, HtmlCell cell) -> bool - ConvertToText(HtmlSelection sel) -> String + ConvertToText(self, HtmlSelection sel) -> String @@ -27169,7 +30478,7 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__(String word, DC dc) -> HtmlWordCell + __init__(self, String word, DC dc) -> HtmlWordCell @@ -27179,37 +30488,37 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__(HtmlContainerCell parent) -> HtmlContainerCell + __init__(self, HtmlContainerCell parent) -> HtmlContainerCell - InsertCell(HtmlCell cell) + InsertCell(self, HtmlCell cell) - SetAlignHor(int al) + SetAlignHor(self, int al) - GetAlignHor() -> int + GetAlignHor(self) -> int - SetAlignVer(int al) + SetAlignVer(self, int al) - GetAlignVer() -> int + GetAlignVer(self) -> int - SetIndent(int i, int what, int units=HTML_UNITS_PIXELS) + SetIndent(self, int i, int what, int units=HTML_UNITS_PIXELS) @@ -27217,67 +30526,67 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - GetIndent(int ind) -> int + GetIndent(self, int ind) -> int - GetIndentUnits(int ind) -> int + GetIndentUnits(self, int ind) -> int - SetAlign(HtmlTag tag) + SetAlign(self, HtmlTag tag) - SetWidthFloat(int w, int units) + SetWidthFloat(self, int w, int units) - SetWidthFloatFromTag(HtmlTag tag) + SetWidthFloatFromTag(self, HtmlTag tag) - SetMinHeight(int h, int align=HTML_ALIGN_TOP) + SetMinHeight(self, int h, int align=HTML_ALIGN_TOP) - SetBackgroundColour(Colour clr) + SetBackgroundColour(self, Colour clr) - GetBackgroundColour() -> Colour + GetBackgroundColour(self) -> Colour - SetBorder(Colour clr1, Colour clr2) + SetBorder(self, Colour clr1, Colour clr2) - GetFirstChild() -> HtmlCell + GetFirstChild(self) -> HtmlCell - __init__(Colour clr, int flags=HTML_CLR_FOREGROUND) -> HtmlColourCell + __init__(self, Colour clr, int flags=HTML_CLR_FOREGROUND) -> HtmlColourCell @@ -27287,7 +30596,7 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__(Font font) -> HtmlFontCell + __init__(self, Font font) -> HtmlFontCell @@ -27296,7 +30605,7 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__(Window wnd, int w=0) -> HtmlWidgetCell + __init__(self, Window wnd, int w=0) -> HtmlWidgetCell @@ -27309,10 +30618,10 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__() -> HtmlFilter + __init__(self) -> HtmlFilter - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) @@ -27325,7 +30634,7 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, int style=HW_DEFAULT_STYLE, String name=HtmlWindowNameStr) -> HtmlWindow @@ -27341,7 +30650,7 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) PreHtmlWindow() -> HtmlWindow - Create(Window parent, int id=-1, Point pos=DefaultPosition, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, int style=HW_SCROLLBAR_AUTO, String name=HtmlWindowNameStr) -> bool @@ -27354,124 +30663,130 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - SetPage(String source) -> bool + SetPage(self, String source) -> bool - LoadPage(String location) -> bool + LoadPage(self, String location) -> bool - LoadFile(String filename) -> bool + LoadFile(self, String filename) -> bool - AppendToPage(String source) -> bool + AppendToPage(self, String source) -> bool - GetOpenedPage() -> String + GetOpenedPage(self) -> String - GetOpenedAnchor() -> String + GetOpenedAnchor(self) -> String - GetOpenedPageTitle() -> String + GetOpenedPageTitle(self) -> String - SetRelatedFrame(Frame frame, String format) + SetRelatedFrame(self, Frame frame, String format) - GetRelatedFrame() -> Frame + GetRelatedFrame(self) -> Frame - SetRelatedStatusBar(int bar) + SetRelatedStatusBar(self, int bar) - SetFonts(String normal_face, String fixed_face, PyObject sizes=None) + SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None) + + NormalizeFontSizes(self, int size=-1) + + + + - SetTitle(String title) + SetTitle(self, String title) - SetBorders(int b) + SetBorders(self, int b) - ReadCustomization(ConfigBase cfg, String path=EmptyString) + ReadCustomization(self, ConfigBase cfg, String path=EmptyString) - WriteCustomization(ConfigBase cfg, String path=EmptyString) + WriteCustomization(self, ConfigBase cfg, String path=EmptyString) - HistoryBack() -> bool + HistoryBack(self) -> bool - HistoryForward() -> bool + HistoryForward(self) -> bool - HistoryCanBack() -> bool + HistoryCanBack(self) -> bool - HistoryCanForward() -> bool + HistoryCanForward(self) -> bool - HistoryClear() + HistoryClear(self) - GetInternalRepresentation() -> HtmlContainerCell + GetInternalRepresentation(self) -> HtmlContainerCell - GetParser() -> HtmlWinParser + GetParser(self) -> HtmlWinParser - ScrollToAnchor(String anchor) -> bool + ScrollToAnchor(self, String anchor) -> bool - HasAnchor(String anchor) -> bool + HasAnchor(self, String anchor) -> bool @@ -27483,34 +30798,40 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - SelectWord(Point pos) + SelectWord(self, Point pos) - SelectLine(Point pos) + SelectLine(self, Point pos) - SelectAll() + SelectAll(self) + + + SelectionToText(self) -> String + + + ToText(self) -> String - base_OnLinkClicked(HtmlLinkInfo link) + base_OnLinkClicked(self, HtmlLinkInfo link) - base_OnSetTitle(String title) + base_OnSetTitle(self, String title) - base_OnCellMouseHover(HtmlCell cell, int x, int y) + base_OnCellMouseHover(self, HtmlCell cell, int x, int y) @@ -27518,7 +30839,7 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - base_OnCellClicked(HtmlCell cell, int x, int y, MouseEvent event) + base_OnCellClicked(self, HtmlCell cell, int x, int y, MouseEvent event) @@ -27526,6 +30847,22 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) + + GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes + 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. + + + + #--------------------------------------------------------------------------- @@ -27533,27 +30870,27 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__() -> HtmlDCRenderer + __init__(self) -> HtmlDCRenderer - __del__() + __del__(self) - SetDC(DC dc, int maxwidth) + SetDC(self, DC dc, int maxwidth) - SetSize(int width, int height) + SetSize(self, int width, int height) - SetHtmlText(String html, String basepath=EmptyString, bool isdir=True) + SetHtmlText(self, String html, String basepath=EmptyString, bool isdir=True) @@ -27561,15 +30898,21 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - SetFonts(String normal_face, String fixed_face, PyObject sizes=None) + SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None) + + NormalizeFontSizes(self, int size=-1) + + + + - Render(int x, int y, int from=0, int dont_render=False, int to=INT_MAX, + Render(self, int x, int y, int from=0, int dont_render=False, int to=INT_MAX, int choices=None, int LCOUNT=0) -> int @@ -27582,19 +30925,19 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - GetTotalHeight() -> int + GetTotalHeight(self) -> int - __init__(String title=HtmlPrintoutTitleStr) -> HtmlPrintout + __init__(self, String title=HtmlPrintoutTitleStr) -> HtmlPrintout - SetHtmlText(String html, String basepath=EmptyString, bool isdir=True) + SetHtmlText(self, String html, String basepath=EmptyString, bool isdir=True) @@ -27602,35 +30945,41 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - SetHtmlFile(String htmlfile) + SetHtmlFile(self, String htmlfile) - SetHeader(String header, int pg=PAGE_ALL) + SetHeader(self, String header, int pg=PAGE_ALL) - SetFooter(String footer, int pg=PAGE_ALL) + SetFooter(self, String footer, int pg=PAGE_ALL) - SetFonts(String normal_face, String fixed_face, PyObject sizes=None) + SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None) + + NormalizeFontSizes(self, int size=-1) + + + + - SetMargins(float top=25.2, float bottom=25.2, float left=25.2, + SetMargins(self, float top=25.2, float bottom=25.2, float left=25.2, float right=25.2, float spaces=5) @@ -27653,74 +31002,80 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__(String name=HtmlPrintingTitleStr, Window parentWindow=None) -> HtmlEasyPrinting + __init__(self, String name=HtmlPrintingTitleStr, Window parentWindow=None) -> HtmlEasyPrinting - __del__() + __del__(self) - PreviewFile(String htmlfile) + PreviewFile(self, String htmlfile) - PreviewText(String htmltext, String basepath=EmptyString) + PreviewText(self, String htmltext, String basepath=EmptyString) - PrintFile(String htmlfile) + PrintFile(self, String htmlfile) - PrintText(String htmltext, String basepath=EmptyString) + PrintText(self, String htmltext, String basepath=EmptyString) - PrinterSetup() + PrinterSetup(self) - PageSetup() + PageSetup(self) - SetHeader(String header, int pg=PAGE_ALL) + SetHeader(self, String header, int pg=PAGE_ALL) - SetFooter(String footer, int pg=PAGE_ALL) + SetFooter(self, String footer, int pg=PAGE_ALL) - SetFonts(String normal_face, String fixed_face, PyObject sizes=None) + SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None) + + NormalizeFontSizes(self, int size=-1) + + + + - GetPrintData() -> PrintData + GetPrintData(self) -> PrintData - GetPageSetupData() -> PageSetupDialogData + GetPageSetupData(self) -> PageSetupDialogData @@ -27728,7 +31083,7 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__(String bookfile, String basepath, String title, String start) -> HtmlBookRecord + __init__(self, String bookfile, String basepath, String title, String start) -> HtmlBookRecord @@ -27737,50 +31092,50 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - GetBookFile() -> String + GetBookFile(self) -> String - GetTitle() -> String + GetTitle(self) -> String - GetStart() -> String + GetStart(self) -> String - GetBasePath() -> String + GetBasePath(self) -> String - SetContentsRange(int start, int end) + SetContentsRange(self, int start, int end) - GetContentsStart() -> int + GetContentsStart(self) -> int - GetContentsEnd() -> int + GetContentsEnd(self) -> int - SetTitle(String title) + SetTitle(self, String title) - SetBasePath(String path) + SetBasePath(self, String path) - SetStart(String start) + SetStart(self, String start) - GetFullPath(String page) -> String + GetFullPath(self, String page) -> String @@ -27788,92 +31143,92 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - GetLevel() -> int + GetLevel(self) -> int - GetID() -> int + GetID(self) -> int - GetName() -> String + GetName(self) -> String - GetPage() -> String + GetPage(self) -> String - GetBook() -> HtmlBookRecord + GetBook(self) -> HtmlBookRecord - Search() -> bool + Search(self) -> bool - IsActive() -> bool + IsActive(self) -> bool - GetCurIndex() -> int + GetCurIndex(self) -> int - GetMaxIndex() -> int + GetMaxIndex(self) -> int - GetName() -> String + GetName(self) -> String - GetContentsItem() -> HtmlContentsItem + GetContentsItem(self) -> HtmlContentsItem - __init__() -> HtmlHelpData + __init__(self) -> HtmlHelpData - __del__() + __del__(self) - SetTempDir(String path) + SetTempDir(self, String path) - AddBook(String book) -> bool + AddBook(self, String book) -> bool - FindPageByName(String page) -> String + FindPageByName(self, String page) -> String - FindPageById(int id) -> String + FindPageById(self, int id) -> String - GetBookRecArray() -> wxHtmlBookRecArray + GetBookRecArray(self) -> wxHtmlBookRecArray - GetContents() -> HtmlContentsItem + GetContents(self) -> HtmlContentsItem - GetContentsCnt() -> int + GetContentsCnt(self) -> int - GetIndex() -> HtmlContentsItem + GetIndex(self) -> HtmlContentsItem - GetIndexCnt() -> int + GetIndexCnt(self) -> int - __init__(Window parent, int ??, String title=EmptyString, int style=HF_DEFAULTSTYLE, + __init__(self, Window parent, int ??, String title=EmptyString, int style=HF_DEFAULTSTYLE, HtmlHelpData data=None) -> HtmlHelpFrame @@ -27884,54 +31239,54 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - GetData() -> HtmlHelpData + GetData(self) -> HtmlHelpData - SetTitleFormat(String format) + SetTitleFormat(self, String format) - Display(String x) + Display(self, String x) - DisplayID(int id) + DisplayID(self, int id) - DisplayContents() + DisplayContents(self) - DisplayIndex() + DisplayIndex(self) - KeywordSearch(String keyword) -> bool + KeywordSearch(self, String keyword) -> bool - UseConfig(ConfigBase config, String rootpath=EmptyString) + UseConfig(self, ConfigBase config, String rootpath=EmptyString) - ReadCustomization(ConfigBase cfg, String path=EmptyString) + ReadCustomization(self, ConfigBase cfg, String path=EmptyString) - WriteCustomization(ConfigBase cfg, String path=EmptyString) + WriteCustomization(self, ConfigBase cfg, String path=EmptyString) @@ -27941,86 +31296,87 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED ) - __init__(int style=HF_DEFAULTSTYLE) -> HtmlHelpController + __init__(self, int style=HF_DEFAULTSTYLE) -> HtmlHelpController - __del__() + __del__(self) - SetTitleFormat(String format) + SetTitleFormat(self, String format) - SetTempDir(String path) + SetTempDir(self, String path) - AddBook(String book, int show_wait_msg=False) -> bool + AddBook(self, String book, int show_wait_msg=False) -> bool - Display(String x) + Display(self, String x) - DisplayID(int id) + DisplayID(self, int id) - DisplayContents() + DisplayContents(self) - DisplayIndex() + DisplayIndex(self) - KeywordSearch(String keyword) -> bool + KeywordSearch(self, String keyword) -> bool - UseConfig(ConfigBase config, String rootpath=EmptyString) + UseConfig(self, ConfigBase config, String rootpath=EmptyString) - ReadCustomization(ConfigBase cfg, String path=EmptyString) + ReadCustomization(self, ConfigBase cfg, String path=EmptyString) - WriteCustomization(ConfigBase cfg, String path=EmptyString) + WriteCustomization(self, ConfigBase cfg, String path=EmptyString) - GetFrame() -> HtmlHelpFrame + GetFrame(self) -> HtmlHelpFrame - - wx = core + + wx = _core + __docfilter__ = wx.__DocFilter(globals()) EVT_WIZARD_PAGE_CHANGED = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGED, 1) EVT_WIZARD_PAGE_CHANGING = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGING, 1) @@ -28031,7 +31387,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(wxEventType type=wxEVT_NULL, int id=-1, bool direction=True, + __init__(self, wxEventType type=wxEVT_NULL, int id=-1, bool direction=True, WizardPage page=None) -> WizardEvent @@ -28041,16 +31397,16 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetDirection() -> bool + GetDirection(self) -> bool - GetPage() -> WizardPage + GetPage(self) -> WizardPage - Create(Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool + Create(self, Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool @@ -28058,19 +31414,19 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetPrev() -> WizardPage + GetPrev(self) -> WizardPage - GetNext() -> WizardPage + GetNext(self) -> WizardPage - GetBitmap() -> Bitmap + GetBitmap(self) -> Bitmap - __init__(Wizard parent, Bitmap bitmap=&wxNullBitmap, String resource=&wxPyEmptyString) -> PyWizardPage + __init__(self, Wizard parent, Bitmap bitmap=&wxNullBitmap, String resource=&wxPyEmptyString) -> PyWizardPage @@ -28081,7 +31437,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) PrePyWizardPage() -> PyWizardPage - Create(Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool + Create(self, Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool @@ -28089,14 +31445,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - base_DoMoveWindow(int x, int y, int width, int height) + base_DoMoveWindow(self, int x, int y, int width, int height) @@ -28105,7 +31461,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) + base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) @@ -28115,14 +31471,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_DoSetClientSize(int width, int height) + base_DoSetClientSize(self, int width, int height) - base_DoSetVirtualSize(int x, int y) + base_DoSetVirtualSize(self, int x, int y) @@ -28150,40 +31506,40 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_DoGetVirtualSize() -> Size + base_DoGetVirtualSize(self) -> Size - base_DoGetBestSize() -> Size + base_DoGetBestSize(self) -> Size - base_InitDialog() + base_InitDialog(self) - base_TransferDataToWindow() -> bool + base_TransferDataToWindow(self) -> bool - base_TransferDataFromWindow() -> bool + base_TransferDataFromWindow(self) -> bool - base_Validate() -> bool + base_Validate(self) -> bool - base_AcceptsFocus() -> bool + base_AcceptsFocus(self) -> bool - base_AcceptsFocusFromKeyboard() -> bool + base_AcceptsFocusFromKeyboard(self) -> bool - base_GetMaxSize() -> Size + base_GetMaxSize(self) -> Size - base_AddChild(Window child) + base_AddChild(self, Window child) - base_RemoveChild(Window child) + base_RemoveChild(self, Window child) @@ -28192,7 +31548,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(Wizard parent, WizardPage prev=None, WizardPage next=None, + __init__(self, Wizard parent, WizardPage prev=None, WizardPage next=None, Bitmap bitmap=wxNullBitmap, wxChar resource=None) -> WizardPageSimple @@ -28206,7 +31562,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) PreWizardPageSimple() -> WizardPageSimple - Create(Wizard parent=None, WizardPage prev=None, WizardPage next=None, + Create(self, Wizard parent=None, WizardPage prev=None, WizardPage next=None, Bitmap bitmap=wxNullBitmap, wxChar resource=None) -> bool @@ -28217,13 +31573,13 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - SetPrev(WizardPage prev) + SetPrev(self, WizardPage prev) - SetNext(WizardPage next) + SetNext(self, WizardPage next) @@ -28239,7 +31595,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(Window parent, int id=-1, String title=EmptyString, + __init__(self, Window parent, int id=-1, String title=EmptyString, Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition, long style=DEFAULT_DIALOG_STYLE) -> Wizard @@ -28255,7 +31611,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) PreWizard() -> Wizard - Create(Window parent, int id=-1, String title=EmptyString, + Create(self, Window parent, int id=-1, String title=EmptyString, Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition) -> bool @@ -28266,59 +31622,59 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - Init() + Init(self) - RunWizard(WizardPage firstPage) -> bool + RunWizard(self, WizardPage firstPage) -> bool - GetCurrentPage() -> WizardPage + GetCurrentPage(self) -> WizardPage - SetPageSize(Size size) + SetPageSize(self, Size size) - GetPageSize() -> Size + GetPageSize(self) -> Size - FitToPage(WizardPage firstPage) + FitToPage(self, WizardPage firstPage) - GetPageAreaSizer() -> Sizer + GetPageAreaSizer(self) -> Sizer - SetBorder(int border) + SetBorder(self, int border) - IsRunning() -> bool + IsRunning(self) -> bool - ShowPage(WizardPage page, bool goingForward=True) -> bool + ShowPage(self, WizardPage page, bool goingForward=True) -> bool - HasNextPage(WizardPage page) -> bool + HasNextPage(self, WizardPage page) -> bool - HasPrevPage(WizardPage page) -> bool + HasPrevPage(self, WizardPage page) -> bool @@ -28326,12 +31682,13 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - - wx = core + + wx = _core + __docfilter__ = wx.__DocFilter(globals()) - __init__(bool isRGB, GLCanvas win, wxPalette palette=wxNullPalette, + __init__(self, bool isRGB, GLCanvas win, wxPalette palette=wxNullPalette, GLContext other=None) -> GLContext @@ -28341,43 +31698,43 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __del__() + __del__(self) - SetCurrent() + SetCurrent(self) - SetColour(String colour) + SetColour(self, String colour) - SwapBuffers() + SwapBuffers(self) - SetupPixelFormat() + SetupPixelFormat(self) - SetupPalette(wxPalette palette) + SetupPalette(self, wxPalette palette) - CreateDefaultPalette() -> wxPalette + CreateDefaultPalette(self) -> wxPalette - GetPalette() -> wxPalette + GetPalette(self) -> wxPalette - GetWindow() -> Window + GetWindow(self) -> Window - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __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 @@ -28409,175 +31766,181 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - SetCurrent() + SetCurrent(self) - SetColour(String colour) + SetColour(self, String colour) - SwapBuffers() + SwapBuffers(self) - GetContext() -> GLContext + GetContext(self) -> GLContext - - wx = core + + wx = _core + __docfilter__ = wx.__DocFilter(globals()) + + import warnings + warnings.warn("This module is deprecated. Please use the wx.lib.ogl package instead.", + DeprecationWarning, stacklevel=2) + #--------------------------------------------------------------------------- - __init__() -> ShapeRegion + __init__(self) -> ShapeRegion - SetText(String s) + SetText(self, String s) - SetFont(Font f) + SetFont(self, Font f) - SetMinSize(double w, double h) + SetMinSize(self, double w, double h) - SetSize(double w, double h) + SetSize(self, double w, double h) - SetPosition(double x, double y) + SetPosition(self, double x, double y) - SetProportions(double x, double y) + SetProportions(self, double x, double y) - SetFormatMode(int mode) + SetFormatMode(self, int mode) - SetName(String s) + SetName(self, String s) - SetColour(String col) + SetColour(self, String col) - GetText() -> String + GetText(self) -> String - GetFont() -> Font + GetFont(self) -> Font - GetMinSize(double OUTPUT, double OUTPUT) + GetMinSize(self, double OUTPUT, double OUTPUT) - GetProportion(double OUTPUT, double OUTPUT) + GetProportion(self, double OUTPUT, double OUTPUT) - GetSize(double OUTPUT, double OUTPUT) + GetSize(self, double OUTPUT, double OUTPUT) - GetPosition(double OUTPUT, double OUTPUT) + GetPosition(self, double OUTPUT, double OUTPUT) - GetFormatMode() -> int + GetFormatMode(self) -> int - GetName() -> String + GetName(self) -> String - GetColour() -> String + GetColour(self) -> String - GetActualColourObject() -> Colour + GetActualColourObject(self) -> Colour - GetFormattedText() -> wxList + GetFormattedText(self) -> wxList - GetPenColour() -> String + GetPenColour(self) -> String - GetPenStyle() -> int + GetPenStyle(self) -> int - SetPenStyle(int style) + SetPenStyle(self, int style) - SetPenColour(String col) + SetPenColour(self, String col) - GetActualPen() -> wxPen + GetActualPen(self) -> wxPen - GetWidth() -> double + GetWidth(self) -> double - GetHeight() -> double + GetHeight(self) -> double - ClearText() + ClearText(self) - __init__(int id=0, double x=0.0, double y=0.0) -> AttachmentPoint + __init__(self, int id=0, double x=0.0, double y=0.0) -> AttachmentPoint @@ -28591,94 +31954,94 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(PyShapeEvtHandler prev=None, PyShape shape=None) -> PyShapeEvtHandler + __init__(self, PyShapeEvtHandler prev=None, PyShape shape=None) -> PyShapeEvtHandler - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - _setOORInfo(PyObject _self) + _setOORInfo(self, PyObject _self) - SetShape(PyShape sh) + SetShape(self, PyShape sh) - GetShape() -> PyShape + GetShape(self) -> PyShape - SetPreviousHandler(PyShapeEvtHandler handler) + SetPreviousHandler(self, PyShapeEvtHandler handler) - GetPreviousHandler() -> PyShapeEvtHandler + GetPreviousHandler(self) -> PyShapeEvtHandler - CreateNewCopy() -> PyShapeEvtHandler + CreateNewCopy(self) -> PyShapeEvtHandler - base_OnDelete() + base_OnDelete(self) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=False) + base_OnDrawBranches(self, DC dc, bool erase=False) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -28687,7 +32050,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -28696,7 +32059,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -28705,14 +32068,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -28724,7 +32087,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -28736,7 +32099,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -28746,7 +32109,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -28755,7 +32118,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -28764,7 +32127,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -28774,7 +32137,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -28783,7 +32146,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -28792,7 +32155,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -28802,26 +32165,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -28833,7 +32196,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -28844,7 +32207,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -28855,14 +32218,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -28872,34 +32235,34 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(PyShapeCanvas can=None) -> PyShape + __init__(self, PyShapeCanvas can=None) -> PyShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - GetBoundingBoxMax(double OUTPUT, double OUTPUT) + GetBoundingBoxMax(self, double OUTPUT, double OUTPUT) - GetBoundingBoxMin(double OUTPUT, double OUTPUT) + GetBoundingBoxMin(self, double OUTPUT, double OUTPUT) - GetPerimeterPoint(double x1, double y1, double x2, double y2, double OUTPUT, + GetPerimeterPoint(self, double x1, double y1, double x2, double y2, double OUTPUT, double OUTPUT) -> bool @@ -28911,192 +32274,192 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetCanvas() -> PyShapeCanvas + GetCanvas(self) -> PyShapeCanvas - SetCanvas(PyShapeCanvas the_canvas) + SetCanvas(self, PyShapeCanvas the_canvas) - AddToCanvas(PyShapeCanvas the_canvas, PyShape addAfter=None) + AddToCanvas(self, PyShapeCanvas the_canvas, PyShape addAfter=None) - InsertInCanvas(PyShapeCanvas the_canvas) + InsertInCanvas(self, PyShapeCanvas the_canvas) - RemoveFromCanvas(PyShapeCanvas the_canvas) + RemoveFromCanvas(self, PyShapeCanvas the_canvas) - GetX() -> double + GetX(self) -> double - GetY() -> double + GetY(self) -> double - SetX(double x) + SetX(self, double x) - SetY(double y) + SetY(self, double y) - GetParent() -> PyShape + GetParent(self) -> PyShape - SetParent(PyShape p) + SetParent(self, PyShape p) - GetTopAncestor() -> PyShape + GetTopAncestor(self) -> PyShape - GetChildren() -> PyObject + GetChildren(self) -> PyObject - Unlink() + Unlink(self) - SetDrawHandles(bool drawH) + SetDrawHandles(self, bool drawH) - GetDrawHandles() -> bool + GetDrawHandles(self) -> bool - MakeControlPoints() + MakeControlPoints(self) - DeleteControlPoints(DC dc=None) + DeleteControlPoints(self, DC dc=None) - ResetControlPoints() + ResetControlPoints(self) - GetEventHandler() -> PyShapeEvtHandler + GetEventHandler(self) -> PyShapeEvtHandler - SetEventHandler(PyShapeEvtHandler handler) + SetEventHandler(self, PyShapeEvtHandler handler) - MakeMandatoryControlPoints() + MakeMandatoryControlPoints(self) - ResetMandatoryControlPoints() + ResetMandatoryControlPoints(self) - Recompute() -> bool + Recompute(self) -> bool - CalculateSize() + CalculateSize(self) - Select(bool select=True, DC dc=None) + Select(self, bool select=True, DC dc=None) - SetHighlight(bool hi=True, bool recurse=False) + SetHighlight(self, bool hi=True, bool recurse=False) - IsHighlighted() -> bool + IsHighlighted(self) -> bool - Selected() -> bool + Selected(self) -> bool - AncestorSelected() -> bool + AncestorSelected(self) -> bool - SetSensitivityFilter(int sens=OP_ALL, bool recursive=False) + SetSensitivityFilter(self, int sens=OP_ALL, bool recursive=False) - GetSensitivityFilter() -> int + GetSensitivityFilter(self) -> int - SetDraggable(bool drag, bool recursive=False) + SetDraggable(self, bool drag, bool recursive=False) - SetFixedSize(bool x, bool y) + SetFixedSize(self, bool x, bool y) - GetFixedSize(bool OUTPUT, bool OUTPUT) + GetFixedSize(self, bool OUTPUT, bool OUTPUT) - GetFixedWidth() -> bool + GetFixedWidth(self) -> bool - GetFixedHeight() -> bool + GetFixedHeight(self) -> bool - SetSpaceAttachments(bool sp) + SetSpaceAttachments(self, bool sp) - GetSpaceAttachments() -> bool + GetSpaceAttachments(self) -> bool - SetShadowMode(int mode, bool redraw=False) + SetShadowMode(self, int mode, bool redraw=False) - GetShadowMode() -> int + GetShadowMode(self) -> int - HitTest(double x, double y, int OUTPUT, double OUTPUT) -> bool + HitTest(self, double x, double y, int OUTPUT, double OUTPUT) -> bool @@ -29105,76 +32468,76 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - SetCentreResize(bool cr) + SetCentreResize(self, bool cr) - GetCentreResize() -> bool + GetCentreResize(self) -> bool - SetMaintainAspectRatio(bool ar) + SetMaintainAspectRatio(self, bool ar) - GetMaintainAspectRatio() -> bool + GetMaintainAspectRatio(self) -> bool - GetLines() -> PyObject + GetLines(self) -> PyObject - SetDisableLabel(bool flag) + SetDisableLabel(self, bool flag) - GetDisableLabel() -> bool + GetDisableLabel(self) -> bool - SetAttachmentMode(int mode) + SetAttachmentMode(self, int mode) - GetAttachmentMode() -> int + GetAttachmentMode(self) -> int - SetId(long i) + SetId(self, long i) - GetId() -> long + GetId(self) -> long - SetPen(wxPen pen) + SetPen(self, wxPen pen) - SetBrush(wxBrush brush) + SetBrush(self, wxBrush brush) - Show(bool show) + Show(self, bool show) - IsShown() -> bool + IsShown(self) -> bool - Move(DC dc, double x1, double y1, bool display=True) + Move(self, DC dc, double x1, double y1, bool display=True) @@ -29183,40 +32546,40 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - Erase(DC dc) + Erase(self, DC dc) - EraseContents(DC dc) + EraseContents(self, DC dc) - Draw(DC dc) + Draw(self, DC dc) - Flash() + Flash(self) - MoveLinks(DC dc) + MoveLinks(self, DC dc) - DrawContents(DC dc) + DrawContents(self, DC dc) - SetSize(double x, double y, bool recursive=True) + SetSize(self, double x, double y, bool recursive=True) @@ -29224,26 +32587,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - SetAttachmentSize(double x, double y) + SetAttachmentSize(self, double x, double y) - Attach(PyShapeCanvas can) + Attach(self, PyShapeCanvas can) - Detach() + Detach(self) - Constrain() -> bool + Constrain(self) -> bool - AddLine(PyLineShape line, PyShape other, int attachFrom=0, + AddLine(self, PyLineShape line, PyShape other, int attachFrom=0, int attachTo=0, int positionFrom=-1, int positionTo=-1) @@ -29255,28 +32618,28 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetLinePosition(PyLineShape line) -> int + GetLinePosition(self, PyLineShape line) -> int - AddText(String string) + AddText(self, String string) - GetPen() -> wxPen + GetPen(self) -> wxPen - GetBrush() -> wxBrush + GetBrush(self) -> wxBrush - SetDefaultRegionSize() + SetDefaultRegionSize(self) - FormatText(DC dc, String s, int regionId=0) + FormatText(self, DC dc, String s, int regionId=0) @@ -29284,114 +32647,114 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - SetFormatMode(int mode, int regionId=0) + SetFormatMode(self, int mode, int regionId=0) - GetFormatMode(int regionId=0) -> int + GetFormatMode(self, int regionId=0) -> int - SetFont(Font font, int regionId=0) + SetFont(self, Font font, int regionId=0) - GetFont(int regionId=0) -> Font + GetFont(self, int regionId=0) -> Font - SetTextColour(String colour, int regionId=0) + SetTextColour(self, String colour, int regionId=0) - GetTextColour(int regionId=0) -> String + GetTextColour(self, int regionId=0) -> String - GetNumberOfTextRegions() -> int + GetNumberOfTextRegions(self) -> int - SetRegionName(String name, int regionId=0) + SetRegionName(self, String name, int regionId=0) - GetRegionName(int regionId) -> String + GetRegionName(self, int regionId) -> String - GetRegionId(String name) -> int + GetRegionId(self, String name) -> int - NameRegions(String parentName=EmptyString) + NameRegions(self, String parentName=EmptyString) - GetRegions() -> PyObject + GetRegions(self) -> PyObject - AddRegion(ShapeRegion region) + AddRegion(self, ShapeRegion region) - ClearRegions() + ClearRegions(self) - AssignNewIds() + AssignNewIds(self) - FindRegion(String regionName, int OUTPUT) -> PyShape + FindRegion(self, String regionName, int OUTPUT) -> PyShape - FindRegionNames(wxStringList list) + FindRegionNames(self, wxStringList list) - ClearText(int regionId=0) + ClearText(self, int regionId=0) - RemoveLine(PyLineShape line) + RemoveLine(self, PyLineShape line) - GetAttachmentPosition(int attachment, double OUTPUT, double OUTPUT, int nth=0, + GetAttachmentPosition(self, int attachment, double OUTPUT, double OUTPUT, int nth=0, int no_arcs=1, PyLineShape line=None) -> bool @@ -29403,19 +32766,19 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetNumberOfAttachments() -> int + GetNumberOfAttachments(self) -> int - AttachmentIsValid(int attachment) -> bool + AttachmentIsValid(self, int attachment) -> bool - GetAttachments() -> PyObject + GetAttachments(self) -> PyObject - GetAttachmentPositionEdge(int attachment, double OUTPUT, double OUTPUT, int nth=0, + GetAttachmentPositionEdge(self, int attachment, double OUTPUT, double OUTPUT, int nth=0, int no_arcs=1, PyLineShape line=None) -> bool @@ -29427,7 +32790,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - CalcSimpleAttachment(RealPoint pt1, RealPoint pt2, int nth, int noArcs, + CalcSimpleAttachment(self, RealPoint pt1, RealPoint pt2, int nth, int noArcs, PyLineShape line) -> RealPoint @@ -29438,7 +32801,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - AttachmentSortTest(int attachmentPoint, RealPoint pt1, RealPoint pt2) -> bool + AttachmentSortTest(self, int attachmentPoint, RealPoint pt1, RealPoint pt2) -> bool @@ -29446,7 +32809,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - EraseLinks(DC dc, int attachment=-1, bool recurse=False) + EraseLinks(self, DC dc, int attachment=-1, bool recurse=False) @@ -29454,7 +32817,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - DrawLinks(DC dc, int attachment=-1, bool recurse=False) + DrawLinks(self, DC dc, int attachment=-1, bool recurse=False) @@ -29462,7 +32825,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - MoveLineToNewAttachment(DC dc, PyLineShape to_move, double x, double y) -> bool + MoveLineToNewAttachment(self, DC dc, PyLineShape to_move, double x, double y) -> bool @@ -29471,19 +32834,19 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - ApplyAttachmentOrdering(PyObject linesToSort) + ApplyAttachmentOrdering(self, PyObject linesToSort) - GetBranchingAttachmentRoot(int attachment) -> RealPoint + GetBranchingAttachmentRoot(self, int attachment) -> RealPoint - GetBranchingAttachmentInfo(int attachment, RealPoint root, RealPoint neck, RealPoint shoulder1, + GetBranchingAttachmentInfo(self, int attachment, RealPoint root, RealPoint neck, RealPoint shoulder1, RealPoint shoulder2) -> bool @@ -29494,7 +32857,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetBranchingAttachmentPoint(int attachment, int n, RealPoint attachmentPoint, RealPoint stemPoint) -> bool + GetBranchingAttachmentPoint(self, int attachment, int n, RealPoint attachmentPoint, RealPoint stemPoint) -> bool @@ -29503,89 +32866,89 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetAttachmentLineCount(int attachment) -> int + GetAttachmentLineCount(self, int attachment) -> int - SetBranchNeckLength(int len) + SetBranchNeckLength(self, int len) - GetBranchNeckLength() -> int + GetBranchNeckLength(self) -> int - SetBranchStemLength(int len) + SetBranchStemLength(self, int len) - GetBranchStemLength() -> int + GetBranchStemLength(self) -> int - SetBranchSpacing(int len) + SetBranchSpacing(self, int len) - GetBranchSpacing() -> int + GetBranchSpacing(self) -> int - SetBranchStyle(long style) + SetBranchStyle(self, long style) - GetBranchStyle() -> long + GetBranchStyle(self) -> long - PhysicalToLogicalAttachment(int physicalAttachment) -> int + PhysicalToLogicalAttachment(self, int physicalAttachment) -> int - LogicalToPhysicalAttachment(int logicalAttachment) -> int + LogicalToPhysicalAttachment(self, int logicalAttachment) -> int - Draggable() -> bool + Draggable(self) -> bool - HasDescendant(PyShape image) -> bool + HasDescendant(self, PyShape image) -> bool - CreateNewCopy(bool resetMapping=True, bool recompute=True) -> PyShape + CreateNewCopy(self, bool resetMapping=True, bool recompute=True) -> PyShape - Copy(PyShape copy) + Copy(self, PyShape copy) - CopyWithHandler(PyShape copy) + CopyWithHandler(self, PyShape copy) - Rotate(double x, double y, double theta) + Rotate(self, double x, double y, double theta) @@ -29593,83 +32956,83 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetRotation() -> double + GetRotation(self) -> double - SetRotation(double rotation) + SetRotation(self, double rotation) - ClearAttachments() + ClearAttachments(self) - Recentre(DC dc) + Recentre(self, DC dc) - ClearPointList(wxList list) + ClearPointList(self, wxList list) - GetBackgroundPen() -> wxPen + GetBackgroundPen(self) -> wxPen - GetBackgroundBrush() -> wxBrush + GetBackgroundBrush(self) -> wxBrush - base_OnDelete() + base_OnDelete(self) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=False) + base_OnDrawBranches(self, DC dc, bool erase=False) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -29678,7 +33041,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -29687,7 +33050,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -29696,14 +33059,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -29715,7 +33078,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -29727,7 +33090,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -29737,7 +33100,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -29746,7 +33109,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -29755,7 +33118,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -29765,7 +33128,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -29774,7 +33137,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -29783,7 +33146,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -29793,26 +33156,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -29824,7 +33187,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -29835,7 +33198,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -29846,14 +33209,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -29863,13 +33226,13 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__() -> PseudoMetaFile + __init__(self) -> PseudoMetaFile - __del__() + __del__(self) - Draw(DC dc, double xoffset, double yoffset) + Draw(self, DC dc, double xoffset, double yoffset) @@ -29877,37 +33240,37 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - Clear() + Clear(self) - Copy(PseudoMetaFile copy) + Copy(self, PseudoMetaFile copy) - Scale(double sx, double sy) + Scale(self, double sx, double sy) - ScaleTo(double w, double h) + ScaleTo(self, double w, double h) - Translate(double x, double y) + Translate(self, double x, double y) - Rotate(double x, double y, double theta) + Rotate(self, double x, double y, double theta) @@ -29915,7 +33278,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - LoadFromMetaFile(String filename, double width, double height) -> bool + LoadFromMetaFile(self, String filename, double width, double height) -> bool @@ -29923,7 +33286,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetBounds(double minX, double minY, double maxX, double maxY) + GetBounds(self, double minX, double minY, double maxX, double maxY) @@ -29932,79 +33295,79 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - CalculateSize(PyDrawnShape shape) + CalculateSize(self, PyDrawnShape shape) - SetRotateable(bool rot) + SetRotateable(self, bool rot) - GetRotateable() -> bool + GetRotateable(self) -> bool - SetSize(double w, double h) + SetSize(self, double w, double h) - SetFillBrush(wxBrush brush) + SetFillBrush(self, wxBrush brush) - GetFillBrush() -> wxBrush + GetFillBrush(self) -> wxBrush - SetOutlinePen(wxPen pen) + SetOutlinePen(self, wxPen pen) - GetOutlinePen() -> wxPen + GetOutlinePen(self) -> wxPen - SetOutlineOp(int op) + SetOutlineOp(self, int op) - GetOutlineOp() -> int + GetOutlineOp(self) -> int - IsValid() -> bool + IsValid(self) -> bool - DrawLine(Point pt1, Point pt2) + DrawLine(self, Point pt1, Point pt2) - DrawRectangle(Rect rect) + DrawRectangle(self, Rect rect) - DrawRoundedRectangle(Rect rect, double radius) + DrawRoundedRectangle(self, Rect rect, double radius) - DrawArc(Point centrePt, Point startPt, Point endPt) + DrawArc(self, Point centrePt, Point startPt, Point endPt) @@ -30012,7 +33375,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - DrawEllipticArc(Rect rect, double startAngle, double endAngle) + DrawEllipticArc(self, Rect rect, double startAngle, double endAngle) @@ -30020,89 +33383,89 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - DrawEllipse(Rect rect) + DrawEllipse(self, Rect rect) - DrawPoint(Point pt) + DrawPoint(self, Point pt) - DrawText(String text, Point pt) + DrawText(self, String text, Point pt) - DrawLines(int PCOUNT, Point points) + DrawLines(self, int points, Point points_array) - - + + - DrawPolygon(int PCOUNT, Point points, int flags=0) + DrawPolygon(self, int points, Point points_array, int flags=0) - - + + - DrawSpline(int PCOUNT, Point points) + DrawSpline(self, int points, Point points_array) - - + + - SetClippingRect(Rect rect) + SetClippingRect(self, Rect rect) - DestroyClippingRect() + DestroyClippingRect(self) - SetPen(wxPen pen, bool isOutline=FALSE) + SetPen(self, wxPen pen, bool isOutline=FALSE) - SetBrush(wxBrush brush, bool isFill=FALSE) + SetBrush(self, wxBrush brush, bool isFill=FALSE) - SetFont(Font font) + SetFont(self, Font font) - SetTextColour(Colour colour) + SetTextColour(self, Colour colour) - SetBackgroundColour(Colour colour) + SetBackgroundColour(self, Colour colour) - SetBackgroundMode(int mode) + SetBackgroundMode(self, int mode) @@ -30111,76 +33474,76 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(double width=0.0, double height=0.0) -> PyRectangleShape + __init__(self, double width=0.0, double height=0.0) -> PyRectangleShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - SetCornerRadius(double radius) + SetCornerRadius(self, double radius) - GetCornerRadius() -> double + GetCornerRadius(self) -> double - base_OnDelete() + base_OnDelete(self) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -30189,7 +33552,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -30198,7 +33561,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -30207,14 +33570,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -30226,7 +33589,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -30238,7 +33601,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -30248,7 +33611,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -30257,7 +33620,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -30266,7 +33629,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -30276,7 +33639,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -30285,7 +33648,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -30294,7 +33657,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -30304,26 +33667,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -30335,7 +33698,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -30346,7 +33709,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -30357,14 +33720,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -30374,7 +33737,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(PyShapeCanvas the_canvas=None, PyShape object=None, + __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 @@ -30387,66 +33750,66 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - SetCornerRadius(double radius) + SetCornerRadius(self, double radius) - base_OnDelete() + base_OnDelete(self) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -30455,7 +33818,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -30464,7 +33827,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -30473,14 +33836,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -30492,7 +33855,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -30504,7 +33867,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -30514,7 +33877,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -30523,7 +33886,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -30532,7 +33895,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -30542,7 +33905,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -30551,7 +33914,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -30560,7 +33923,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -30570,26 +33933,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -30601,7 +33964,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -30612,7 +33975,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -30623,14 +33986,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -30640,81 +34003,81 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__() -> PyBitmapShape + __init__(self) -> PyBitmapShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - GetBitmap() -> Bitmap + GetBitmap(self) -> Bitmap - GetFilename() -> String + GetFilename(self) -> String - SetBitmap(Bitmap bitmap) + SetBitmap(self, Bitmap bitmap) - SetFilename(String filename) + SetFilename(self, String filename) - base_OnDelete() + base_OnDelete(self) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -30723,7 +34086,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -30732,7 +34095,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -30741,14 +34104,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -30760,7 +34123,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -30772,7 +34135,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -30782,7 +34145,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -30791,7 +34154,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -30800,7 +34163,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -30810,7 +34173,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -30819,7 +34182,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -30828,7 +34191,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -30838,26 +34201,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -30869,7 +34232,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -30880,7 +34243,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -30891,14 +34254,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -30908,23 +34271,23 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__() -> PyDrawnShape + __init__(self) -> PyDrawnShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - CalculateSize() + CalculateSize(self) - DestroyClippingRect() + DestroyClippingRect(self) - DrawArc(Point centrePoint, Point startPoint, Point endPoint) + DrawArc(self, Point centrePoint, Point startPoint, Point endPoint) @@ -30932,13 +34295,13 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - DrawAtAngle(int angle) + DrawAtAngle(self, int angle) - DrawEllipticArc(Rect rect, double startAngle, double endAngle) + DrawEllipticArc(self, Rect rect, double startAngle, double endAngle) @@ -30946,77 +34309,77 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - DrawLine(Point point1, Point point2) + DrawLine(self, Point point1, Point point2) - DrawLines(int PCOUNT, Point points) + DrawLines(self, int points, Point points_array) - - + + - DrawPoint(Point point) + DrawPoint(self, Point point) - DrawPolygon(int PCOUNT, Point points, int flags=0) + DrawPolygon(self, int points, Point points_array, int flags=0) - - + + - DrawRectangle(Rect rect) + DrawRectangle(self, Rect rect) - DrawRoundedRectangle(Rect rect, double radius) + DrawRoundedRectangle(self, Rect rect, double radius) - DrawSpline(int PCOUNT, Point points) + DrawSpline(self, int points, Point points_array) - - + + - DrawText(String text, Point point) + DrawText(self, String text, Point point) - GetAngle() -> int + GetAngle(self) -> int - GetMetaFile() -> PseudoMetaFile + GetMetaFile(self) -> PseudoMetaFile - GetRotation() -> double + GetRotation(self) -> double - LoadFromMetaFile(String filename) -> bool + LoadFromMetaFile(self, String filename) -> bool - Rotate(double x, double y, double theta) + Rotate(self, double x, double y, double theta) @@ -31024,117 +34387,117 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - SetClippingRect(Rect rect) + SetClippingRect(self, Rect rect) - SetDrawnBackgroundColour(Colour colour) + SetDrawnBackgroundColour(self, Colour colour) - SetDrawnBackgroundMode(int mode) + SetDrawnBackgroundMode(self, int mode) - SetDrawnBrush(wxBrush pen, bool isOutline=FALSE) + SetDrawnBrush(self, wxBrush pen, bool isOutline=FALSE) - SetDrawnFont(Font font) + SetDrawnFont(self, Font font) - SetDrawnPen(wxPen pen, bool isOutline=FALSE) + SetDrawnPen(self, wxPen pen, bool isOutline=FALSE) - SetDrawnTextColour(Colour colour) + SetDrawnTextColour(self, Colour colour) - Scale(double sx, double sy) + Scale(self, double sx, double sy) - SetSaveToFile(bool save) + SetSaveToFile(self, bool save) - Translate(double x, double y) + Translate(self, double x, double y) - base_OnDelete() + base_OnDelete(self) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -31143,7 +34506,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -31152,7 +34515,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -31161,14 +34524,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -31180,7 +34543,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -31192,7 +34555,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -31202,7 +34565,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -31211,7 +34574,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -31220,7 +34583,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -31230,7 +34593,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -31239,7 +34602,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -31248,7 +34611,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -31258,26 +34621,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -31289,7 +34652,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -31300,7 +34663,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -31311,14 +34674,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -31328,7 +34691,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(int type, PyShape constraining, PyObject constrained) -> OGLConstraint + __init__(self, int type, PyShape constraining, PyObject constrained) -> OGLConstraint @@ -31336,17 +34699,17 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - Evaluate() -> bool + Evaluate(self) -> bool - SetSpacing(double x, double y) + SetSpacing(self, double x, double y) - Equals(double a, double b) -> bool + Equals(self, double a, double b) -> bool @@ -31356,30 +34719,30 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__() -> PyCompositeShape + __init__(self) -> PyCompositeShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - AddChild(PyShape child, PyShape addAfter=None) + AddChild(self, PyShape child, PyShape addAfter=None) - AddConstraint(OGLConstraint constraint) -> OGLConstraint + AddConstraint(self, OGLConstraint constraint) -> OGLConstraint - AddConstrainedShapes(int type, PyShape constraining, PyObject constrained) -> OGLConstraint + AddConstrainedShapes(self, int type, PyShape constraining, PyObject constrained) -> OGLConstraint @@ -31387,7 +34750,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - AddSimpleConstraint(int type, PyShape constraining, PyShape constrained) -> OGLConstraint + AddSimpleConstraint(self, int type, PyShape constraining, PyShape constrained) -> OGLConstraint @@ -31395,95 +34758,95 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - CalculateSize() + CalculateSize(self) - ContainsDivision(PyDivisionShape division) -> bool + ContainsDivision(self, PyDivisionShape division) -> bool - DeleteConstraint(OGLConstraint constraint) + DeleteConstraint(self, OGLConstraint constraint) - DeleteConstraintsInvolvingChild(PyShape child) + DeleteConstraintsInvolvingChild(self, PyShape child) - FindContainerImage() -> PyShape + FindContainerImage(self) -> PyShape - GetConstraints() -> PyObject + GetConstraints(self) -> PyObject - GetDivisions() -> PyObject + GetDivisions(self) -> PyObject - MakeContainer() + MakeContainer(self) - Recompute() -> bool + Recompute(self) -> bool - RemoveChild(PyShape child) + RemoveChild(self, PyShape child) - base_OnDelete() + base_OnDelete(self) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -31492,7 +34855,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -31501,7 +34864,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -31510,14 +34873,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -31529,7 +34892,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -31541,7 +34904,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -31551,7 +34914,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -31560,7 +34923,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -31569,7 +34932,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -31579,7 +34942,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -31588,7 +34951,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -31597,7 +34960,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -31607,26 +34970,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -31638,7 +35001,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -31649,7 +35012,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -31660,14 +35023,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -31677,73 +35040,73 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(double width=0.0, double height=0.0) -> PyDividedShape + __init__(self, double width=0.0, double height=0.0) -> PyDividedShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - EditRegions() + EditRegions(self) - SetRegionSizes() + SetRegionSizes(self) - base_OnDelete() + base_OnDelete(self) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -31752,7 +35115,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -31761,7 +35124,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -31770,14 +35133,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -31789,7 +35152,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -31801,7 +35164,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -31811,7 +35174,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -31820,7 +35183,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -31829,7 +35192,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -31839,7 +35202,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -31848,7 +35211,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -31857,7 +35220,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -31867,26 +35230,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -31898,7 +35261,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -31909,7 +35272,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -31920,14 +35283,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -31937,81 +35300,81 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__() -> PyDivisionShape + __init__(self) -> PyDivisionShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - AdjustBottom(double bottom, bool test) + AdjustBottom(self, double bottom, bool test) - AdjustLeft(double left, bool test) + AdjustLeft(self, double left, bool test) - AdjustRight(double right, bool test) + AdjustRight(self, double right, bool test) - AdjustTop(double top, bool test) + AdjustTop(self, double top, bool test) - Divide(int direction) + Divide(self, int direction) - EditEdge(int side) + EditEdge(self, int side) - GetBottomSide() -> PyDivisionShape + GetBottomSide(self) -> PyDivisionShape - GetHandleSide() -> int + GetHandleSide(self) -> int - GetLeftSide() -> PyDivisionShape + GetLeftSide(self) -> PyDivisionShape - GetLeftSideColour() -> String + GetLeftSideColour(self) -> String - GetLeftSidePen() -> wxPen + GetLeftSidePen(self) -> wxPen - GetRightSide() -> PyDivisionShape + GetRightSide(self) -> PyDivisionShape - GetTopSide() -> PyDivisionShape + GetTopSide(self) -> PyDivisionShape - GetTopSidePen() -> wxPen + GetTopSidePen(self) -> wxPen - ResizeAdjoining(int side, double newPos, bool test) + ResizeAdjoining(self, int side, double newPos, bool test) @@ -32019,114 +35382,114 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - PopupMenu(double x, double y) + PopupMenu(self, double x, double y) - SetBottomSide(PyDivisionShape shape) + SetBottomSide(self, PyDivisionShape shape) - SetHandleSide(int side) + SetHandleSide(self, int side) - SetLeftSide(PyDivisionShape shape) + SetLeftSide(self, PyDivisionShape shape) - SetLeftSideColour(String colour) + SetLeftSideColour(self, String colour) - SetLeftSidePen(wxPen pen) + SetLeftSidePen(self, wxPen pen) - SetRightSide(PyDivisionShape shape) + SetRightSide(self, PyDivisionShape shape) - SetTopSide(PyDivisionShape shape) + SetTopSide(self, PyDivisionShape shape) - SetTopSideColour(String colour) + SetTopSideColour(self, String colour) - SetTopSidePen(wxPen pen) + SetTopSidePen(self, wxPen pen) - base_OnDelete() + base_OnDelete(self) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -32135,7 +35498,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -32144,7 +35507,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -32153,14 +35516,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -32172,7 +35535,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -32184,7 +35547,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -32194,7 +35557,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -32203,7 +35566,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -32212,7 +35575,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -32222,7 +35585,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -32231,7 +35594,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -32240,7 +35603,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -32250,26 +35613,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -32281,7 +35644,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -32292,7 +35655,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -32303,14 +35666,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -32320,64 +35683,64 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(double width=0.0, double height=0.0) -> PyEllipseShape + __init__(self, double width=0.0, double height=0.0) -> PyEllipseShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -32386,7 +35749,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -32395,7 +35758,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -32404,14 +35767,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -32423,7 +35786,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -32435,7 +35798,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -32445,7 +35808,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -32454,7 +35817,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -32463,7 +35826,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -32473,7 +35836,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -32482,7 +35845,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -32491,7 +35854,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -32501,26 +35864,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -32532,7 +35895,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -32543,7 +35906,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -32554,14 +35917,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -32571,63 +35934,63 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(double width=0.0) -> PyCircleShape + __init__(self, double width=0.0) -> PyCircleShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -32636,7 +35999,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -32645,7 +36008,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -32654,14 +36017,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -32673,7 +36036,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -32685,7 +36048,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -32695,7 +36058,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -32704,7 +36067,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -32713,7 +36076,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -32723,7 +36086,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -32732,7 +36095,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -32741,7 +36104,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -32751,26 +36114,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -32782,7 +36145,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -32793,7 +36156,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -32804,14 +36167,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -32821,7 +36184,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(int type=0, int end=0, double size=0.0, double dist=0.0, + __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 @@ -32835,67 +36198,67 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __del__() + __del__(self) - _GetType() -> int + _GetType(self) -> int - GetPosition() -> int + GetPosition(self) -> int - SetPosition(int pos) + SetPosition(self, int pos) - GetXOffset() -> double + GetXOffset(self) -> double - GetYOffset() -> double + GetYOffset(self) -> double - GetSpacing() -> double + GetSpacing(self) -> double - GetSize() -> double + GetSize(self) -> double - GetName() -> String + GetName(self) -> String - SetXOffset(double x) + SetXOffset(self, double x) - SetYOffset(double y) + SetYOffset(self, double y) - GetMetaFile() -> PseudoMetaFile + GetMetaFile(self) -> PseudoMetaFile - GetId() -> long + GetId(self) -> long - GetArrowEnd() -> int + GetArrowEnd(self) -> int - GetArrowSize() -> double + GetArrowSize(self) -> double - SetSize(double size) + SetSize(self, double size) - SetSpacing(double sp) + SetSpacing(self, double sp) @@ -32904,17 +36267,17 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__() -> PyLineShape + __init__(self) -> PyLineShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - AddArrow(int type, int end=ARROW_POSITION_END, double arrowSize=10.0, + 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) @@ -32928,7 +36291,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - AddArrowOrdered(ArrowHead arrow, PyObject referenceList, int end) + AddArrowOrdered(self, ArrowHead arrow, PyObject referenceList, int end) @@ -32936,19 +36299,19 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - ClearArrow(String name) -> bool + ClearArrow(self, String name) -> bool - ClearArrowsAtPosition(int position=-1) + ClearArrowsAtPosition(self, int position=-1) - DrawArrow(DC dc, ArrowHead arrow, double xOffset, bool proportionalOffset) + DrawArrow(self, DC dc, ArrowHead arrow, double xOffset, bool proportionalOffset) @@ -32957,29 +36320,29 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - DeleteArrowHeadId(long arrowId) -> bool + DeleteArrowHeadId(self, long arrowId) -> bool - DeleteArrowHead(int position, String name) -> bool + DeleteArrowHead(self, int position, String name) -> bool - DeleteLineControlPoint() -> bool + DeleteLineControlPoint(self) -> bool - DrawArrows(DC dc) + DrawArrows(self, DC dc) - DrawRegion(DC dc, ShapeRegion region, double x, double y) + DrawRegion(self, DC dc, ShapeRegion region, double x, double y) @@ -32988,7 +36351,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - EraseRegion(DC dc, ShapeRegion region, double x, double y) + EraseRegion(self, DC dc, ShapeRegion region, double x, double y) @@ -32997,20 +36360,20 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - FindArrowHeadId(long arrowId) -> ArrowHead + FindArrowHeadId(self, long arrowId) -> ArrowHead - FindArrowHead(int position, String name) -> ArrowHead + FindArrowHead(self, int position, String name) -> ArrowHead - FindLineEndPoints(double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT) + FindLineEndPoints(self, double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT) @@ -33019,17 +36382,17 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - FindLinePosition(double x, double y) -> int + FindLinePosition(self, double x, double y) -> int - FindMinimumWidth() -> double + FindMinimumWidth(self) -> double - FindNth(PyShape image, int OUTPUT, int OUTPUT, bool incoming) + FindNth(self, PyShape image, int OUTPUT, int OUTPUT, bool incoming) @@ -33038,13 +36401,13 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetAttachmentFrom() -> int + GetAttachmentFrom(self) -> int - GetAttachmentTo() -> int + GetAttachmentTo(self) -> int - GetEnds(double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT) + GetEnds(self, double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT) @@ -33053,10 +36416,10 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetFrom() -> PyShape + GetFrom(self) -> PyShape - GetLabelPosition(int position, double OUTPUT, double OUTPUT) + GetLabelPosition(self, int position, double OUTPUT, double OUTPUT) @@ -33064,62 +36427,68 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetNextControlPoint(PyShape shape) -> RealPoint + GetNextControlPoint(self, PyShape shape) -> RealPoint - GetTo() -> PyShape + GetTo(self) -> PyShape - Initialise() + Initialise(self) - InsertLineControlPoint(DC dc) + InsertLineControlPoint(self, DC dc) - IsEnd(PyShape shape) -> bool + IsEnd(self, PyShape shape) -> bool - IsSpline() -> bool + IsSpline(self) -> bool - MakeLineControlPoints(int n) + MakeLineControlPoints(self, int n) - GetLineControlPoints() -> PyObject + GetLineControlPoints(self) -> PyObject + + + SetLineControlPoints(self, PyObject list) + + + - SetAttachmentFrom(int fromAttach) + SetAttachmentFrom(self, int fromAttach) - SetAttachments(int fromAttach, int toAttach) + SetAttachments(self, int fromAttach, int toAttach) - SetAttachmentTo(int toAttach) + SetAttachmentTo(self, int toAttach) - SetEnds(double x1, double y1, double x2, double y2) + SetEnds(self, double x1, double y1, double x2, double y2) @@ -33128,115 +36497,115 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - SetFrom(PyShape object) + SetFrom(self, PyShape object) - SetIgnoreOffsets(bool ignore) + SetIgnoreOffsets(self, bool ignore) - SetSpline(bool spline) + SetSpline(self, bool spline) - SetTo(PyShape object) + SetTo(self, PyShape object) - Straighten(DC dc=None) + Straighten(self, DC dc=None) - Unlink() + Unlink(self) - SetAlignmentOrientation(bool isEnd, bool isHoriz) + SetAlignmentOrientation(self, bool isEnd, bool isHoriz) - SetAlignmentType(bool isEnd, int alignType) + SetAlignmentType(self, bool isEnd, int alignType) - GetAlignmentOrientation(bool isEnd) -> bool + GetAlignmentOrientation(self, bool isEnd) -> bool - GetAlignmentType(bool isEnd) -> int + GetAlignmentType(self, bool isEnd) -> int - GetAlignmentStart() -> int + GetAlignmentStart(self) -> int - GetAlignmentEnd() -> int + GetAlignmentEnd(self) -> int - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -33245,7 +36614,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -33254,7 +36623,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -33263,14 +36632,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -33282,7 +36651,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -33294,7 +36663,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -33304,7 +36673,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -33313,7 +36682,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -33322,7 +36691,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -33332,7 +36701,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -33341,7 +36710,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -33350,7 +36719,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -33360,26 +36729,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -33391,7 +36760,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -33402,7 +36771,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -33413,14 +36782,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -33430,108 +36799,108 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__() -> PyPolygonShape + __init__(self) -> PyPolygonShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - Create(PyObject points) -> PyObject + Create(self, PyObject points) -> PyObject - AddPolygonPoint(int pos=0) + AddPolygonPoint(self, int pos=0) - CalculatePolygonCentre() + CalculatePolygonCentre(self) - DeletePolygonPoint(int pos=0) + DeletePolygonPoint(self, int pos=0) - GetPoints() -> PyObject + GetPoints(self) -> PyObject - GetOriginalPoints() -> PyObject + GetOriginalPoints(self) -> PyObject - GetOriginalWidth() -> double + GetOriginalWidth(self) -> double - GetOriginalHeight() -> double + GetOriginalHeight(self) -> double - SetOriginalWidth(double w) + SetOriginalWidth(self, double w) - SetOriginalHeight(double h) + SetOriginalHeight(self, double h) - UpdateOriginalPoints() + UpdateOriginalPoints(self) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -33540,7 +36909,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -33549,7 +36918,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -33558,14 +36927,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -33577,7 +36946,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -33589,7 +36958,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -33599,7 +36968,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -33608,7 +36977,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -33617,7 +36986,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -33627,7 +36996,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -33636,7 +37005,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -33645,7 +37014,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -33655,26 +37024,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -33686,7 +37055,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -33697,7 +37066,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -33708,14 +37077,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -33725,67 +37094,67 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(double width=0.0, double height=0.0) -> PyTextShape + __init__(self, double width=0.0, double height=0.0) -> PyTextShape - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - base_OnDelete() + base_OnDelete(self) - base_OnDraw(DC dc) + base_OnDraw(self, DC dc) - base_OnDrawContents(DC dc) + base_OnDrawContents(self, DC dc) - base_OnDrawBranches(DC dc, bool erase=FALSE) + base_OnDrawBranches(self, DC dc, bool erase=FALSE) - base_OnMoveLinks(DC dc) + base_OnMoveLinks(self, DC dc) - base_OnErase(DC dc) + base_OnErase(self, DC dc) - base_OnEraseContents(DC dc) + base_OnEraseContents(self, DC dc) - base_OnHighlight(DC dc) + base_OnHighlight(self, DC dc) - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) @@ -33794,7 +37163,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) @@ -33803,7 +37172,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0, int attachment=0) + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) @@ -33812,14 +37181,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSize(double x, double y) + base_OnSize(self, double x, double y) - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) -> bool @@ -33831,7 +37200,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, bool display=True) @@ -33843,7 +37212,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -33853,7 +37222,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -33862,7 +37231,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) + base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0) @@ -33871,7 +37240,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0) @@ -33881,7 +37250,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -33890,7 +37259,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) @@ -33899,7 +37268,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawOutline(DC dc, double x, double y, double w, double h) + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) @@ -33909,26 +37278,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDrawControlPoints(DC dc) + base_OnDrawControlPoints(self, DC dc) - base_OnEraseControlPoints(DC dc) + base_OnEraseControlPoints(self, DC dc) - base_OnMoveLink(DC dc, bool moveControlPoints=True) + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, int attachment=0) @@ -33940,7 +37309,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -33951,7 +37320,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, int attachment=0) @@ -33962,14 +37331,14 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginSize(double w, double h) + base_OnBeginSize(self, double w, double h) - base_OnEndSize(double w, double h) + base_OnEndSize(self, double w, double h) @@ -33979,26 +37348,26 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__() -> Diagram + __init__(self) -> Diagram - AddShape(PyShape shape, PyShape addAfter=None) + AddShape(self, PyShape shape, PyShape addAfter=None) - Clear(DC dc) + Clear(self, DC dc) - DeleteAllShapes() + DeleteAllShapes(self) - DrawOutline(DC dc, double x1, double y1, double x2, double y2) + DrawOutline(self, DC dc, double x1, double y1, double x2, double y2) @@ -34008,97 +37377,97 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - FindShape(long id) -> PyShape + FindShape(self, long id) -> PyShape - GetCanvas() -> PyShapeCanvas + GetCanvas(self) -> PyShapeCanvas - GetCount() -> int + GetCount(self) -> int - GetGridSpacing() -> double + GetGridSpacing(self) -> double - GetMouseTolerance() -> int + GetMouseTolerance(self) -> int - GetShapeList() -> PyObject + GetShapeList(self) -> PyObject - GetQuickEditMode() -> bool + GetQuickEditMode(self) -> bool - GetSnapToGrid() -> bool + GetSnapToGrid(self) -> bool - InsertShape(PyShape shape) + InsertShape(self, PyShape shape) - RecentreAll(DC dc) + RecentreAll(self, DC dc) - Redraw(DC dc) + Redraw(self, DC dc) - RemoveAllShapes() + RemoveAllShapes(self) - RemoveShape(PyShape shape) + RemoveShape(self, PyShape shape) - SetCanvas(PyShapeCanvas canvas) + SetCanvas(self, PyShapeCanvas canvas) - SetGridSpacing(double spacing) + SetGridSpacing(self, double spacing) - SetMouseTolerance(int tolerance) + SetMouseTolerance(self, int tolerance) - SetQuickEditMode(bool mode) + SetQuickEditMode(self, bool mode) - SetSnapToGrid(bool snap) + SetSnapToGrid(self, bool snap) - ShowAll(bool show) + ShowAll(self, bool show) - Snap(double INOUT, double INOUT) + Snap(self, double INOUT, double INOUT) @@ -34108,7 +37477,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - __init__(Window parent=None, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent=None, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=BORDER, String name=wxPyShapeCanvasNameStr) -> PyShapeCanvas @@ -34121,21 +37490,21 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - AddShape(PyShape shape, PyShape addAfter=None) + AddShape(self, PyShape shape, PyShape addAfter=None) - FindShape(double x1, double y, int OUTPUT, wxClassInfo info=None, + FindShape(self, double x1, double y, int OUTPUT, wxClassInfo info=None, PyShape notImage=None) -> PyShape @@ -34146,7 +37515,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - FindFirstSensitiveShape(double x1, double y, int OUTPUT, int op) -> PyShape + FindFirstSensitiveShape(self, double x1, double y, int OUTPUT, int op) -> PyShape @@ -34155,19 +37524,19 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - GetDiagram() -> Diagram + GetDiagram(self) -> Diagram - GetQuickEditMode() -> bool + GetQuickEditMode(self) -> bool - InsertShape(PyShape shape) + InsertShape(self, PyShape shape) - base_OnBeginDragLeft(double x, double y, int keys=0) + base_OnBeginDragLeft(self, double x, double y, int keys=0) @@ -34175,7 +37544,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnBeginDragRight(double x, double y, int keys=0) + base_OnBeginDragRight(self, double x, double y, int keys=0) @@ -34183,7 +37552,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragLeft(double x, double y, int keys=0) + base_OnEndDragLeft(self, double x, double y, int keys=0) @@ -34191,7 +37560,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnEndDragRight(double x, double y, int keys=0) + base_OnEndDragRight(self, double x, double y, int keys=0) @@ -34199,7 +37568,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragLeft(bool draw, double x, double y, int keys=0) + base_OnDragLeft(self, bool draw, double x, double y, int keys=0) @@ -34208,7 +37577,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnDragRight(bool draw, double x, double y, int keys=0) + base_OnDragRight(self, bool draw, double x, double y, int keys=0) @@ -34217,7 +37586,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnLeftClick(double x, double y, int keys=0) + base_OnLeftClick(self, double x, double y, int keys=0) @@ -34225,7 +37594,7 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - base_OnRightClick(double x, double y, int keys=0) + base_OnRightClick(self, double x, double y, int keys=0) @@ -34233,25 +37602,25 @@ EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - Redraw(DC dc) + Redraw(self, DC dc) - RemoveShape(PyShape shape) + RemoveShape(self, PyShape shape) - SetDiagram(Diagram diagram) + SetDiagram(self, Diagram diagram) - Snap(double INOUT, double INOUT) + Snap(self, double INOUT, double INOUT) @@ -34284,17 +37653,18 @@ ControlPoint = PyControlPoint - - - wx = core + + + wx = _core + __docfilter__ = wx.__DocFilter(globals()) - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=STCNameStr) -> StyledTextCtrl + __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=STCNameStr) -> StyledTextCtrl - + @@ -34305,11 +37675,11 @@ ControlPoint = PyControlPoint PreStyledTextCtrl() -> StyledTextCtrl - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=wxSTCNameStr) + Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=wxSTCNameStr) - + @@ -34317,195 +37687,195 @@ ControlPoint = PyControlPoint - AddText(String text) + AddText(self, String text) - AddStyledText(wxMemoryBuffer data) + AddStyledText(self, wxMemoryBuffer data) - InsertText(int pos, String text) + InsertText(self, int pos, String text) - ClearAll() + ClearAll(self) - ClearDocumentStyle() + ClearDocumentStyle(self) - GetLength() -> int + GetLength(self) -> int - GetCharAt(int pos) -> int + GetCharAt(self, int pos) -> int - GetCurrentPos() -> int + GetCurrentPos(self) -> int - GetAnchor() -> int + GetAnchor(self) -> int - GetStyleAt(int pos) -> int + GetStyleAt(self, int pos) -> int - Redo() + Redo(self) - SetUndoCollection(bool collectUndo) + SetUndoCollection(self, bool collectUndo) - SelectAll() + SelectAll(self) - SetSavePoint() + SetSavePoint(self) - GetStyledText(int startPos, int endPos) -> wxMemoryBuffer + GetStyledText(self, int startPos, int endPos) -> wxMemoryBuffer - CanRedo() -> bool + CanRedo(self) -> bool - MarkerLineFromHandle(int handle) -> int + MarkerLineFromHandle(self, int handle) -> int - MarkerDeleteHandle(int handle) + MarkerDeleteHandle(self, int handle) - GetUndoCollection() -> bool + GetUndoCollection(self) -> bool - GetViewWhiteSpace() -> int + GetViewWhiteSpace(self) -> int - SetViewWhiteSpace(int viewWS) + SetViewWhiteSpace(self, int viewWS) - PositionFromPoint(Point pt) -> int + PositionFromPoint(self, Point pt) -> int - PositionFromPointClose(int x, int y) -> int + PositionFromPointClose(self, int x, int y) -> int - GotoLine(int line) + GotoLine(self, int line) - GotoPos(int pos) + GotoPos(self, int pos) - SetAnchor(int posAnchor) + SetAnchor(self, int posAnchor) - GetCurLine(int OUTPUT) -> String + GetCurLine(self, int OUTPUT) -> String - GetEndStyled() -> int + GetEndStyled(self) -> int - ConvertEOLs(int eolMode) + ConvertEOLs(self, int eolMode) - GetEOLMode() -> int + GetEOLMode(self) -> int - SetEOLMode(int eolMode) + SetEOLMode(self, int eolMode) - StartStyling(int pos, int mask) + StartStyling(self, int pos, int mask) - SetStyling(int length, int style) + SetStyling(self, int length, int style) - GetBufferedDraw() -> bool + GetBufferedDraw(self) -> bool - SetBufferedDraw(bool buffered) + SetBufferedDraw(self, bool buffered) - SetTabWidth(int tabWidth) + SetTabWidth(self, int tabWidth) - GetTabWidth() -> int + GetTabWidth(self) -> int - SetCodePage(int codePage) + SetCodePage(self, int codePage) - MarkerDefine(int markerNumber, int markerSymbol, Colour foreground=wxNullColour, + MarkerDefine(self, int markerNumber, int markerSymbol, Colour foreground=wxNullColour, Colour background=wxNullColour) @@ -34515,223 +37885,223 @@ ControlPoint = PyControlPoint - MarkerSetForeground(int markerNumber, Colour fore) + MarkerSetForeground(self, int markerNumber, Colour fore) - MarkerSetBackground(int markerNumber, Colour back) + MarkerSetBackground(self, int markerNumber, Colour back) - MarkerAdd(int line, int markerNumber) -> int + MarkerAdd(self, int line, int markerNumber) -> int - MarkerDelete(int line, int markerNumber) + MarkerDelete(self, int line, int markerNumber) - MarkerDeleteAll(int markerNumber) + MarkerDeleteAll(self, int markerNumber) - MarkerGet(int line) -> int + MarkerGet(self, int line) -> int - MarkerNext(int lineStart, int markerMask) -> int + MarkerNext(self, int lineStart, int markerMask) -> int - MarkerPrevious(int lineStart, int markerMask) -> int + MarkerPrevious(self, int lineStart, int markerMask) -> int - MarkerDefineBitmap(int markerNumber, Bitmap bmp) + MarkerDefineBitmap(self, int markerNumber, Bitmap bmp) - SetMarginType(int margin, int marginType) + SetMarginType(self, int margin, int marginType) - GetMarginType(int margin) -> int + GetMarginType(self, int margin) -> int - SetMarginWidth(int margin, int pixelWidth) + SetMarginWidth(self, int margin, int pixelWidth) - GetMarginWidth(int margin) -> int + GetMarginWidth(self, int margin) -> int - SetMarginMask(int margin, int mask) + SetMarginMask(self, int margin, int mask) - GetMarginMask(int margin) -> int + GetMarginMask(self, int margin) -> int - SetMarginSensitive(int margin, bool sensitive) + SetMarginSensitive(self, int margin, bool sensitive) - GetMarginSensitive(int margin) -> bool + GetMarginSensitive(self, int margin) -> bool - StyleClearAll() + StyleClearAll(self) - StyleSetForeground(int style, Colour fore) + StyleSetForeground(self, int style, Colour fore) - StyleSetBackground(int style, Colour back) + StyleSetBackground(self, int style, Colour back) - StyleSetBold(int style, bool bold) + StyleSetBold(self, int style, bool bold) - StyleSetItalic(int style, bool italic) + StyleSetItalic(self, int style, bool italic) - StyleSetSize(int style, int sizePoints) + StyleSetSize(self, int style, int sizePoints) - StyleSetFaceName(int style, String fontName) + StyleSetFaceName(self, int style, String fontName) - StyleSetEOLFilled(int style, bool filled) + StyleSetEOLFilled(self, int style, bool filled) - StyleResetDefault() + StyleResetDefault(self) - StyleSetUnderline(int style, bool underline) + StyleSetUnderline(self, int style, bool underline) - StyleSetCase(int style, int caseForce) + StyleSetCase(self, int style, int caseForce) - StyleSetCharacterSet(int style, int characterSet) + StyleSetCharacterSet(self, int style, int characterSet) - StyleSetHotSpot(int style, bool hotspot) + StyleSetHotSpot(self, int style, bool hotspot) - SetSelForeground(bool useSetting, Colour fore) + SetSelForeground(self, bool useSetting, Colour fore) - SetSelBackground(bool useSetting, Colour back) + SetSelBackground(self, bool useSetting, Colour back) - SetCaretForeground(Colour fore) + SetCaretForeground(self, Colour fore) - CmdKeyAssign(int key, int modifiers, int cmd) + CmdKeyAssign(self, int key, int modifiers, int cmd) @@ -34739,386 +38109,386 @@ ControlPoint = PyControlPoint - CmdKeyClear(int key, int modifiers) + CmdKeyClear(self, int key, int modifiers) - CmdKeyClearAll() + CmdKeyClearAll(self) - SetStyleBytes(int length, char styleBytes) + SetStyleBytes(self, int length, char styleBytes) - StyleSetVisible(int style, bool visible) + StyleSetVisible(self, int style, bool visible) - GetCaretPeriod() -> int + GetCaretPeriod(self) -> int - SetCaretPeriod(int periodMilliseconds) + SetCaretPeriod(self, int periodMilliseconds) - SetWordChars(String characters) + SetWordChars(self, String characters) - BeginUndoAction() + BeginUndoAction(self) - EndUndoAction() + EndUndoAction(self) - IndicatorSetStyle(int indic, int style) + IndicatorSetStyle(self, int indic, int style) - IndicatorGetStyle(int indic) -> int + IndicatorGetStyle(self, int indic) -> int - IndicatorSetForeground(int indic, Colour fore) + IndicatorSetForeground(self, int indic, Colour fore) - IndicatorGetForeground(int indic) -> Colour + IndicatorGetForeground(self, int indic) -> Colour - SetWhitespaceForeground(bool useSetting, Colour fore) + SetWhitespaceForeground(self, bool useSetting, Colour fore) - SetWhitespaceBackground(bool useSetting, Colour back) + SetWhitespaceBackground(self, bool useSetting, Colour back) - SetStyleBits(int bits) + SetStyleBits(self, int bits) - GetStyleBits() -> int + GetStyleBits(self) -> int - SetLineState(int line, int state) + SetLineState(self, int line, int state) - GetLineState(int line) -> int + GetLineState(self, int line) -> int - GetMaxLineState() -> int + GetMaxLineState(self) -> int - GetCaretLineVisible() -> bool + GetCaretLineVisible(self) -> bool - SetCaretLineVisible(bool show) + SetCaretLineVisible(self, bool show) - GetCaretLineBack() -> Colour + GetCaretLineBack(self) -> Colour - SetCaretLineBack(Colour back) + SetCaretLineBack(self, Colour back) - StyleSetChangeable(int style, bool changeable) + StyleSetChangeable(self, int style, bool changeable) - AutoCompShow(int lenEntered, String itemList) + AutoCompShow(self, int lenEntered, String itemList) - AutoCompCancel() + AutoCompCancel(self) - AutoCompActive() -> bool + AutoCompActive(self) -> bool - AutoCompPosStart() -> int + AutoCompPosStart(self) -> int - AutoCompComplete() + AutoCompComplete(self) - AutoCompStops(String characterSet) + AutoCompStops(self, String characterSet) - AutoCompSetSeparator(int separatorCharacter) + AutoCompSetSeparator(self, int separatorCharacter) - AutoCompGetSeparator() -> int + AutoCompGetSeparator(self) -> int - AutoCompSelect(String text) + AutoCompSelect(self, String text) - AutoCompSetCancelAtStart(bool cancel) + AutoCompSetCancelAtStart(self, bool cancel) - AutoCompGetCancelAtStart() -> bool + AutoCompGetCancelAtStart(self) -> bool - AutoCompSetFillUps(String characterSet) + AutoCompSetFillUps(self, String characterSet) - AutoCompSetChooseSingle(bool chooseSingle) + AutoCompSetChooseSingle(self, bool chooseSingle) - AutoCompGetChooseSingle() -> bool + AutoCompGetChooseSingle(self) -> bool - AutoCompSetIgnoreCase(bool ignoreCase) + AutoCompSetIgnoreCase(self, bool ignoreCase) - AutoCompGetIgnoreCase() -> bool + AutoCompGetIgnoreCase(self) -> bool - UserListShow(int listType, String itemList) + UserListShow(self, int listType, String itemList) - AutoCompSetAutoHide(bool autoHide) + AutoCompSetAutoHide(self, bool autoHide) - AutoCompGetAutoHide() -> bool + AutoCompGetAutoHide(self) -> bool - AutoCompSetDropRestOfWord(bool dropRestOfWord) + AutoCompSetDropRestOfWord(self, bool dropRestOfWord) - AutoCompGetDropRestOfWord() -> bool + AutoCompGetDropRestOfWord(self) -> bool - RegisterImage(int type, Bitmap bmp) + RegisterImage(self, int type, Bitmap bmp) - ClearRegisteredImages() + ClearRegisteredImages(self) - AutoCompGetTypeSeparator() -> int + AutoCompGetTypeSeparator(self) -> int - AutoCompSetTypeSeparator(int separatorCharacter) + AutoCompSetTypeSeparator(self, int separatorCharacter) - SetIndent(int indentSize) + SetIndent(self, int indentSize) - GetIndent() -> int + GetIndent(self) -> int - SetUseTabs(bool useTabs) + SetUseTabs(self, bool useTabs) - GetUseTabs() -> bool + GetUseTabs(self) -> bool - SetLineIndentation(int line, int indentSize) + SetLineIndentation(self, int line, int indentSize) - GetLineIndentation(int line) -> int + GetLineIndentation(self, int line) -> int - GetLineIndentPosition(int line) -> int + GetLineIndentPosition(self, int line) -> int - GetColumn(int pos) -> int + GetColumn(self, int pos) -> int - SetUseHorizontalScrollBar(bool show) + SetUseHorizontalScrollBar(self, bool show) - GetUseHorizontalScrollBar() -> bool + GetUseHorizontalScrollBar(self) -> bool - SetIndentationGuides(bool show) + SetIndentationGuides(self, bool show) - GetIndentationGuides() -> bool + GetIndentationGuides(self) -> bool - SetHighlightGuide(int column) + SetHighlightGuide(self, int column) - GetHighlightGuide() -> int + GetHighlightGuide(self) -> int - GetLineEndPosition(int line) -> int + GetLineEndPosition(self, int line) -> int - GetCodePage() -> int + GetCodePage(self) -> int - GetCaretForeground() -> Colour + GetCaretForeground(self) -> Colour - GetReadOnly() -> bool + GetReadOnly(self) -> bool - SetCurrentPos(int pos) + SetCurrentPos(self, int pos) - SetSelectionStart(int pos) + SetSelectionStart(self, int pos) - GetSelectionStart() -> int + GetSelectionStart(self) -> int - SetSelectionEnd(int pos) + SetSelectionEnd(self, int pos) - GetSelectionEnd() -> int + GetSelectionEnd(self) -> int - SetPrintMagnification(int magnification) + SetPrintMagnification(self, int magnification) - GetPrintMagnification() -> int + GetPrintMagnification(self) -> int - SetPrintColourMode(int mode) + SetPrintColourMode(self, int mode) - GetPrintColourMode() -> int + GetPrintColourMode(self) -> int - FindText(int minPos, int maxPos, String text, int flags=0) -> int + FindText(self, int minPos, int maxPos, String text, int flags=0) -> int @@ -35127,7 +38497,7 @@ ControlPoint = PyControlPoint - FormatRange(bool doDraw, int startPos, int endPos, DC draw, DC target, + FormatRange(self, bool doDraw, int startPos, int endPos, DC draw, DC target, Rect renderRect, Rect pageRect) -> int @@ -35140,1095 +38510,1095 @@ ControlPoint = PyControlPoint - GetFirstVisibleLine() -> int + GetFirstVisibleLine(self) -> int - GetLine(int line) -> String + GetLine(self, int line) -> String - GetLineCount() -> int + GetLineCount(self) -> int - SetMarginLeft(int pixelWidth) + SetMarginLeft(self, int pixelWidth) - GetMarginLeft() -> int + GetMarginLeft(self) -> int - SetMarginRight(int pixelWidth) + SetMarginRight(self, int pixelWidth) - GetMarginRight() -> int + GetMarginRight(self) -> int - GetModify() -> bool + GetModify(self) -> bool - SetSelection(int start, int end) + SetSelection(self, int start, int end) - GetSelectedText() -> String + GetSelectedText(self) -> String - GetTextRange(int startPos, int endPos) -> String + GetTextRange(self, int startPos, int endPos) -> String - HideSelection(bool normal) + HideSelection(self, bool normal) - LineFromPosition(int pos) -> int + LineFromPosition(self, int pos) -> int - PositionFromLine(int line) -> int + PositionFromLine(self, int line) -> int - LineScroll(int columns, int lines) + LineScroll(self, int columns, int lines) - EnsureCaretVisible() + EnsureCaretVisible(self) - ReplaceSelection(String text) + ReplaceSelection(self, String text) - SetReadOnly(bool readOnly) + SetReadOnly(self, bool readOnly) - CanPaste() -> bool + CanPaste(self) -> bool - CanUndo() -> bool + CanUndo(self) -> bool - EmptyUndoBuffer() + EmptyUndoBuffer(self) - Undo() + Undo(self) - Cut() + Cut(self) - Copy() + Copy(self) - Paste() + Paste(self) - Clear() + Clear(self) - SetText(String text) + SetText(self, String text) - GetText() -> String + GetText(self) -> String - GetTextLength() -> int + GetTextLength(self) -> int - SetOvertype(bool overtype) + SetOvertype(self, bool overtype) - GetOvertype() -> bool + GetOvertype(self) -> bool - SetCaretWidth(int pixelWidth) + SetCaretWidth(self, int pixelWidth) - GetCaretWidth() -> int + GetCaretWidth(self) -> int - SetTargetStart(int pos) + SetTargetStart(self, int pos) - GetTargetStart() -> int + GetTargetStart(self) -> int - SetTargetEnd(int pos) + SetTargetEnd(self, int pos) - GetTargetEnd() -> int + GetTargetEnd(self) -> int - ReplaceTarget(String text) -> int + ReplaceTarget(self, String text) -> int - ReplaceTargetRE(String text) -> int + ReplaceTargetRE(self, String text) -> int - SearchInTarget(String text) -> int + SearchInTarget(self, String text) -> int - SetSearchFlags(int flags) + SetSearchFlags(self, int flags) - GetSearchFlags() -> int + GetSearchFlags(self) -> int - CallTipShow(int pos, String definition) + CallTipShow(self, int pos, String definition) - CallTipCancel() + CallTipCancel(self) - CallTipActive() -> bool + CallTipActive(self) -> bool - CallTipPosAtStart() -> int + CallTipPosAtStart(self) -> int - CallTipSetHighlight(int start, int end) + CallTipSetHighlight(self, int start, int end) - CallTipSetBackground(Colour back) + CallTipSetBackground(self, Colour back) - CallTipSetForeground(Colour fore) + CallTipSetForeground(self, Colour fore) - CallTipSetForegroundHighlight(Colour fore) + CallTipSetForegroundHighlight(self, Colour fore) - VisibleFromDocLine(int line) -> int + VisibleFromDocLine(self, int line) -> int - DocLineFromVisible(int lineDisplay) -> int + DocLineFromVisible(self, int lineDisplay) -> int - SetFoldLevel(int line, int level) + SetFoldLevel(self, int line, int level) - GetFoldLevel(int line) -> int + GetFoldLevel(self, int line) -> int - GetLastChild(int line, int level) -> int + GetLastChild(self, int line, int level) -> int - GetFoldParent(int line) -> int + GetFoldParent(self, int line) -> int - ShowLines(int lineStart, int lineEnd) + ShowLines(self, int lineStart, int lineEnd) - HideLines(int lineStart, int lineEnd) + HideLines(self, int lineStart, int lineEnd) - GetLineVisible(int line) -> bool + GetLineVisible(self, int line) -> bool - SetFoldExpanded(int line, bool expanded) + SetFoldExpanded(self, int line, bool expanded) - GetFoldExpanded(int line) -> bool + GetFoldExpanded(self, int line) -> bool - ToggleFold(int line) + ToggleFold(self, int line) - EnsureVisible(int line) + EnsureVisible(self, int line) - SetFoldFlags(int flags) + SetFoldFlags(self, int flags) - EnsureVisibleEnforcePolicy(int line) + EnsureVisibleEnforcePolicy(self, int line) - SetTabIndents(bool tabIndents) + SetTabIndents(self, bool tabIndents) - GetTabIndents() -> bool + GetTabIndents(self) -> bool - SetBackSpaceUnIndents(bool bsUnIndents) + SetBackSpaceUnIndents(self, bool bsUnIndents) - GetBackSpaceUnIndents() -> bool + GetBackSpaceUnIndents(self) -> bool - SetMouseDwellTime(int periodMilliseconds) + SetMouseDwellTime(self, int periodMilliseconds) - GetMouseDwellTime() -> int + GetMouseDwellTime(self) -> int - WordStartPosition(int pos, bool onlyWordCharacters) -> int + WordStartPosition(self, int pos, bool onlyWordCharacters) -> int - WordEndPosition(int pos, bool onlyWordCharacters) -> int + WordEndPosition(self, int pos, bool onlyWordCharacters) -> int - SetWrapMode(int mode) + SetWrapMode(self, int mode) - GetWrapMode() -> int + GetWrapMode(self) -> int - SetLayoutCache(int mode) + SetLayoutCache(self, int mode) - GetLayoutCache() -> int + GetLayoutCache(self) -> int - SetScrollWidth(int pixelWidth) + SetScrollWidth(self, int pixelWidth) - GetScrollWidth() -> int + GetScrollWidth(self) -> int - TextWidth(int style, String text) -> int + TextWidth(self, int style, String text) -> int - SetEndAtLastLine(bool endAtLastLine) + SetEndAtLastLine(self, bool endAtLastLine) - GetEndAtLastLine() -> int + GetEndAtLastLine(self) -> int - TextHeight(int line) -> int + TextHeight(self, int line) -> int - SetUseVerticalScrollBar(bool show) + SetUseVerticalScrollBar(self, bool show) - GetUseVerticalScrollBar() -> bool + GetUseVerticalScrollBar(self) -> bool - AppendText(int length, String text) + AppendText(self, int length, String text) - GetTwoPhaseDraw() -> bool + GetTwoPhaseDraw(self) -> bool - SetTwoPhaseDraw(bool twoPhase) + SetTwoPhaseDraw(self, bool twoPhase) - TargetFromSelection() + TargetFromSelection(self) - LinesJoin() + LinesJoin(self) - LinesSplit(int pixelWidth) + LinesSplit(self, int pixelWidth) - SetFoldMarginColour(bool useSetting, Colour back) + SetFoldMarginColour(self, bool useSetting, Colour back) - SetFoldMarginHiColour(bool useSetting, Colour fore) + SetFoldMarginHiColour(self, bool useSetting, Colour fore) - LineDown() + LineDown(self) This is just a wrapper for ScrollLines(1). - LineDownExtend() + LineDownExtend(self) - LineUp() + LineUp(self) This is just a wrapper for ScrollLines(-1). - LineUpExtend() + LineUpExtend(self) - CharLeft() + CharLeft(self) - CharLeftExtend() + CharLeftExtend(self) - CharRight() + CharRight(self) - CharRightExtend() + CharRightExtend(self) - WordLeft() + WordLeft(self) - WordLeftExtend() + WordLeftExtend(self) - WordRight() + WordRight(self) - WordRightExtend() + WordRightExtend(self) - Home() + Home(self) - HomeExtend() + HomeExtend(self) - LineEnd() + LineEnd(self) - LineEndExtend() + LineEndExtend(self) - DocumentStart() + DocumentStart(self) - DocumentStartExtend() + DocumentStartExtend(self) - DocumentEnd() + DocumentEnd(self) - DocumentEndExtend() + DocumentEndExtend(self) - PageUp() + PageUp(self) This is just a wrapper for ScrollPages(-1). - PageUpExtend() + PageUpExtend(self) - PageDown() + PageDown(self) This is just a wrapper for ScrollPages(1). - PageDownExtend() + PageDownExtend(self) - EditToggleOvertype() + EditToggleOvertype(self) - Cancel() + Cancel(self) - DeleteBack() + DeleteBack(self) - Tab() + Tab(self) - BackTab() + BackTab(self) - NewLine() + NewLine(self) - FormFeed() + FormFeed(self) - VCHome() + VCHome(self) - VCHomeExtend() + VCHomeExtend(self) - ZoomIn() + ZoomIn(self) - ZoomOut() + ZoomOut(self) - DelWordLeft() + DelWordLeft(self) - DelWordRight() + DelWordRight(self) - LineCut() + LineCut(self) - LineDelete() + LineDelete(self) - LineTranspose() + LineTranspose(self) - LineDuplicate() + LineDuplicate(self) - LowerCase() + LowerCase(self) - UpperCase() + UpperCase(self) - LineScrollDown() + LineScrollDown(self) - LineScrollUp() + LineScrollUp(self) - DeleteBackNotLine() + DeleteBackNotLine(self) - HomeDisplay() + HomeDisplay(self) - HomeDisplayExtend() + HomeDisplayExtend(self) - LineEndDisplay() + LineEndDisplay(self) - LineEndDisplayExtend() + LineEndDisplayExtend(self) - HomeWrap() + HomeWrap(self) - HomeWrapExtend() + HomeWrapExtend(self) - LineEndWrap() + LineEndWrap(self) - LineEndWrapExtend() + LineEndWrapExtend(self) - VCHomeWrap() + VCHomeWrap(self) - VCHomeWrapExtend() + VCHomeWrapExtend(self) - LineCopy() + LineCopy(self) - MoveCaretInsideView() + MoveCaretInsideView(self) - LineLength(int line) -> int + LineLength(self, int line) -> int - BraceHighlight(int pos1, int pos2) + BraceHighlight(self, int pos1, int pos2) - BraceBadLight(int pos) + BraceBadLight(self, int pos) - BraceMatch(int pos) -> int + BraceMatch(self, int pos) -> int - GetViewEOL() -> bool + GetViewEOL(self) -> bool - SetViewEOL(bool visible) + SetViewEOL(self, bool visible) - GetDocPointer() -> void + GetDocPointer(self) -> void - SetDocPointer(void docPointer) + SetDocPointer(self, void docPointer) - SetModEventMask(int mask) + SetModEventMask(self, int mask) - GetEdgeColumn() -> int + GetEdgeColumn(self) -> int - SetEdgeColumn(int column) + SetEdgeColumn(self, int column) - GetEdgeMode() -> int + GetEdgeMode(self) -> int - SetEdgeMode(int mode) + SetEdgeMode(self, int mode) - GetEdgeColour() -> Colour + GetEdgeColour(self) -> Colour - SetEdgeColour(Colour edgeColour) + SetEdgeColour(self, Colour edgeColour) - SearchAnchor() + SearchAnchor(self) - SearchNext(int flags, String text) -> int + SearchNext(self, int flags, String text) -> int - SearchPrev(int flags, String text) -> int + SearchPrev(self, int flags, String text) -> int - LinesOnScreen() -> int + LinesOnScreen(self) -> int - UsePopUp(bool allowPopUp) + UsePopUp(self, bool allowPopUp) - SelectionIsRectangle() -> bool + SelectionIsRectangle(self) -> bool - SetZoom(int zoom) + SetZoom(self, int zoom) - GetZoom() -> int + GetZoom(self) -> int - CreateDocument() -> void + CreateDocument(self) -> void - AddRefDocument(void docPointer) + AddRefDocument(self, void docPointer) - ReleaseDocument(void docPointer) + ReleaseDocument(self, void docPointer) - GetModEventMask() -> int + GetModEventMask(self) -> int - SetSTCFocus(bool focus) + SetSTCFocus(self, bool focus) - GetSTCFocus() -> bool + GetSTCFocus(self) -> bool - SetStatus(int statusCode) + SetStatus(self, int statusCode) - GetStatus() -> int + GetStatus(self) -> int - SetMouseDownCaptures(bool captures) + SetMouseDownCaptures(self, bool captures) - GetMouseDownCaptures() -> bool + GetMouseDownCaptures(self) -> bool - SetSTCCursor(int cursorType) + SetSTCCursor(self, int cursorType) - GetSTCCursor() -> int + GetSTCCursor(self) -> int - SetControlCharSymbol(int symbol) + SetControlCharSymbol(self, int symbol) - GetControlCharSymbol() -> int + GetControlCharSymbol(self) -> int - WordPartLeft() + WordPartLeft(self) - WordPartLeftExtend() + WordPartLeftExtend(self) - WordPartRight() + WordPartRight(self) - WordPartRightExtend() + WordPartRightExtend(self) - SetVisiblePolicy(int visiblePolicy, int visibleSlop) + SetVisiblePolicy(self, int visiblePolicy, int visibleSlop) - DelLineLeft() + DelLineLeft(self) - DelLineRight() + DelLineRight(self) - SetXOffset(int newOffset) + SetXOffset(self, int newOffset) - GetXOffset() -> int + GetXOffset(self) -> int - ChooseCaretX() + ChooseCaretX(self) - SetXCaretPolicy(int caretPolicy, int caretSlop) + SetXCaretPolicy(self, int caretPolicy, int caretSlop) - SetYCaretPolicy(int caretPolicy, int caretSlop) + SetYCaretPolicy(self, int caretPolicy, int caretSlop) - SetPrintWrapMode(int mode) + SetPrintWrapMode(self, int mode) - GetPrintWrapMode() -> int + GetPrintWrapMode(self) -> int - SetHotspotActiveForeground(bool useSetting, Colour fore) + SetHotspotActiveForeground(self, bool useSetting, Colour fore) - SetHotspotActiveBackground(bool useSetting, Colour back) + SetHotspotActiveBackground(self, bool useSetting, Colour back) - SetHotspotActiveUnderline(bool underline) + SetHotspotActiveUnderline(self, bool underline) - SetHotspotSingleLine(bool singleLine) + SetHotspotSingleLine(self, bool singleLine) - ParaDown() + ParaDown(self) - ParaDownExtend() + ParaDownExtend(self) - ParaUp() + ParaUp(self) - ParaUpExtend() + ParaUpExtend(self) - PositionBefore(int pos) -> int + PositionBefore(self, int pos) -> int - PositionAfter(int pos) -> int + PositionAfter(self, int pos) -> int - CopyRange(int start, int end) + CopyRange(self, int start, int end) - CopyText(int length, String text) + CopyText(self, int length, String text) - SetSelectionMode(int mode) + SetSelectionMode(self, int mode) - GetSelectionMode() -> int + GetSelectionMode(self) -> int - GetLineSelStartPosition(int line) -> int + GetLineSelStartPosition(self, int line) -> int - GetLineSelEndPosition(int line) -> int + GetLineSelEndPosition(self, int line) -> int - LineDownRectExtend() + LineDownRectExtend(self) - LineUpRectExtend() + LineUpRectExtend(self) - CharLeftRectExtend() + CharLeftRectExtend(self) - CharRightRectExtend() + CharRightRectExtend(self) - HomeRectExtend() + HomeRectExtend(self) - VCHomeRectExtend() + VCHomeRectExtend(self) - LineEndRectExtend() + LineEndRectExtend(self) - PageUpRectExtend() + PageUpRectExtend(self) - PageDownRectExtend() + PageDownRectExtend(self) - StutteredPageUp() + StutteredPageUp(self) - StutteredPageUpExtend() + StutteredPageUpExtend(self) - StutteredPageDown() + StutteredPageDown(self) - StutteredPageDownExtend() + StutteredPageDownExtend(self) - WordLeftEnd() + WordLeftEnd(self) - WordLeftEndExtend() + WordLeftEndExtend(self) - WordRightEnd() + WordRightEnd(self) - WordRightEndExtend() + WordRightEndExtend(self) - SetWhitespaceChars(String characters) + SetWhitespaceChars(self, String characters) - SetCharsDefault() + SetCharsDefault(self) - AutoCompGetCurrent() -> int + AutoCompGetCurrent(self) -> int - StartRecord() + StartRecord(self) - StopRecord() + StopRecord(self) - SetLexer(int lexer) + SetLexer(self, int lexer) - GetLexer() -> int + GetLexer(self) -> int - Colourise(int start, int end) + Colourise(self, int start, int end) - SetProperty(String key, String value) + SetProperty(self, String key, String value) - SetKeyWords(int keywordSet, String keyWords) + SetKeyWords(self, int keywordSet, String keyWords) - SetLexerLanguage(String language) + SetLexerLanguage(self, String language) - GetCurrentLine() -> int + GetCurrentLine(self) -> int - StyleSetSpec(int styleNum, String spec) + StyleSetSpec(self, int styleNum, String spec) - StyleSetFont(int styleNum, Font font) + StyleSetFont(self, int styleNum, Font font) - StyleSetFontAttr(int styleNum, int size, String faceName, bool bold, + StyleSetFontAttr(self, int styleNum, int size, String faceName, bool bold, bool italic, bool underline) @@ -36240,45 +39610,45 @@ ControlPoint = PyControlPoint - CmdKeyExecute(int cmd) + CmdKeyExecute(self, int cmd) - SetMargins(int left, int right) + SetMargins(self, int left, int right) - GetSelection(int OUTPUT, int OUTPUT) + GetSelection(self, int OUTPUT, int OUTPUT) - PointFromPosition(int pos) -> Point + PointFromPosition(self, int pos) -> Point - ScrollToLine(int line) + ScrollToLine(self, int line) - ScrollToColumn(int column) + ScrollToColumn(self, int column) - SendMsg(int msg, long wp=0, long lp=0) -> long + SendMsg(self, int msg, long wp=0, long lp=0) -> long @@ -36286,40 +39656,40 @@ ControlPoint = PyControlPoint - SetVScrollBar(wxScrollBar bar) + SetVScrollBar(self, wxScrollBar bar) - SetHScrollBar(wxScrollBar bar) + SetHScrollBar(self, wxScrollBar bar) - GetLastKeydownProcessed() -> bool + GetLastKeydownProcessed(self) -> bool - SetLastKeydownProcessed(bool val) + SetLastKeydownProcessed(self, bool val) - SaveFile(String filename) -> bool + SaveFile(self, String filename) -> bool - LoadFile(String filename) -> bool + LoadFile(self, String filename) -> bool - DoDragOver(int x, int y, int def) -> int + DoDragOver(self, int x, int y, int def) -> int @@ -36327,7 +39697,7 @@ ControlPoint = PyControlPoint - DoDropText(long x, long y, String data) -> bool + DoDropText(self, long x, long y, String data) -> bool @@ -36335,218 +39705,218 @@ ControlPoint = PyControlPoint - SetUseAntiAliasing(bool useAA) + SetUseAntiAliasing(self, bool useAA) - GetUseAntiAliasing() -> bool + GetUseAntiAliasing(self) -> bool - __init__(wxEventType commandType=0, int id=0) -> StyledTextEvent + __init__(self, wxEventType commandType=0, int id=0) -> StyledTextEvent - __del__() + __del__(self) - SetPosition(int pos) + SetPosition(self, int pos) - SetKey(int k) + SetKey(self, int k) - SetModifiers(int m) + SetModifiers(self, int m) - SetModificationType(int t) + SetModificationType(self, int t) - SetText(String t) + SetText(self, String t) - SetLength(int len) + SetLength(self, int len) - SetLinesAdded(int num) + SetLinesAdded(self, int num) - SetLine(int val) + SetLine(self, int val) - SetFoldLevelNow(int val) + SetFoldLevelNow(self, int val) - SetFoldLevelPrev(int val) + SetFoldLevelPrev(self, int val) - SetMargin(int val) + SetMargin(self, int val) - SetMessage(int val) + SetMessage(self, int val) - SetWParam(int val) + SetWParam(self, int val) - SetLParam(int val) + SetLParam(self, int val) - SetListType(int val) + SetListType(self, int val) - SetX(int val) + SetX(self, int val) - SetY(int val) + SetY(self, int val) - SetDragText(String val) + SetDragText(self, String val) - SetDragAllowMove(bool val) + SetDragAllowMove(self, bool val) - SetDragResult(int val) + SetDragResult(self, int val) - GetPosition() -> int + GetPosition(self) -> int - GetKey() -> int + GetKey(self) -> int - GetModifiers() -> int + GetModifiers(self) -> int - GetModificationType() -> int + GetModificationType(self) -> int - GetText() -> String + GetText(self) -> String - GetLength() -> int + GetLength(self) -> int - GetLinesAdded() -> int + GetLinesAdded(self) -> int - GetLine() -> int + GetLine(self) -> int - GetFoldLevelNow() -> int + GetFoldLevelNow(self) -> int - GetFoldLevelPrev() -> int + GetFoldLevelPrev(self) -> int - GetMargin() -> int + GetMargin(self) -> int - GetMessage() -> int + GetMessage(self) -> int - GetWParam() -> int + GetWParam(self) -> int - GetLParam() -> int + GetLParam(self) -> int - GetListType() -> int + GetListType(self) -> int - GetX() -> int + GetX(self) -> int - GetY() -> int + GetY(self) -> int - GetDragText() -> String + GetDragText(self) -> String - GetDragAllowMove() -> bool + GetDragAllowMove(self) -> bool - GetDragResult() -> int + GetDragResult(self) -> int - GetShift() -> bool + GetShift(self) -> bool - GetControl() -> bool + GetControl(self) -> bool - GetAlt() -> bool + GetAlt(self) -> bool - Clone() -> Event + Clone(self) -> Event @@ -36563,7 +39933,6 @@ EVT_STC_MODIFIED = wx.PyEventBinder( wxEVT_STC_MODIFIED, 1 ) 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 ) @@ -36579,15 +39948,16 @@ EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) - - wx = core + + wx = _core + __docfilter__ = wx.__DocFilter(globals()) #--------------------------------------------------------------------------- - __init__(String filemask, int flags=XRC_USE_LOCALE) -> XmlResource + __init__(self, String filemask, int flags=XRC_USE_LOCALE) -> XmlResource @@ -36600,37 +39970,37 @@ EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) - __del__() + __del__(self) - Load(String filemask) -> bool + Load(self, String filemask) -> bool - LoadFromString(String data) -> bool + LoadFromString(self, String data) -> bool - InitAllHandlers() + InitAllHandlers(self) - AddHandler(XmlResourceHandler handler) + AddHandler(self, XmlResourceHandler handler) - InsertHandler(XmlResourceHandler handler) + InsertHandler(self, XmlResourceHandler handler) - ClearHandlers() + ClearHandlers(self) AddSubclassFactory(XmlSubclassFactory factory) @@ -36639,40 +40009,40 @@ EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) - LoadMenu(String name) -> Menu + LoadMenu(self, String name) -> Menu - LoadMenuBar(String name) -> MenuBar + LoadMenuBar(self, String name) -> MenuBar - LoadMenuBarOnFrame(Window parent, String name) -> MenuBar + LoadMenuBarOnFrame(self, Window parent, String name) -> MenuBar - LoadToolBar(Window parent, String name) -> wxToolBar + LoadToolBar(self, Window parent, String name) -> wxToolBar - LoadDialog(Window parent, String name) -> wxDialog + LoadDialog(self, Window parent, String name) -> wxDialog - LoadOnDialog(wxDialog dlg, Window parent, String name) -> bool + LoadOnDialog(self, wxDialog dlg, Window parent, String name) -> bool @@ -36680,14 +40050,14 @@ EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) - LoadPanel(Window parent, String name) -> wxPanel + LoadPanel(self, Window parent, String name) -> wxPanel - LoadOnPanel(wxPanel panel, Window parent, String name) -> bool + LoadOnPanel(self, wxPanel panel, Window parent, String name) -> bool @@ -36695,14 +40065,14 @@ EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) - LoadFrame(Window parent, String name) -> wxFrame + LoadFrame(self, Window parent, String name) -> wxFrame - LoadOnFrame(wxFrame frame, Window parent, String name) -> bool + LoadOnFrame(self, wxFrame frame, Window parent, String name) -> bool @@ -36710,7 +40080,7 @@ EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) - LoadObject(Window parent, String name, String classname) -> Object + LoadObject(self, Window parent, String name, String classname) -> Object @@ -36718,7 +40088,7 @@ EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) - LoadOnObject(Object instance, Window parent, String name, String classname) -> bool + LoadOnObject(self, Object instance, Window parent, String name, String classname) -> bool @@ -36727,19 +40097,19 @@ EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) - LoadBitmap(String name) -> Bitmap + LoadBitmap(self, String name) -> Bitmap - LoadIcon(String name) -> Icon + LoadIcon(self, String name) -> Icon - AttachUnknownControl(String name, Window control, Window parent=None) -> bool + AttachUnknownControl(self, String name, Window control, Window parent=None) -> bool @@ -36753,10 +40123,10 @@ EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) - GetVersion() -> long + GetVersion(self) -> long - CompareVersion(int major, int minor, int release, int revision) -> int + CompareVersion(self, int major, int minor, int release, int revision) -> int @@ -36774,10 +40144,10 @@ EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) - GetFlags() -> int + GetFlags(self) -> int - SetFlags(int flags) + SetFlags(self, int flags) @@ -36795,10 +40165,10 @@ def XRCCTRL(window, str_id, *ignoreargs): - __init__() -> XmlSubclassFactory + __init__(self) -> XmlSubclassFactory - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) @@ -36810,7 +40180,7 @@ def XRCCTRL(window, str_id, *ignoreargs): - __init__(String name=EmptyString, String value=EmptyString, + __init__(self, String name=EmptyString, String value=EmptyString, XmlProperty next=None) -> XmlProperty @@ -36819,28 +40189,28 @@ def XRCCTRL(window, str_id, *ignoreargs): - GetName() -> String + GetName(self) -> String - GetValue() -> String + GetValue(self) -> String - GetNext() -> XmlProperty + GetNext(self) -> XmlProperty - SetName(String name) + SetName(self, String name) - SetValue(String value) + SetValue(self, String value) - SetNext(XmlProperty next) + SetNext(self, XmlProperty next) @@ -36848,7 +40218,7 @@ def XRCCTRL(window, str_id, *ignoreargs): - __init__(XmlNode parent=None, int type=0, String name=EmptyString, + __init__(self, XmlNode parent=None, int type=0, String name=EmptyString, String content=EmptyString, XmlProperty props=None, XmlNode next=None) -> XmlNode @@ -36869,118 +40239,118 @@ def XRCCTRL(window, str_id, *ignoreargs): - __del__() + __del__(self) - AddChild(XmlNode child) + AddChild(self, XmlNode child) - InsertChild(XmlNode child, XmlNode before_node) + InsertChild(self, XmlNode child, XmlNode before_node) - RemoveChild(XmlNode child) -> bool + RemoveChild(self, XmlNode child) -> bool - AddProperty(XmlProperty prop) + AddProperty(self, XmlProperty prop) - AddPropertyName(String name, String value) + AddPropertyName(self, String name, String value) - DeleteProperty(String name) -> bool + DeleteProperty(self, String name) -> bool - GetType() -> int + GetType(self) -> int - GetName() -> String + GetName(self) -> String - GetContent() -> String + GetContent(self) -> String - GetParent() -> XmlNode + GetParent(self) -> XmlNode - GetNext() -> XmlNode + GetNext(self) -> XmlNode - GetChildren() -> XmlNode + GetChildren(self) -> XmlNode - GetProperties() -> XmlProperty + GetProperties(self) -> XmlProperty - GetPropVal(String propName, String defaultVal) -> String + GetPropVal(self, String propName, String defaultVal) -> String - HasProp(String propName) -> bool + HasProp(self, String propName) -> bool - SetType(int type) + SetType(self, int type) - SetName(String name) + SetName(self, String name) - SetContent(String con) + SetContent(self, String con) - SetParent(XmlNode parent) + SetParent(self, XmlNode parent) - SetNext(XmlNode next) + SetNext(self, XmlNode next) - SetChildren(XmlNode child) + SetChildren(self, XmlNode child) - SetProperties(XmlProperty prop) + SetProperties(self, XmlProperty prop) @@ -36989,7 +40359,7 @@ def XRCCTRL(window, str_id, *ignoreargs): - __init__(String filename, String encoding=UTF8String) -> XmlDocument + __init__(self, String filename, String encoding=UTF8String) -> XmlDocument @@ -37006,60 +40376,60 @@ def XRCCTRL(window, str_id, *ignoreargs): EmptyXmlDocument() -> XmlDocument - __del__() + __del__(self) - Load(String filename, String encoding=UTF8String) -> bool + Load(self, String filename, String encoding=UTF8String) -> bool - LoadFromStream(InputStream stream, String encoding=UTF8String) -> bool + LoadFromStream(self, InputStream stream, String encoding=UTF8String) -> bool - Save(String filename) -> bool + Save(self, String filename) -> bool - SaveToStream(OutputStream stream) -> bool + SaveToStream(self, OutputStream stream) -> bool - IsOk() -> bool + IsOk(self) -> bool - GetRoot() -> XmlNode + GetRoot(self) -> XmlNode - GetVersion() -> String + GetVersion(self) -> String - GetFileEncoding() -> String + GetFileEncoding(self) -> String - SetRoot(XmlNode node) + SetRoot(self, XmlNode node) - SetVersion(String version) + SetVersion(self, String version) - SetFileEncoding(String encoding) + SetFileEncoding(self, String encoding) @@ -37071,17 +40441,17 @@ def XRCCTRL(window, str_id, *ignoreargs): - __init__() -> XmlResourceHandler + __init__(self) -> XmlResourceHandler - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - CreateResource(XmlNode node, Object parent, Object instance) -> Object + CreateResource(self, XmlNode node, Object parent, Object instance) -> Object @@ -37089,134 +40459,134 @@ def XRCCTRL(window, str_id, *ignoreargs): - SetParentResource(XmlResource res) + SetParentResource(self, XmlResource res) - GetResource() -> XmlResource + GetResource(self) -> XmlResource - GetNode() -> XmlNode + GetNode(self) -> XmlNode - GetClass() -> String + GetClass(self) -> String - GetParent() -> Object + GetParent(self) -> Object - GetInstance() -> Object + GetInstance(self) -> Object - GetParentAsWindow() -> Window + GetParentAsWindow(self) -> Window - GetInstanceAsWindow() -> Window + GetInstanceAsWindow(self) -> Window - IsOfClass(XmlNode node, String classname) -> bool + IsOfClass(self, XmlNode node, String classname) -> bool - GetNodeContent(XmlNode node) -> String + GetNodeContent(self, XmlNode node) -> String - HasParam(String param) -> bool + HasParam(self, String param) -> bool - GetParamNode(String param) -> XmlNode + GetParamNode(self, String param) -> XmlNode - GetParamValue(String param) -> String + GetParamValue(self, String param) -> String - AddStyle(String name, int value) + AddStyle(self, String name, int value) - AddWindowStyles() + AddWindowStyles(self) - GetStyle(String param=StyleString, int defaults=0) -> int + GetStyle(self, String param=StyleString, int defaults=0) -> int - GetText(String param, bool translate=True) -> String + GetText(self, String param, bool translate=True) -> String - GetID() -> int + GetID(self) -> int - GetName() -> String + GetName(self) -> String - GetBool(String param, bool defaultv=False) -> bool + GetBool(self, String param, bool defaultv=False) -> bool - GetLong(String param, long defaultv=0) -> long + GetLong(self, String param, long defaultv=0) -> long - GetColour(String param) -> Colour + GetColour(self, String param) -> Colour - GetSize(String param=SizeString) -> Size + GetSize(self, String param=SizeString) -> Size - GetPosition(String param=PosString) -> Point + GetPosition(self, String param=PosString) -> Point - GetDimension(String param, int defaultv=0) -> int + GetDimension(self, String param, int defaultv=0) -> int - GetBitmap(String param=BitmapString, wxArtClient defaultArtClient=wxART_OTHER, + GetBitmap(self, String param=BitmapString, wxArtClient defaultArtClient=wxART_OTHER, Size size=DefaultSize) -> Bitmap @@ -37225,7 +40595,7 @@ def XRCCTRL(window, str_id, *ignoreargs): - GetIcon(String param=IconString, wxArtClient defaultArtClient=wxART_OTHER, + GetIcon(self, String param=IconString, wxArtClient defaultArtClient=wxART_OTHER, Size size=DefaultSize) -> Icon @@ -37234,33 +40604,33 @@ def XRCCTRL(window, str_id, *ignoreargs): - GetFont(String param=FontString) -> Font + GetFont(self, String param=FontString) -> Font - SetupWindow(Window wnd) + SetupWindow(self, Window wnd) - CreateChildren(Object parent, bool this_hnd_only=False) + CreateChildren(self, Object parent, bool this_hnd_only=False) - CreateChildrenPrivately(Object parent, XmlNode rootnode=None) + CreateChildrenPrivately(self, Object parent, XmlNode rootnode=None) - CreateResFromNode(XmlNode node, Object parent, Object instance=None) -> Object + CreateResFromNode(self, XmlNode node, Object parent, Object instance=None) -> Object @@ -37268,7 +40638,7 @@ def XRCCTRL(window, str_id, *ignoreargs): - GetCurFileSystem() -> FileSystem + GetCurFileSystem(self) -> FileSystem #---------------------------------------------------------------------------- @@ -37310,13 +40680,14 @@ XmlResource_AddSubclassFactory(XmlSubclassFactory_Python()) - - - wx = core + + + import wx + __docfilter__ = wx._core.__DocFilter(globals()) - __init__(Object target) -> DynamicSashSplitEvent + __init__(self, Object target) -> DynamicSashSplitEvent @@ -37325,7 +40696,7 @@ XmlResource_AddSubclassFactory(XmlSubclassFactory_Python()) - __init__(Object target) -> DynamicSashUnifyEvent + __init__(self, Object target) -> DynamicSashUnifyEvent @@ -37334,12 +40705,12 @@ XmlResource_AddSubclassFactory(XmlSubclassFactory_Python()) - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER, + __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 - + @@ -37350,12 +40721,12 @@ XmlResource_AddSubclassFactory(XmlSubclassFactory_Python()) PreDynamicSashWindow() -> DynamicSashWindow - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER, + 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 - + @@ -37363,13 +40734,13 @@ XmlResource_AddSubclassFactory(XmlSubclassFactory_Python()) - GetHScrollBar(Window child) -> ScrollBar + GetHScrollBar(self, Window child) -> ScrollBar - GetVScrollBar(Window child) -> ScrollBar + GetVScrollBar(self, Window child) -> ScrollBar @@ -37382,13 +40753,14 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE, + __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 - - + + @@ -37396,37 +40768,37 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - SetStrings(wxArrayString strings) + SetStrings(self, wxArrayString strings) - GetStrings() -> PyObject + GetStrings(self) -> PyObject - - GetListCtrl() -> wxListCtrl + + GetListCtrl(self) -> ListCtrl - GetDelButton() -> BitmapButton + GetDelButton(self) -> BitmapButton - GetNewButton() -> BitmapButton + GetNewButton(self) -> BitmapButton - GetUpButton() -> BitmapButton + GetUpButton(self) -> BitmapButton - GetDownButton() -> BitmapButton + GetDownButton(self) -> BitmapButton - GetEditButton() -> BitmapButton + GetEditButton(self) -> BitmapButton - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, long style=TR_HAS_BUTTONS) -> RemotelyScrolledTreeCtrl @@ -37437,35 +40809,35 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - HideVScrollbar() + HideVScrollbar(self) - AdjustRemoteScrollbars() + AdjustRemoteScrollbars(self) - GetScrolledWindow() -> ScrolledWindow + GetScrolledWindow(self) -> ScrolledWindow - ScrollToLine(int posHoriz, int posVert) + ScrollToLine(self, int posHoriz, int posVert) - SetCompanionWindow(Window companion) + SetCompanionWindow(self, Window companion) - GetCompanionWindow() -> Window + GetCompanionWindow(self) -> Window - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=0) -> TreeCompanionWindow @@ -37476,17 +40848,17 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - GetTreeCtrl() -> RemotelyScrolledTreeCtrl + GetTreeCtrl(self) -> RemotelyScrolledTreeCtrl - SetTreeCtrl(RemotelyScrolledTreeCtrl treeCtrl) + SetTreeCtrl(self, RemotelyScrolledTreeCtrl treeCtrl) @@ -37495,7 +40867,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxSP_3D|wxCLIP_CHILDREN) -> ThinSplitterWindow @@ -37509,7 +40881,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=0) -> SplitterScrolledWindow @@ -37523,7 +40895,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -> LEDNumberCtrl @@ -37537,7 +40909,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) PreLEDNumberCtrl() -> LEDNumberCtrl - Create(Window parent, int id=-1, Point pos=DefaultPosition, + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -> bool @@ -37548,89 +40920,100 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - GetAlignment() -> int + GetAlignment(self) -> int - GetDrawFaded() -> bool + GetDrawFaded(self) -> bool - GetValue() -> String + GetValue(self) -> String - SetAlignment(int Alignment, bool Redraw=true) + SetAlignment(self, int Alignment, bool Redraw=true) - SetDrawFaded(bool DrawFaded, bool Redraw=true) + SetDrawFaded(self, bool DrawFaded, bool Redraw=true) - SetValue(String Value, bool Redraw=true) + SetValue(self, String Value, bool Redraw=true) + wx.TR_DONT_ADJUST_MAC = TR_DONT_ADJUST_MAC - __init__(String text=EmptyString, int image=-1, size_t width=100, - int alignment=TL_ALIGN_LEFT) -> TreeListColumnInfo + __init__(self, String text=EmptyString, int image=-1, size_t width=100, + bool shown=True, int alignment=TL_ALIGN_LEFT) -> TreeListColumnInfo + + + GetShown(self) -> bool + - GetAlignment() -> int + GetAlignment(self) -> int - GetText() -> String + GetText(self) -> String - GetImage() -> int + GetImage(self) -> int - GetSelectedImage() -> int + GetSelectedImage(self) -> int - GetWidth() -> size_t + GetWidth(self) -> size_t + + + SetShown(self, bool shown) + + + - SetAlignment(int alignment) + SetAlignment(self, int alignment) - SetText(String text) + SetText(self, String text) - SetImage(int image) + SetImage(self, int image) - SetSelectedImage(int image) + SetSelectedImage(self, int image) - SetWidth(size_t with) + SetWidth(self, size_t with) @@ -37639,7 +41022,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - __init__(Window parent, int id=-1, Point pos=DefaultPosition, + __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 @@ -37657,7 +41040,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) PreTreeListCtrl() -> TreeListCtrl - Create(Window parent, int id=-1, Point pos=DefaultPosition, + 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 @@ -37673,205 +41056,209 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - _setCallbackInfo(PyObject self, PyObject _class) + _setCallbackInfo(self, PyObject self, PyObject _class) - GetCount() -> size_t + GetCount(self) -> size_t - GetIndent() -> unsigned int + GetIndent(self) -> unsigned int - SetIndent(unsigned int indent) + SetIndent(self, unsigned int indent) - - GetSpacing() -> unsigned int - - - SetSpacing(unsigned int spacing) - - - - - GetLineSpacing() -> unsigned int + GetLineSpacing(self) -> unsigned int - SetLineSpacing(unsigned int spacing) + SetLineSpacing(self, unsigned int spacing) - GetImageList() -> ImageList + GetImageList(self) -> ImageList - GetStateImageList() -> ImageList + GetStateImageList(self) -> ImageList - GetButtonsImageList() -> ImageList + GetButtonsImageList(self) -> ImageList - SetImageList(ImageList imageList) + SetImageList(self, ImageList imageList) - SetStateImageList(ImageList imageList) + SetStateImageList(self, ImageList imageList) - SetButtonsImageList(ImageList imageList) + SetButtonsImageList(self, ImageList imageList) - AssignImageList(ImageList imageList) + AssignImageList(self, ImageList imageList) - AssignStateImageList(ImageList imageList) + AssignStateImageList(self, ImageList imageList) - AssignButtonsImageList(ImageList imageList) + AssignButtonsImageList(self, ImageList imageList) - AddColumn(String text) + AddColumn(self, String text) - AddColumnInfo(TreeListColumnInfo col) + AddColumnInfo(self, TreeListColumnInfo col) - InsertColumn(size_t before, String text) + InsertColumn(self, size_t before, String text) - InsertColumnInfo(size_t before, TreeListColumnInfo col) + InsertColumnInfo(self, size_t before, TreeListColumnInfo col) - RemoveColumn(size_t column) + RemoveColumn(self, size_t column) - GetColumnCount() -> size_t + GetColumnCount(self) -> size_t - SetColumnWidth(size_t column, size_t width) + SetColumnWidth(self, size_t column, size_t width) - GetColumnWidth(size_t column) -> int + GetColumnWidth(self, size_t column) -> int - SetMainColumn(size_t column) + SetMainColumn(self, size_t column) - GetMainColumn() -> size_t + GetMainColumn(self) -> size_t - SetColumnText(size_t column, String text) + SetColumnText(self, size_t column, String text) - GetColumnText(size_t column) -> String + GetColumnText(self, size_t column) -> String - SetColumn(size_t column, TreeListColumnInfo info) + SetColumn(self, size_t column, TreeListColumnInfo info) - GetColumn(size_t column) -> TreeListColumnInfo + GetColumn(self, size_t column) -> TreeListColumnInfo - SetColumnAlignment(size_t column, int align) + SetColumnAlignment(self, size_t column, int align) - GetColumnAlignment(size_t column) -> int + GetColumnAlignment(self, size_t column) -> int - SetColumnImage(size_t column, int image) + SetColumnImage(self, size_t column, int image) - GetColumnImage(size_t column) -> int + GetColumnImage(self, size_t column) -> int + + + + + + ShowColumn(self, size_t column, bool shown) + + + + + + + IsColumnShown(self, size_t column) -> bool - GetItemText(TreeItemId item, int column=-1) -> String + GetItemText(self, TreeItemId item, int column=-1) -> String - GetItemImage(TreeItemId item, int column=-1, int which=TreeItemIcon_Normal) -> int + GetItemImage(self, TreeItemId item, int column=-1, int which=TreeItemIcon_Normal) -> int @@ -37879,7 +41266,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - SetItemText(TreeItemId item, String text, int column=-1) + SetItemText(self, TreeItemId item, String text, int column=-1) @@ -37887,7 +41274,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - SetItemImage(TreeItemId item, int image, int column=-1, int which=TreeItemIcon_Normal) + SetItemImage(self, TreeItemId item, int image, int column=-1, int which=TreeItemIcon_Normal) @@ -37896,196 +41283,196 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - GetItemData(TreeItemId item) -> TreeItemData + GetItemData(self, TreeItemId item) -> TreeItemData - SetItemData(TreeItemId item, TreeItemData data) + SetItemData(self, TreeItemId item, TreeItemData data) - GetItemPyData(TreeItemId item) -> PyObject + GetItemPyData(self, TreeItemId item) -> PyObject - SetItemPyData(TreeItemId item, PyObject obj) + SetItemPyData(self, TreeItemId item, PyObject obj) - SetItemHasChildren(TreeItemId item, bool has=True) + SetItemHasChildren(self, TreeItemId item, bool has=True) - SetItemBold(TreeItemId item, bool bold=True) + SetItemBold(self, TreeItemId item, bool bold=True) - SetItemTextColour(TreeItemId item, Colour col) + SetItemTextColour(self, TreeItemId item, Colour colour) - + - SetItemBackgroundColour(TreeItemId item, Colour col) + SetItemBackgroundColour(self, TreeItemId item, Colour colour) - + - SetItemFont(TreeItemId item, Font font) + SetItemFont(self, TreeItemId item, Font font) - GetItemBold(TreeItemId item) -> bool + GetItemBold(self, TreeItemId item) -> bool - GetItemTextColour(TreeItemId item) -> Colour + GetItemTextColour(self, TreeItemId item) -> Colour - GetItemBackgroundColour(TreeItemId item) -> Colour + GetItemBackgroundColour(self, TreeItemId item) -> Colour - GetItemFont(TreeItemId item) -> Font + GetItemFont(self, TreeItemId item) -> Font - IsVisible(TreeItemId item) -> bool + IsVisible(self, TreeItemId item) -> bool - ItemHasChildren(TreeItemId item) -> bool + ItemHasChildren(self, TreeItemId item) -> bool - IsExpanded(TreeItemId item) -> bool + IsExpanded(self, TreeItemId item) -> bool - IsSelected(TreeItemId item) -> bool + IsSelected(self, TreeItemId item) -> bool - IsBold(TreeItemId item) -> bool + IsBold(self, TreeItemId item) -> bool - GetChildrenCount(TreeItemId item, bool recursively=True) -> size_t + GetChildrenCount(self, TreeItemId item, bool recursively=True) -> size_t - GetRootItem() -> TreeItemId + GetRootItem(self) -> TreeItemId - GetSelection() -> TreeItemId + GetSelection(self) -> TreeItemId - GetSelections() -> PyObject + GetSelections(self) -> PyObject - GetItemParent(TreeItemId item) -> TreeItemId + GetItemParent(self, TreeItemId item) -> TreeItemId - GetFirstChild(TreeItemId item) -> PyObject + GetFirstChild(self, TreeItemId item) -> PyObject - GetNextChild(TreeItemId item, long cookie) -> PyObject + GetNextChild(self, TreeItemId item, void cookie) -> PyObject - + - GetLastChild(TreeItemId item) -> TreeItemId + GetLastChild(self, TreeItemId item) -> TreeItemId - GetNextSibling(TreeItemId item) -> TreeItemId + GetNextSibling(self, TreeItemId item) -> TreeItemId - GetPrevSibling(TreeItemId item) -> TreeItemId + GetPrevSibling(self, TreeItemId item) -> TreeItemId - GetFirstVisibleItem() -> TreeItemId + GetFirstVisibleItem(self) -> TreeItemId - GetNextVisible(TreeItemId item) -> TreeItemId + GetNextVisible(self, TreeItemId item) -> TreeItemId - GetPrevVisible(TreeItemId item) -> TreeItemId + GetPrevVisible(self, TreeItemId item) -> TreeItemId - GetNext(TreeItemId item) -> TreeItemId + GetNext(self, TreeItemId item) -> TreeItemId - AddRoot(String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId + AddRoot(self, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId @@ -38094,7 +41481,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - PrependItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1, + PrependItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId @@ -38105,7 +41492,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - InsertItem(TreeItemId parent, TreeItemId idPrevious, String text, + InsertItem(self, TreeItemId parent, TreeItemId idPrevious, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId @@ -38117,7 +41504,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - InsertItemBefore(TreeItemId parent, size_t index, String text, int image=-1, + InsertItemBefore(self, TreeItemId parent, size_t index, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId @@ -38129,7 +41516,7 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - AppendItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1, + AppendItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId @@ -38140,78 +41527,84 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - Delete(TreeItemId item) + Delete(self, TreeItemId item) - DeleteChildren(TreeItemId item) + DeleteChildren(self, TreeItemId item) - DeleteAllItems() + DeleteAllItems(self) - Expand(TreeItemId item) + Expand(self, TreeItemId item) - ExpandAll(TreeItemId item) + ExpandAll(self, TreeItemId item) - Collapse(TreeItemId item) + Collapse(self, TreeItemId item) - CollapseAndReset(TreeItemId item) + CollapseAndReset(self, TreeItemId item) - Toggle(TreeItemId item) + Toggle(self, TreeItemId item) - Unselect() + Unselect(self) - UnselectAll() + UnselectAll(self) - SelectItem(TreeItemId item, bool unselect_others=True, bool extended_select=False) + SelectItem(self, TreeItemId item, bool unselect_others=True, bool extended_select=False) + + SelectAll(self, bool extended_select=False) + + + + - EnsureVisible(TreeItemId item) + EnsureVisible(self, TreeItemId item) - ScrollTo(TreeItemId item) + ScrollTo(self, TreeItemId item) - HitTest(Point point, int OUTPUT, int OUTPUT) -> TreeItemId + HitTest(self, Point point, int OUTPUT, int OUTPUT) -> TreeItemId @@ -38219,48 +41612,43 @@ EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) - GetBoundingRect(TreeItemId item, bool textOnly=False) -> PyObject + GetBoundingRect(self, TreeItemId item, bool textOnly=False) -> PyObject - EditLabel(TreeItemId item) + EditLabel(self, TreeItemId item) - Edit(TreeItemId item) + Edit(self, TreeItemId item) - SortChildren(TreeItemId item) + SortChildren(self, TreeItemId item) - - GetItemSelectedImage(TreeItemId item) -> int + + FindItem(self, TreeItemId item, String str, int flags=0) -> TreeItemId - - - - SetItemSelectedImage(TreeItemId item, int image) - - - + + - GetHeaderWindow() -> Window + GetHeaderWindow(self) -> Window - - GetMainWindow() -> Window + + GetMainWindow(self) -> ScrolledWindow