X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0f43fbdf6fa41ccf61bf0094529fc6c350ba34af..c1c4cf8924da3ca6e06021cf78becb846cf3539f:/wxPython/docs/xml/wxPython-metadata.xml diff --git a/wxPython/docs/xml/wxPython-metadata.xml b/wxPython/docs/xml/wxPython-metadata.xml index 8b17a3efd3..eb25717942 100644 --- a/wxPython/docs/xml/wxPython-metadata.xml +++ b/wxPython/docs/xml/wxPython-metadata.xml @@ -1,988 +1,1023 @@ - + - - + + #// 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 + + 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. - - - Destroy() - Deletes the C++ object this Python object is a proxy for. - - - + + GetClassName(self) -> String + Returns the class name of the C++ class using wxRTTI. + + + Destroy(self) + Deletes the C++ object this Python object is a proxy for. + + + #--------------------------------------------------------------------------- - + #--------------------------------------------------------------------------- - - 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 - Creates a size object. - - - - - - - __del__() - - - - - __eq__(Size sz) -> bool - Test for equality of wx.Size objects. - - - - - - __ne__(Size sz) -> bool - Test for inequality. - - - - - - __add__(Size sz) -> Size - Add sz's proprties to this and return the result. - - - - - - __sub__(Size sz) -> Size - Subtract sz's properties from this and return the result. - - - - - - IncTo(Size sz) - Increments this object so that both of its dimensions are not less + + 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__(self, int w=0, int h=0) -> Size + Creates a size object. + + + + + + + __del__(self) + + + + + __eq__(self, Size sz) -> bool + Test for equality of wx.Size objects. + + + + + + __ne__(self, Size sz) -> bool + Test for inequality. + + + + + + __add__(self, Size sz) -> Size + Add sz's proprties to this and return the result. + + + + + + __sub__(self, Size sz) -> Size + Subtract sz's properties from this and return the result. + + + + + + IncTo(self, Size sz) + Increments this object so that both of its dimensions are not less than the corresponding dimensions of the size. - - - - - - DecTo(Size sz) - Decrements this object so that both of its dimensions are not greater + + + + + + DecTo(self, Size sz) + Decrements this object so that both of its dimensions are not greater than the corresponding dimensions of the size. - - - - - - Set(int w, int h) - Set both width and height. - - - - - - - SetWidth(int w) - - - - - - SetHeight(int h) - - - - - - GetWidth() -> int - - - GetHeight() -> int - - - Get() -> (width,height) - Returns the width and height properties as a tuple. - - - + + + + + + Set(self, int w, int h) + Set both width and height. + + + + + + + SetWidth(self, int w) + + + + + + SetHeight(self, int h) + + + + + + GetWidth(self) -> 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) + Returns the width and height properties as a 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 - Create a wx.RealPoint object - - - - - - - __del__() - - - - - __eq__(RealPoint pt) -> bool - Test for equality of wx.RealPoint objects. - - - - - - __ne__(RealPoint pt) -> bool - Test for inequality of wx.RealPoint objects. - - - - - - __add__(RealPoint pt) -> RealPoint - Add pt's proprties to this and return the result. - - - - - - __sub__(RealPoint pt) -> RealPoint - Subtract pt's proprties from this and return the result - - - - - - Set(double x, double y) - Set both the x and y properties - - - - - - - Get() -> (x,y) - Return the x and y properties as a 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__(self, double x=0.0, double y=0.0) -> RealPoint + Create a wx.RealPoint object + + + + + + + __del__(self) + + + + + __eq__(self, RealPoint pt) -> bool + Test for equality of wx.RealPoint objects. + + + + + + __ne__(self, RealPoint pt) -> bool + Test for inequality of wx.RealPoint objects. + + + + + + __add__(self, RealPoint pt) -> RealPoint + Add pt's proprties to this and return the result. + + + + + + __sub__(self, RealPoint pt) -> RealPoint + Subtract pt's proprties from this and return the result + + + + + + Set(self, double x, double y) + Set both the x and y properties + + + + + + + Get() -> (x,y) + Return the x and y properties as a 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 - Create a wx.Point object - - - - - - - __del__() - - - - - __eq__(Point pt) -> bool - Test for equality of wx.Point objects. - - - - - - __ne__(Point pt) -> bool - Test for inequality of wx.Point objects. - - - - - - __add__(Point pt) -> Point - Add pt's proprties to this and return the result. - - - - - - __sub__(Point pt) -> Point - Subtract pt's proprties from this and return the result - - - - - - __iadd__(Point pt) -> Point - Add pt to this object. - - - - - - __isub__(Point pt) -> Point - Subtract pt from this object. - - - - - - Set(long x, long y) - Set both the x and y properties - - - - - - - Get() -> (x,y) - Return the x and y properties as a 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__(self, int x=0, int y=0) -> Point + Create a wx.Point object + + + + + + + __del__(self) + + + + + __eq__(self, Point pt) -> bool + Test for equality of wx.Point objects. + + + + + + __ne__(self, Point pt) -> bool + Test for inequality of wx.Point objects. + + + + + + __add__(self, Point pt) -> Point + Add pt's proprties to this and return the result. + + + + + + __sub__(self, Point pt) -> Point + Subtract pt's proprties from this and return the result + + + + + + __iadd__(self, Point pt) -> Point + Add pt to this object. + + + + + + __isub__(self, Point pt) -> Point + Subtract pt from this object. + + + + + + Set(self, long x, long y) + Set both the x and y properties + + + + + + + Get() -> (x,y) + Return the x and y properties as a 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 - Create a new Rect object. - - - - - - - - - RectPP(Point topLeft, Point bottomRight) -> Rect - Create a new Rect object from Points representing two corners. - - - - - - - RectPS(Point pos, Size size) -> Rect - Create a new Rect from a position and size. - - - - - - - __del__() - - - GetX() -> int - - - SetX(int x) - - - - - - GetY() -> int - - - SetY(int y) - - - - - - GetWidth() -> int - - - SetWidth(int w) - - - - - - GetHeight() -> int - - - SetHeight(int h) - - - - - - GetPosition() -> Point - - - SetPosition(Point p) - - - - - - GetSize() -> Size - - - SetSize(Size s) - - - - - - GetTopLeft() -> Point - - - SetTopLeft(Point p) - - - - - - GetBottomRight() -> Point - - - SetBottomRight(Point p) - - - - - - GetLeft() -> int - - - GetTop() -> int - - - GetBottom() -> int - - - GetRight() -> int - - - SetLeft(int left) - - - - - - SetRight(int right) - - - - - - SetTop(int top) - - - - - - SetBottom(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. - - - - - - - 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. - - - - - - - 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. - - - - - - - Offset(Point pt) - Same as OffsetXY but uses dx,dy from Point - - - - - - Intersect(Rect rect) -> Rect - Return the intersectsion of this rectangle and rect. - - - - - - __add__(Rect rect) -> Rect - Add the properties of rect to this rectangle and return the result. - - - - - - __iadd__(Rect rect) -> Rect - Add the properties of rect to this rectangle, updating this rectangle. - - - - - - __eq__(Rect rect) -> bool - Test for equality. - - - - - - __ne__(Rect rect) -> bool - Test for inequality. - - - - - - InsideXY(int x, int y) -> bool - Return True if the point is (not strcitly) inside the rect. - - - - - - - Inside(Point pt) -> bool - Return True if the point is (not strcitly) inside the rect. - - - - - - Intersects(Rect rect) -> bool - Returns True if the rectangles have a non empty intersection. - - - - - - - - - - Set(int x=0, int y=0, int width=0, int height=0) - Set all rectangle properties. - - - - - - - - - Get() -> (x,y,width,height) - Return the rectangle properties as a tuple. - - - - IntersectRect(Rect r1, Rect r2) -> Rect - Calculate and return the intersection of r1 and r2. - - - - - - + + 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__(self, int x=0, int y=0, int width=0, int height=0) -> Rect + Create a new Rect object. + + + + + + + + + RectPP(Point topLeft, Point bottomRight) -> Rect + Create a new Rect object from Points representing two corners. + + + + + + + RectPS(Point pos, Size size) -> Rect + Create a new Rect from a position and size. + + + + + + + __del__(self) + + + GetX(self) -> int + + + SetX(self, int x) + + + + + + GetY(self) -> int + + + SetY(self, int y) + + + + + + GetWidth(self) -> int + + + SetWidth(self, int w) + + + + + + GetHeight(self) -> int + + + SetHeight(self, int h) + + + + + + GetPosition(self) -> Point + + + SetPosition(self, Point p) + + + + + + GetSize(self) -> Size + + + SetSize(self, Size s) + + + + + + GetTopLeft(self) -> Point + + + SetTopLeft(self, Point p) + + + + + + GetBottomRight(self) -> Point + + + SetBottomRight(self, Point p) + + + + + + GetLeft(self) -> int + + + GetTop(self) -> int + + + GetBottom(self) -> int + + + GetRight(self) -> int + + + SetLeft(self, int left) + + + + + + SetRight(self, int right) + + + + + + SetTop(self, int top) + + + + + + SetBottom(self, int bottom) + + + + + + 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(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(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(self, Point pt) + Same as OffsetXY but uses dx,dy from Point + + + + + + Intersect(self, Rect rect) -> Rect + Return the intersectsion of this rectangle and rect. + + + + + + __add__(self, Rect rect) -> Rect + Add the properties of rect to this rectangle and return the result. + + + + + + __iadd__(self, Rect rect) -> Rect + Add the properties of rect to this rectangle, updating this rectangle. + + + + + + __eq__(self, Rect rect) -> bool + Test for equality. + + + + + + __ne__(self, Rect rect) -> bool + Test for inequality. + + + + + + InsideXY(self, int x, int y) -> bool + Return True if the point is (not strcitly) inside the rect. + + + + + + + Inside(self, Point pt) -> bool + Return True if the point is (not strcitly) inside the rect. + + + + + + Intersects(self, Rect rect) -> bool + Returns True if the rectangles have a non empty intersection. + + + + + + + + + + Set(self, int x=0, int y=0, int width=0, int height=0) + Set all rectangle properties. + + + + + + + + + Get() -> (x,y,width,height) + Return the rectangle properties as a tuple. + + + + IntersectRect(Rect r1, Rect r2) -> Rect + Calculate and return the intersection of r1 and r2. + + + + + + #--------------------------------------------------------------------------- - - 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 - Create a w.Point2D object. - - - - - - - Point2DCopy(Point2D pt) -> Point2D - Create a w.Point2D object. - - - - - - Point2DFromPoint(Point pt) -> Point2D - Create a w.Point2D object. - - - - - - GetFloor() -> (x,y) - Convert to integer - - - - - - - GetRounded() -> (x,y) - Convert to integer - - - - - - - GetVectorLength() -> double - - - GetVectorAngle() -> double - - - SetVectorLength(double length) - - - - - - SetVectorAngle(double degrees) - - - - - - GetDistance(Point2D pt) -> double - - - - - - GetDistanceSquare(Point2D pt) -> double - - - - - - GetDotProduct(Point2D vec) -> double - - - - - - GetCrossProduct(Point2D vec) -> double - - - - - - __neg__() -> Point2D - the reflection of this point - - - __iadd__(Point2D pt) -> Point2D - - - - - - __isub__(Point2D pt) -> Point2D - - - - - - __imul__(Point2D pt) -> Point2D - - - - - - __idiv__(Point2D pt) -> Point2D - - - - - - __eq__(Point2D pt) -> bool - Test for equality - - - - - - __ne__(Point2D pt) -> bool - Test for inequality - - - - - - - - Set(double x=0, double y=0) - - - - - - - Get() -> (x,y) - Return x and y properties as a tuple. - - - + + wx.Point2Ds represent a point or a vector in a 2d coordinate system +with floating point values. + + __init__(self, double x=0.0, double y=0.0) -> Point2D + Create a w.Point2D object. + + + + + + + Point2DCopy(Point2D pt) -> Point2D + Create a w.Point2D object. + + + + + + Point2DFromPoint(Point pt) -> Point2D + Create a w.Point2D object. + + + + + + GetFloor() -> (x,y) + Convert to integer + + + + + + + GetRounded() -> (x,y) + Convert to integer + + + + + + + GetVectorLength(self) -> double + + + GetVectorAngle(self) -> double + + + SetVectorLength(self, double length) + + + + + + SetVectorAngle(self, double degrees) + + + + + + GetDistance(self, Point2D pt) -> double + + + + + + GetDistanceSquare(self, Point2D pt) -> double + + + + + + GetDotProduct(self, Point2D vec) -> double + + + + + + GetCrossProduct(self, Point2D vec) -> double + + + + + + __neg__(self) -> Point2D + the reflection of this point + + + __iadd__(self, Point2D pt) -> Point2D + + + + + + __isub__(self, Point2D pt) -> Point2D + + + + + + __imul__(self, Point2D pt) -> Point2D + + + + + + __idiv__(self, Point2D pt) -> Point2D + + + + + + __eq__(self, Point2D pt) -> bool + Test for equality + + + + + + __ne__(self, Point2D pt) -> bool + Test for inequality + + + + + + + + Set(self, double x=0, double y=0) + + + + + + + Get() -> (x,y) + Return x and y properties as a tuple. + + + #--------------------------------------------------------------------------- - - - __init__(PyObject p) -> InputStream - - - - - - close() - - - flush() - - - eof() -> bool - - - read(int size=-1) -> PyObject - - - - - - readline(int size=-1) -> PyObject - - + + + __init__(self, PyObject p) -> InputStream + + + + + + close(self) + + + flush(self) + + + eof(self) -> bool + + + read(self, int size=-1) -> PyObject + + + + + + readline(self, int size=-1) -> PyObject + + + + + + readlines(self, int sizehint=-1) -> PyObject + + + + + + seek(self, int offset, int whence=0) + + + + + + + tell(self) -> int + + + Peek(self) -> char + + + GetC(self) -> char + + + LastRead(self) -> size_t + + + CanRead(self) -> bool + + + Eof(self) -> bool + + + Ungetch(self, char c) -> bool + + + + + + SeekI(self, long pos, int mode=FromStart) -> long + + + + + + + TellI(self) -> long + + + + + write(self, PyObject obj) + + + + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, InputStream stream, String loc, String mimetype, String anchor, + DateTime modif) -> FSFile + + + + + + + + + + __del__(self) + + + GetStream(self) -> InputStream + + + GetMimeType(self) -> String + + + GetLocation(self) -> String + + + GetAnchor(self) -> String + + + GetModificationTime(self) -> DateTime + + + + + + + __init__(self) -> FileSystemHandler + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + CanOpen(self, String location) -> bool + + + + + + OpenFile(self, FileSystem fs, String location) -> FSFile + + + + + + + FindFirst(self, String spec, int flags=0) -> String + + + + + + + FindNext(self) -> String + + + GetProtocol(self, String location) -> String + + + + + + GetLeftLocation(self, String location) -> String + + + + + + GetAnchor(self, String location) -> String + + + + + + GetRightLocation(self, String location) -> String + + + + + + GetMimeTypeFromExt(self, String location) -> String + + + + + + + + + __init__(self) -> FileSystem + + + __del__(self) + + + ChangePathTo(self, String location, bool is_dir=False) + + + + + + + GetPath(self) -> String + + + OpenFile(self, String location) -> FSFile + + + + + + FindFirst(self, String spec, int flags=0) -> String + + + + + + + FindNext(self) -> String + + + AddHandler(CPPFileSystemHandler handler) + + + + + + CleanUpHandlers() + + + FileNameToURL(String filename) -> String + + + + + + + FileSystem_URLToFileName(String url) -> String + + + + + + + + __init__(self) -> InternetFSHandler + + + CanOpen(self, String location) -> bool + + + + + + OpenFile(self, FileSystem fs, String location) -> FSFile + + + + + + + + + + __init__(self) -> ZipFSHandler + + + CanOpen(self, String location) -> bool + + + + + + OpenFile(self, FileSystem fs, String location) -> FSFile + + + + + + + FindFirst(self, String spec, int flags=0) -> String + + + + + + + FindNext(self) -> String + + + + __wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type) + + + + - - readlines(int sizehint=-1) -> PyObject + + __wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type) - + + + - - seek(int offset, int whence=0) + + __wxMemoryFSHandler_AddFile_Data(String filename, PyObject data) - - + + - - tell() -> int - - - Peek() -> char - - - GetC() -> char - - - LastRead() -> size_t - - - CanRead() -> bool - - - Eof() -> bool - - - Ungetch(char c) -> bool - - - - - - SeekI(long pos, int mode=FromStart) -> long - - - - - - - TellI() -> long - - - - - write(PyObject obj) - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(InputStream stream, String loc, String mimetype, String anchor, - DateTime modif) -> FSFile - - - - - - - - - - __del__() - - - GetStream() -> InputStream - - - GetMimeType() -> String - - - GetLocation() -> String - - - GetAnchor() -> String - - - GetModificationTime() -> DateTime - - - - - - - __init__() -> FileSystemHandler - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - CanOpen(String location) -> bool - - - - - - OpenFile(FileSystem fs, String location) -> FSFile - - - - - - - FindFirst(String spec, int flags=0) -> String - - - - - - - FindNext() -> String - - - GetProtocol(String location) -> String - - - - - - GetLeftLocation(String location) -> String - - - - - - GetAnchor(String location) -> String - - - - - - GetRightLocation(String location) -> String - - - - - - GetMimeTypeFromExt(String location) -> String - - - - - - - - - __init__() -> FileSystem - - - __del__() - - - ChangePathTo(String location, bool is_dir=False) - - - - - - - GetPath() -> String - - - OpenFile(String location) -> FSFile - - - - - - FindFirst(String spec, int flags=0) -> String - - - - - - - FindNext() -> String - - - FileSystem.AddHandler(CPPFileSystemHandler handler) - - - - - - FileSystem.CleanUpHandlers() - - - FileSystem.FileNameToURL(String filename) -> String - - - - - - - FileSystem_URLToFileName(String url) -> String - - - - - - - - __init__() -> InternetFSHandler - - - CanOpen(String location) -> bool - - - - - - OpenFile(FileSystem fs, String location) -> FSFile - - - - - - - - - - __init__() -> ZipFSHandler - - - CanOpen(String location) -> bool - - - - - - OpenFile(FileSystem fs, String location) -> FSFile - - - - - - - FindFirst(String spec, int flags=0) -> String - - - - - - - FindNext() -> String - - - - __wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type) - - - - - - - - __wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type) - - - - - - - - __wxMemoryFSHandler_AddFile_Data(String filename, PyObject data) - - - - - - + def MemoryFSHandler_AddFile(filename, a, b=''): if isinstance(a, wx.Image): __wxMemoryFSHandler_AddFile_wxImage(filename, a, b) @@ -992,696 +1027,733 @@ def MemoryFSHandler_AddFile(filename, a, b=''): __wxMemoryFSHandler_AddFile_Data(filename, a) else: raise TypeError, 'wx.Image, wx.Bitmap or string expected' - - - - __init__() -> MemoryFSHandler - - - MemoryFSHandler.RemoveFile(String filename) - - - - - - CanOpen(String location) -> bool - - - - - - OpenFile(FileSystem fs, String location) -> FSFile - - - - - - - FindFirst(String spec, int flags=0) -> String - - - - - - - FindNext() -> String - - - + + + + __init__(self) -> MemoryFSHandler + + + RemoveFile(String filename) + + + + + + CanOpen(self, String location) -> bool + + + + + + OpenFile(self, FileSystem fs, String location) -> FSFile + + + + + + + FindFirst(self, String spec, int flags=0) -> String + + + + + + + FindNext(self) -> String + + + #--------------------------------------------------------------------------- - - - - GetName() -> String - - - GetExtension() -> String - - - GetType() -> long - - - GetMimeType() -> String - - - CanRead(String name) -> bool - - - - - - SetName(String name) - - - - - - SetExtension(String extension) - - - - - - SetType(long type) - - - - - - SetMimeType(String mimetype) - - - - - - - - __init__() -> ImageHistogram - - - ImageHistogram.MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long - Get the key in the histogram for the given RGB values - - - - - - - - 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. - - - - - - - - - - - - - - __init__(String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image - - - - - - - - ImageFromMime(String name, String mimetype, int index=-1) -> Image - - - - - - - - ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image - - - - - - - - ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image - - - - - - - - EmptyImage(int width=0, int height=0, bool clear=True) -> Image - - - - - - - - ImageFromBitmap(Bitmap bitmap) -> Image - - - - - - ImageFromData(int width, int height, unsigned char data) -> Image - - - - - - - - __del__() - - - Create(int width, int height) - - - - - - - Destroy() - Deletes the C++ object this Python object is a proxy for. - - - Scale(int width, int height) -> Image - - - - - - - ShrinkBy(int xFactor, int yFactor) -> Image - - - - - - - Rescale(int width, int height) -> Image - - - - - - - SetRGB(int x, int y, unsigned char r, unsigned char g, unsigned char b) - - - - - - - - - - GetRed(int x, int y) -> unsigned char - - - - - - - GetGreen(int x, int y) -> unsigned char - - - - - - - GetBlue(int x, int y) -> unsigned char - - - - - - - SetAlpha(int x, int y, unsigned char alpha) - - - - - - - - GetAlpha(int x, int y) -> unsigned char - - - - - - - HasAlpha() -> 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. - - - - - - - - - - - SetMaskFromImage(Image mask, byte mr, byte mg, byte mb) -> bool - - - - - - - - - Image.CanRead(String name) -> bool - - - - - - Image.GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int - - - - - - - LoadFile(String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool - - - - - - - - LoadMimeFile(String name, String mimetype, int index=-1) -> bool - - - - - - - - SaveFile(String name, int type) -> bool - - - - - - - SaveMimeFile(String name, String mimetype) -> bool - - - - - - - Image.CanReadStream(InputStream stream) -> bool - - - - - - LoadStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool - - - - - - - - LoadMimeStream(InputStream stream, String mimetype, int index=-1) -> bool - - - - - - - - Ok() -> bool - - - GetWidth() -> int - - - GetHeight() -> int - - - GetSubImage(Rect rect) -> Image - - - - - - Copy() -> Image - - - Paste(Image image, int x, int y) - - - - - - - - GetData() -> PyObject - - - SetData(PyObject data) - - - - - - GetDataBuffer() -> PyObject - - - SetDataBuffer(PyObject data) - - - - - - GetAlphaData() -> PyObject - - - SetAlphaData(PyObject data) - - - - - - GetAlphaBuffer() -> PyObject - - - SetAlphaBuffer(PyObject data) - - - - - - SetMaskColour(unsigned char r, unsigned char g, unsigned char b) - - - - - - - - GetMaskRed() -> unsigned char - - - GetMaskGreen() -> unsigned char - - - GetMaskBlue() -> unsigned char - - - SetMask(bool mask=True) - - - - - - HasMask() -> bool - - - Rotate(double angle, Point centre_of_rotation, bool interpolating=True, + + + + GetName(self) -> String + + + GetExtension(self) -> String + + + GetType(self) -> long + + + GetMimeType(self) -> String + + + CanRead(self, String name) -> bool + + + + + + SetName(self, String name) + + + + + + SetExtension(self, String extension) + + + + + + SetType(self, long type) + + + + + + SetMimeType(self, String mimetype) + + + + + + + + __init__(self) -> ImageHistogram + + + MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long + Get the key in the histogram for the given RGB values + + + + + + + + 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. + + + + + + + + + + + + + + __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image + + + + + + + + ImageFromMime(String name, String mimetype, int index=-1) -> Image + + + + + + + + ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image + + + + + + + + ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image + + + + + + + + EmptyImage(int width=0, int height=0, bool clear=True) -> Image + + + + + + + + ImageFromBitmap(Bitmap bitmap) -> Image + + + + + + ImageFromData(int width, int height, unsigned char data) -> Image + + + + + + + + __del__(self) + + + Create(self, int width, int height) + + + + + + + Destroy(self) + Deletes the C++ object this Python object is a proxy for. + + + Scale(self, int width, int height) -> Image + + + + + + + ShrinkBy(self, int xFactor, int yFactor) -> Image + + + + + + + Rescale(self, int width, int height) -> Image + + + + + + + SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b) + + + + + + + + + + GetRed(self, int x, int y) -> unsigned char + + + + + + + GetGreen(self, int x, int y) -> unsigned char + + + + + + + GetBlue(self, int x, int y) -> unsigned char + + + + + + + SetAlpha(self, int x, int y, unsigned char alpha) + + + + + + + + GetAlpha(self, int x, int y) -> unsigned char + + + + + + + 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. + + + + + + + + + + + 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(self, Image mask, byte mr, byte mg, byte mb) -> bool + + + + + + + + + CanRead(String name) -> bool + + + + + + GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int + + + + + + + LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool + + + + + + + + LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool + + + + + + + + SaveFile(self, String name, int type) -> bool + + + + + + + SaveMimeFile(self, String name, String mimetype) -> bool + + + + + + + CanReadStream(InputStream stream) -> bool + + + + + + LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool + + + + + + + + LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool + + + + + + + + Ok(self) -> bool + + + GetWidth(self) -> int + + + GetHeight(self) -> int + + + GetSize(self) -> Size + + + GetSubImage(self, Rect rect) -> Image + + + + + + Copy(self) -> Image + + + Paste(self, Image image, int x, int y) + + + + + + + + GetData(self) -> PyObject + + + SetData(self, PyObject data) + + + + + + GetDataBuffer(self) -> PyObject + + + SetDataBuffer(self, PyObject data) + + + + + + GetAlphaData(self) -> PyObject + + + SetAlphaData(self, PyObject data) + + + + + + GetAlphaBuffer(self) -> PyObject + + + SetAlphaBuffer(self, PyObject data) + + + + + + SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b) + + + + + + + + GetMaskRed(self) -> unsigned char + + + GetMaskGreen(self) -> unsigned char + + + GetMaskBlue(self) -> unsigned char + + + SetMask(self, bool mask=True) + + + + + + HasMask(self) -> bool + + + Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True, Point offset_after_rotation=None) -> Image - - - - - - - - - Rotate90(bool clockwise=True) -> Image - - - - - - Mirror(bool horizontally=True) -> Image - - - - - - Replace(unsigned char r1, unsigned char g1, unsigned char b1, + + + + + + + + + Rotate90(self, bool clockwise=True) -> Image + + + + + + Mirror(self, bool horizontally=True) -> Image + + + + + + Replace(self, unsigned char r1, unsigned char g1, unsigned char b1, unsigned char r2, unsigned char g2, unsigned char b2) - - - - - - - - - - - ConvertToMono(unsigned char r, unsigned char g, unsigned char b) -> Image - - - - - - - - SetOption(String name, String value) - - - - - - - SetOptionInt(String name, int value) - - - - - - - GetOption(String name) -> String - - - - - - GetOptionInt(String name) -> int - - - - - - HasOption(String name) -> bool - - - - - - CountColours(unsigned long stopafter=(unsigned long) -1) -> unsigned long - - - - - - ComputeHistogram(ImageHistogram h) -> unsigned long - - - - - - Image.AddHandler(ImageHandler handler) - - - - - - Image.InsertHandler(ImageHandler handler) - - - - - - Image.RemoveHandler(String name) -> bool - - - - - - Image.GetImageExtWildcard() -> String - - - ConvertToBitmap() -> Bitmap - - - ConvertToMonoBitmap(unsigned char red, unsigned char green, unsigned char blue) -> Bitmap - - - - - - - - - InitAllImageHandlers() - - - - - __init__() -> BMPHandler - - - - - - __init__() -> ICOHandler - - - - - - __init__() -> CURHandler - - - - - - __init__() -> ANIHandler - - - - - - __init__() -> PNGHandler - - - - - - __init__() -> GIFHandler - - - - - - __init__() -> PCXHandler - - - - - - __init__() -> JPEGHandler - - - - - - __init__() -> PNMHandler - - - - - - __init__() -> XPMHandler - - - - - - __init__() -> TIFFHandler - - - + + + + + + + + + + + ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image + + + + + + + + SetOption(self, String name, String value) + + + + + + + SetOptionInt(self, String name, int value) + + + + + + + GetOption(self, String name) -> String + + + + + + GetOptionInt(self, String name) -> int + + + + + + HasOption(self, String name) -> bool + + + + + + CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long + + + + + + ComputeHistogram(self, ImageHistogram h) -> unsigned long + + + + + + AddHandler(ImageHandler handler) + + + + + + InsertHandler(ImageHandler handler) + + + + + + RemoveHandler(String name) -> bool + + + + + + GetImageExtWildcard() -> String + + + ConvertToBitmap(self) -> Bitmap + + + ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap + + + + + + + + + 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__(self) -> BMPHandler + + + + + + __init__(self) -> ICOHandler + + + + + + __init__(self) -> CURHandler + + + + + + __init__(self) -> ANIHandler + + + + + + __init__(self) -> PNGHandler + + + + + + __init__(self) -> GIFHandler + + + + + + __init__(self) -> PCXHandler + + + + + + __init__(self) -> JPEGHandler + + + + + + __init__(self) -> PNMHandler + + + + + + __init__(self) -> XPMHandler + + + + + + __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 - - - GetNextHandler() -> EvtHandler - - - GetPreviousHandler() -> EvtHandler - - - SetNextHandler(EvtHandler handler) - - - - - - SetPreviousHandler(EvtHandler handler) - - - - - - GetEvtHandlerEnabled() -> bool - - - SetEvtHandlerEnabled(bool enabled) - - - - - - ProcessEvent(Event event) -> bool - - - - - - AddPendingEvent(Event event) - - - - - - ProcessPendingEvents() - - - Connect(int id, int lastId, int eventType, PyObject func) - - - - - - - - - Disconnect(int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool - - - - - - - - _setOORInfo(PyObject _self) - - - - - - + + + + __init__(self) -> EvtHandler + + + GetNextHandler(self) -> EvtHandler + + + GetPreviousHandler(self) -> EvtHandler + + + SetNextHandler(self, EvtHandler handler) + + + + + + SetPreviousHandler(self, EvtHandler handler) + + + + + + GetEvtHandlerEnabled(self) -> bool + + + SetEvtHandlerEnabled(self, bool enabled) + + + + + + ProcessEvent(self, Event event) -> bool + + + + + + AddPendingEvent(self, Event event) + + + + + + ProcessPendingEvents(self) + + + Connect(self, int id, int lastId, int eventType, PyObject func) + + + + + + + + + Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool + + + + + + + + _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): """ @@ -1742,13 +1822,13 @@ def EVT_COMMAND_RANGE(win, id1, id2, cmd, func): #--------------------------------------------------------------------------- - + #--------------------------------------------------------------------------- - - NewEventType() -> wxEventType - - + + NewEventType() -> wxEventType + + # # Create some event binders EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE ) @@ -1886,10 +1966,6 @@ EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1) EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1) EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1) -EVT_SPIN_UP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1) -EVT_SPIN_DOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1) -EVT_SPIN = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1) - EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1) EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1) EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1) @@ -1929,1411 +2005,1456 @@ EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) - + #--------------------------------------------------------------------------- - - - - __del__() - - - SetEventType(wxEventType typ) - - - - - - GetEventType() -> wxEventType - - - GetEventObject() -> Object - - - SetEventObject(Object obj) - - - - - - GetTimestamp() -> long - - - SetTimestamp(long ts=0) - - - - - - GetId() -> int - - - SetId(int Id) - - - - - - IsCommandEvent() -> bool - - - Skip(bool skip=True) - - - - - - GetSkipped() -> bool - - - ShouldPropagate() -> bool - - - StopPropagation() -> int - - - ResumePropagation(int propagationLevel) - - - - - - Clone() -> Event - - - + + + + __del__(self) + + + SetEventType(self, wxEventType typ) + + + + + + GetEventType(self) -> wxEventType + + + GetEventObject(self) -> Object + + + SetEventObject(self, Object obj) + + + + + + GetTimestamp(self) -> long + + + SetTimestamp(self, long ts=0) + + + + + + GetId(self) -> int + + + SetId(self, int Id) + + + + + + IsCommandEvent(self) -> bool + + + Skip(self, bool skip=True) + + + + + + GetSkipped(self) -> bool + + + ShouldPropagate(self) -> bool + + + StopPropagation(self) -> int + + + ResumePropagation(self, int propagationLevel) + + + + + + Clone(self) -> Event + + + #--------------------------------------------------------------------------- - - - __init__(Event event) -> PropagationDisabler - - - - - - __del__() - - - - - __init__(Event event) -> PropagateOnce - - - - - - __del__() - - - + + + __init__(self, Event event) -> PropagationDisabler + + + + + + __del__(self) + + + + + __init__(self, Event event) -> PropagateOnce + + + + + + __del__(self) + + + #--------------------------------------------------------------------------- - - - - __init__(wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent - - - - - - - GetSelection() -> int - - - SetString(String s) - - - - - - GetString() -> String - - - IsChecked() -> bool - - - IsSelection() -> bool - - - SetExtraLong(long extraLong) - - - - - - GetExtraLong() -> long - - - SetInt(int i) - - - - - - GetInt() -> long - - - Clone() -> Event - - - + + + + __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent + + + + + + + GetSelection(self) -> int + + + SetString(self, String s) + + + + + + GetString(self) -> String + + + IsChecked(self) -> bool + + + IsSelection(self) -> bool + + + SetExtraLong(self, long extraLong) + + + + + + GetExtraLong(self) -> long + + + SetInt(self, int i) + + + + + + GetInt(self) -> long + + + Clone(self) -> Event + + + #--------------------------------------------------------------------------- - - - - __init__(wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent - - - - - - - Veto() - - - Allow() - - - IsAllowed() -> bool - - - + + + + __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent + + + + + + + Veto(self) + + + Allow(self) + + + 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 - - - - - - - - - GetOrientation() -> int - - - GetPosition() -> int - - - SetOrientation(int orient) - - - - - - SetPosition(int pos) - - - - - - + + + + + + + + + GetOrientation(self) -> int + + + GetPosition(self) -> int + + + SetOrientation(self, int orient) + + + + + + SetPosition(self, int pos) + + + + + + #--------------------------------------------------------------------------- - - - - __init__(wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent - - - - - - - - GetOrientation() -> int - - - GetPosition() -> int - - - SetOrientation(int orient) - - - - - - SetPosition(int pos) - - - - - - + + + + __init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent + + + + + + + + GetOrientation(self) -> int + + + GetPosition(self) -> int + + + SetOrientation(self, int orient) + + + + + + SetPosition(self, int pos) + + + + + + #--------------------------------------------------------------------------- - - - - __init__(wxEventType mouseType=wxEVT_NULL) -> MouseEvent - - - - - - IsButton() -> bool - - - ButtonDown(int but=MOUSE_BTN_ANY) -> bool - - - - - - ButtonDClick(int but=MOUSE_BTN_ANY) -> bool - - - - - - ButtonUp(int but=MOUSE_BTN_ANY) -> bool - - - - - - Button(int but) -> bool - - - - - - ButtonIsDown(int but) -> bool - - - - - - GetButton() -> int - - - ControlDown() -> bool - - - MetaDown() -> bool - - - AltDown() -> bool - - - ShiftDown() -> bool - - - LeftDown() -> bool - - - MiddleDown() -> bool - - - RightDown() -> bool - - - LeftUp() -> bool - - - MiddleUp() -> bool - - - RightUp() -> bool - - - LeftDClick() -> bool - - - MiddleDClick() -> bool - - - RightDClick() -> bool - - - LeftIsDown() -> bool - - - MiddleIsDown() -> bool - - - RightIsDown() -> bool - - - Dragging() -> bool - - - Moving() -> bool - - - Entering() -> bool - - - Leaving() -> bool - - - GetPosition() -> 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. - - - - - - - GetLogicalPosition(DC dc) -> Point - - - - - - GetX() -> int - - - GetY() -> int - - - GetWheelRotation() -> int - - - GetWheelDelta() -> int - - - GetLinesPerAction() -> int - - - IsPageScroll() -> bool - - - - - - - - - - - - - - - + + + + __init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent + + + + + + IsButton(self) -> bool + + + ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool + + + + + + ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool + + + + + + ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool + + + + + + Button(self, int but) -> bool + + + + + + ButtonIsDown(self, int but) -> bool + + + + + + GetButton(self) -> int + + + ControlDown(self) -> bool + + + MetaDown(self) -> bool + + + AltDown(self) -> 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(self) -> bool + + + MiddleDown(self) -> bool + + + RightDown(self) -> bool + + + LeftUp(self) -> bool + + + MiddleUp(self) -> bool + + + RightUp(self) -> bool + + + LeftDClick(self) -> bool + + + MiddleDClick(self) -> bool + + + RightDClick(self) -> bool + + + LeftIsDown(self) -> bool + + + MiddleIsDown(self) -> bool + + + RightIsDown(self) -> bool + + + Dragging(self) -> bool + + + Moving(self) -> bool + + + Entering(self) -> bool + + + Leaving(self) -> bool + + + 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. + + + + + + + GetLogicalPosition(self, DC dc) -> Point + + + + + + GetX(self) -> int + + + GetY(self) -> int + + + GetWheelRotation(self) -> int + + + GetWheelDelta(self) -> int + + + GetLinesPerAction(self) -> int + + + IsPageScroll(self) -> bool + + + + + + + + + + + + + + + #--------------------------------------------------------------------------- - - - - __init__(int x=0, int y=0) -> SetCursorEvent - - - - - - - GetX() -> int - - - GetY() -> int - - - SetCursor(Cursor cursor) - - - - - - GetCursor() -> Cursor - - - HasCursor() -> bool - - - + + + + __init__(self, int x=0, int y=0) -> SetCursorEvent + + + + + + + GetX(self) -> int + + + GetY(self) -> int + + + SetCursor(self, Cursor cursor) + + + + + + GetCursor(self) -> Cursor + + + HasCursor(self) -> bool + + + #--------------------------------------------------------------------------- - - - - __init__(wxEventType keyType=wxEVT_NULL) -> KeyEvent - - - - - - ControlDown() -> bool - - - MetaDown() -> bool - - - AltDown() -> bool - - - ShiftDown() -> bool - - - HasModifiers() -> bool - - - GetKeyCode() -> int - - - GetUniChar() -> int - - - GetRawKeyCode() -> unsigned int - - - GetRawKeyFlags() -> unsigned int - - - GetPosition() -> Point - Find the position of the event. - - - GetPositionTuple() -> (x,y) - Find the position of the event. - - - - - - - GetX() -> int - - - GetY() -> int - - - - - - - - - - - - - + + + + __init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent + + + + + + ControlDown(self) -> bool + + + MetaDown(self) -> bool + + + AltDown(self) -> 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(self) -> bool + + + GetKeyCode(self) -> int + + + GetUnicodeKey(self) -> int + + + GetRawKeyCode(self) -> unsigned int + + + GetRawKeyFlags(self) -> unsigned int + + + GetPosition(self) -> Point + Find the position of the event. + + + GetPositionTuple() -> (x,y) + Find the position of the event. + + + + + + + GetX(self) -> int + + + GetY(self) -> int + + + + + + + + + + + + + #--------------------------------------------------------------------------- - - - - __init__(Size sz=DefaultSize, int winid=0) -> SizeEvent - - - - - - - GetSize() -> Size - - - GetRect() -> Rect - - - SetRect(Rect rect) - - - - - - SetSize(Size size) - - - - - - - - + + + + __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent + + + + + + + GetSize(self) -> Size + + + GetRect(self) -> Rect + + + SetRect(self, Rect rect) + + + + + + SetSize(self, Size size) + + + + + + + + #--------------------------------------------------------------------------- - - - - __init__(Point pos=DefaultPosition, int winid=0) -> MoveEvent - - - - - - - GetPosition() -> Point - - - GetRect() -> Rect - - - SetRect(Rect rect) - - - - - - SetPosition(Point pos) - - - - - - - - + + + + __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent + + + + + + + GetPosition(self) -> Point + + + GetRect(self) -> Rect + + + SetRect(self, Rect rect) + + + + + + SetPosition(self, Point pos) + + + + + + + + #--------------------------------------------------------------------------- - - - - __init__(int Id=0) -> PaintEvent - - - - - - - - - __init__(int winid=0) -> NcPaintEvent - - - - - - + + + + __init__(self, int Id=0) -> PaintEvent + + + + + + + + + __init__(self, int winid=0) -> NcPaintEvent + + + + + + #--------------------------------------------------------------------------- - - - - __init__(int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent - - - - - - - GetDC() -> DC - - - + + + + __init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent + + + + + + + GetDC(self) -> DC + + + #--------------------------------------------------------------------------- - - - - __init__(wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent - - - - - - - GetWindow() -> Window - - - SetWindow(Window win) - - - - - - + + + + __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent + + + + + + + GetWindow(self) -> Window + + + SetWindow(self, Window win) + + + + + + #--------------------------------------------------------------------------- - - - - __init__(Window win=None) -> ChildFocusEvent - - - - - - GetWindow() -> Window - - - + + + + __init__(self, Window win=None) -> ChildFocusEvent + + + + + + GetWindow(self) -> Window + + + #--------------------------------------------------------------------------- - - - - __init__(wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent - - - - - - - - GetActive() -> bool - - - + + + + __init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent + + + + + + + + GetActive(self) -> bool + + + #--------------------------------------------------------------------------- - - - - __init__(int Id=0) -> InitDialogEvent - - - - - - + + + + __init__(self, int Id=0) -> InitDialogEvent + + + + + + #--------------------------------------------------------------------------- - - - - __init__(wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent - - - - - - - - GetMenuId() -> int - - - IsPopup() -> bool - - - GetMenu() -> Menu - - - + + + + __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent + + + + + + + + GetMenuId(self) -> int + + + IsPopup(self) -> bool + + + GetMenu(self) -> Menu + + + #--------------------------------------------------------------------------- - - - - __init__(wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent - - - - - - - SetLoggingOff(bool logOff) - - - - - - GetLoggingOff() -> bool - - - Veto(bool veto=True) - - - - - - SetCanVeto(bool canVeto) - - - - - - CanVeto() -> bool - - - GetVeto() -> bool - - - + + + + __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent + + + + + + + SetLoggingOff(self, bool logOff) + + + + + + GetLoggingOff(self) -> bool + + + Veto(self, bool veto=True) + + + + + + SetCanVeto(self, bool canVeto) + + + + + + CanVeto(self) -> bool + + + GetVeto(self) -> bool + + + #--------------------------------------------------------------------------- - - - - __init__(int winid=0, bool show=False) -> ShowEvent - - - - - - - SetShow(bool show) - - - - - - GetShow() -> bool - - - + + + + __init__(self, int winid=0, bool show=False) -> ShowEvent + + + + + + + SetShow(self, bool show) + + + + + + GetShow(self) -> bool + + + #--------------------------------------------------------------------------- - - - - __init__(int id=0, bool iconized=True) -> IconizeEvent - - - - - - - Iconized() -> bool - - - + + + + __init__(self, int id=0, bool iconized=True) -> IconizeEvent + + + + + + + Iconized(self) -> bool + + + #--------------------------------------------------------------------------- - - - - __init__(int id=0) -> MaximizeEvent - - - - - - + + + + __init__(self, int id=0) -> MaximizeEvent + + + + + + #--------------------------------------------------------------------------- - - - - GetPosition() -> Point - - - GetNumberOfFiles() -> int - - - GetFiles() -> PyObject - - - + + + + GetPosition(self) -> Point + + + GetNumberOfFiles(self) -> int + + + GetFiles(self) -> PyObject + + + #--------------------------------------------------------------------------- - - - - __init__(int commandId=0) -> UpdateUIEvent - - - - - - GetChecked() -> bool - - - GetEnabled() -> bool - - - GetText() -> String - - - GetSetText() -> bool - - - GetSetChecked() -> bool - - - GetSetEnabled() -> bool - - - Check(bool check) - - - - - - Enable(bool enable) - - - - - - SetText(String text) - - - - - - UpdateUIEvent.SetUpdateInterval(long updateInterval) - - - - - - UpdateUIEvent.GetUpdateInterval() -> long - - - UpdateUIEvent.CanUpdate(Window win) -> bool - - - - - - UpdateUIEvent.ResetUpdateTime() - - - UpdateUIEvent.SetMode(int mode) - - - - - - UpdateUIEvent.GetMode() -> int - - - + + + + __init__(self, int commandId=0) -> UpdateUIEvent + + + + + + GetChecked(self) -> bool + + + GetEnabled(self) -> bool + + + GetText(self) -> String + + + GetSetText(self) -> bool + + + GetSetChecked(self) -> bool + + + GetSetEnabled(self) -> bool + + + Check(self, bool check) + + + + + + Enable(self, bool enable) + + + + + + SetText(self, String text) + + + + + + SetUpdateInterval(long updateInterval) + + + + + + GetUpdateInterval() -> long + + + CanUpdate(Window win) -> bool + + + + + + ResetUpdateTime() + + + SetMode(int mode) + + + + + + GetMode() -> int + + + #--------------------------------------------------------------------------- - - - - __init__() -> SysColourChangedEvent - - - + + + + __init__(self) -> SysColourChangedEvent + + + #--------------------------------------------------------------------------- - - - - __init__(int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent - - - - - - - GetCapturedWindow() -> Window - - - + + + + __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent + + + + + + + GetCapturedWindow(self) -> Window + + + #--------------------------------------------------------------------------- - - - - __init__() -> DisplayChangedEvent - - - + + + + __init__(self) -> DisplayChangedEvent + + + #--------------------------------------------------------------------------- - - - - __init__(int id=0) -> PaletteChangedEvent - - - - - - SetChangedWindow(Window win) - - - - - - GetChangedWindow() -> Window - - - + + + + __init__(self, int id=0) -> PaletteChangedEvent + + + + + + SetChangedWindow(self, Window win) + + + + + + GetChangedWindow(self) -> Window + + + #--------------------------------------------------------------------------- - - - - __init__(int winid=0) -> QueryNewPaletteEvent - - - - - - SetPaletteRealized(bool realized) - - - - - - GetPaletteRealized() -> bool - - - + + + + __init__(self, int winid=0) -> QueryNewPaletteEvent + + + + + + SetPaletteRealized(self, bool realized) + + + + + + GetPaletteRealized(self) -> bool + + + #--------------------------------------------------------------------------- - - - - __init__() -> NavigationKeyEvent - - - GetDirection() -> bool - - - SetDirection(bool bForward) - - - - - - IsWindowChange() -> bool - - - SetWindowChange(bool bIs) - - - - - - GetCurrentFocus() -> Window - - - SetCurrentFocus(Window win) - - - - - - + + + + __init__(self) -> NavigationKeyEvent + + + GetDirection(self) -> bool + + + SetDirection(self, bool forward) + + + + + + IsWindowChange(self) -> bool + + + SetWindowChange(self, bool ischange) + + + + + + SetFlags(self, long flags) + + + + + + GetCurrentFocus(self) -> Window + + + SetCurrentFocus(self, Window win) + + + + + + #--------------------------------------------------------------------------- - - - - __init__(Window win=None) -> WindowCreateEvent - - - - - - GetWindow() -> Window - - - - - - __init__(Window win=None) -> WindowDestroyEvent - - - - - - GetWindow() -> Window - - - + + + + __init__(self, Window win=None) -> WindowCreateEvent + + + + + + GetWindow(self) -> Window + + + + + + __init__(self, Window win=None) -> WindowDestroyEvent + + + + + + GetWindow(self) -> Window + + + #--------------------------------------------------------------------------- - - - - __init__(wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent - - - - - - - - GetPosition() -> Point - - - SetPosition(Point pos) - - - - - - + + + + __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent + + + + + + + + GetPosition(self) -> Point + + + SetPosition(self, Point pos) + + + + + + #--------------------------------------------------------------------------- - - - - __init__() -> IdleEvent - - - RequestMore(bool needMore=True) - - - - - - MoreRequested() -> bool - - - IdleEvent.SetMode(int mode) - - - - - - IdleEvent.GetMode() -> int - - - IdleEvent.CanSend(Window win) -> bool - - - - - - + + + + __init__(self) -> IdleEvent + + + RequestMore(self, bool needMore=True) + + + + + + MoreRequested(self) -> bool + + + SetMode(int mode) + + + + + + GetMode() -> int + + + CanSend(Window win) -> bool + + + + + + #--------------------------------------------------------------------------- - - - - __init__(int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent - - - - - - - __del__() - - - SetSelf(PyObject self) - - - - - - GetSelf() -> PyObject - - - - - - __init__(wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent - - - - - - - __del__() - - - SetSelf(PyObject self) - - - - - - GetSelf() -> PyObject - - - + + + + __init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent + + + + + + + __del__(self) + + + SetSelf(self, PyObject self) + + + + + + GetSelf(self) -> PyObject + + + + + + __init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent + + + + + + + __del__(self) + + + SetSelf(self, PyObject self) + + + + + + GetSelf(self) -> PyObject + + + #--------------------------------------------------------------------------- - - - - __init__() -> PyApp - - - __del__() - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - GetAppName() -> String - Get the application name. - - - SetAppName(String name) - Set the application name. This value may be used automatically -by wx.Config and such. - - - - - - GetClassName() -> 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 - - - - - - GetVendorName() -> 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. - - - - - - 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 - - - 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. - - - 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! + + The ``wx.PyApp`` class is an *implementation detail*, please use the +`wx.App` class (or some other derived class) instead. + + + __init__(self) -> PyApp + Create a new application object, starting the bootstrap process. + + + __del__(self) + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + GetAppName(self) -> String + Get the application name. + + + SetAppName(self, String name) + Set the application name. This value may be used automatically by +`wx.Config` and such. + + + + + + GetClassName(self) -> String + Get the application's class name. + + + SetClassName(self, String name) + Set the application's class name. This value may be used for +X-resources if applicable for the platform + + + + + + GetVendorName(self) -> String + Get the application's vendor name. + + + SetVendorName(self, String name) + Set the application's vendor name. This value may be used +automatically by `wx.Config` and such. + + + + + + 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(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(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 - - - MainLoop() -> int - Execute the main GUI loop, the function returns when the loop ends. - - - Exit() - Exit the main loop thus terminating the application. - - - ExitMainLoop() - Exit the main GUI loop during the next iteration (i.e. it does not -stop the program immediately!) - - - Pending() -> bool - Returns True if there are unprocessed events in the event queue. - - - Dispatch() -> bool - Process the first event in the event queue (blocks until an event + + + + + + WakeUpIdle(self) + Make sure that idle events are sent again. +:see: `wx.WakeUpIdle` + + + 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(self) + Exit the main loop thus terminating the application. +:see: `wx.Exit` + + + 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(self) -> bool + Returns True if there are unprocessed events in the event queue. + + + 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. - - - SendIdleEvents(Window win, IdleEvent event) -> bool - Send idle event to window and all subwindows. Returns True if more idle time -is requested. - - - - - - - IsActive() -> bool - Return True if our app has focus. - - - SetTopWindow(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) - - - 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. + + + 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(self, Window win, IdleEvent event) -> bool + Send idle event to window and all subwindows. Returns True if more +idle time is requested. + + + + + + + IsActive(self) -> bool + Return True if our app has focus. + + + SetTopWindow(self, Window win) + Set the *main* top level window + + + + + + 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(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(self) -> bool + Get the current exit behaviour setting. + + + 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(self) -> bool + Get current UseBestVisual setting. + + + SetPrintMode(self, int mode) + + + + + + GetPrintMode(self) -> int + + + 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(self) -> int + Get the current OnAssert behaviour setting. + + + GetMacSupportPCMenuShortcuts() -> bool + + + GetMacAboutMenuItemId() -> long + + + GetMacPreferencesMenuItemId() -> long + + + GetMacExitMenuItemId() -> long + + + GetMacHelpMenuTitleName() -> String + + + SetMacSupportPCMenuShortcuts(bool val) + + + + + + SetMacAboutMenuItemId(long val) + + + + + + SetMacPreferencesMenuItemId(long val) + + + + + + SetMacExitMenuItemId(long val) + + + + + + SetMacHelpMenuTitleName(String val) + + + + + + _BootstrapApp(self) + For internal use only + + + GetComCtl32Version() -> int + Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if +it wasn't found at all. Raises an exception on non-Windows platforms. + + + +#--------------------------------------------------------------------------- + + + Exit() + Force an exit of the application. Convenience for wx.GetApp().Exit() + + + Yield() -> bool + Yield to other apps/messages. Convenience for wx.GetApp().Yield() + + + YieldIfNeeded() -> bool + Yield to other apps/messages. Convenience for wx.GetApp().Yield(True) + + + 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. + +:Returns: the result of the call to `wx.Yield`. - - - - - GetExitOnFrameDelete() -> 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.) - - - - - - GetUseBestVisual() -> bool - Get current UseBestVisual setting. - - - SetPrintMode(int mode) - - + + - - GetPrintMode() -> int + + WakeUpIdle() + Cause the message queue to become empty again, so idle events will be +sent. - - 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 - + + PostEvent(EvtHandler dest, Event event) + Send an event to a window or other wx.EvtHandler to be processed +later. - + + - - GetAssertMode() -> int - Get the current OnAssert behaviour setting. + + App_CleanUp() + For internal use only, it is used to cleanup after wxWidgets when +Python shuts down. - - PyApp.GetMacSupportPCMenuShortcuts() -> bool - - - PyApp.GetMacAboutMenuItemId() -> long - - - PyApp.GetMacPreferencesMenuItemId() -> long - - - PyApp.GetMacExitMenuItemId() -> long - - - PyApp.GetMacHelpMenuTitleName() -> String - - - PyApp.SetMacSupportPCMenuShortcuts(bool val) - - - - - - PyApp.SetMacAboutMenuItemId(long val) - - - - - - PyApp.SetMacPreferencesMenuItemId(long val) - - - - - - PyApp.SetMacExitMenuItemId(long val) - - - - - - PyApp.SetMacHelpMenuTitleName(String val) - - - - - - _BootstrapApp() - For internal use only + + GetApp() -> PyApp + Return a reference to the current wx.App object. - - PyApp.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. - - - -#--------------------------------------------------------------------------- - - - Exit() - Force an exit of the application. Convenience for wx.GetApp().Exit() - - - Yield() -> bool - Yield to other apps/messages. Convenience for wx.GetApp().Yield() - - - YieldIfNeeded() -> bool - Yield to other apps/messages. Convenience for wx.GetApp().Yield(True) - - - 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. - -Returns the result of the call to wx.Yield. - - - - - - - WakeUpIdle() - 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. - - - - - - - App_CleanUp() - For internal use only, it is used to cleanup after wxWindows when Python shuts down. - - - GetApp() -> PyApp - Return a reference to the current wx.App object. - - + #---------------------------------------------------------------------- class PyOnDemandOutputWindow: @@ -3346,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): @@ -3354,15 +3477,22 @@ 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) - self.frame.SetSize((450, 300)) + style=wx.TE_MULTILINE|wx.TE_READONLY) + self.text.AppendText(st) self.frame.Show(True) EVT_CLOSE(self.frame, self.OnCloseWindow) + def OnCloseWindow(self, event): + if self.frame is not None: + self.frame.Destroy() + self.frame = None + self.text = None + + # These methods provide the file-like output behaviour. def write(self, text): """ @@ -3387,11 +3517,10 @@ class PyOnDemandOutputWindow: wx.CallAfter(self.frame.Close) - def OnCloseWindow(self, event): - if self.frame is not None: - self.frame.Destroy() - self.frame = None - self.text = None + 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 @@ -3465,7 +3646,7 @@ your Mac.""" self.RestoreStdio() - def RedirectStdio(self, filename): + def RedirectStdio(self, filename=None): """Redirect sys.stdout and sys.stderr to a file or a popup window.""" if filename: _sys.stdout = _sys.stderr = open(filename, 'a') @@ -3478,19 +3659,35 @@ your Mac.""" _sys.stdout, _sys.stderr = self.saveStdio + 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 wxPyApp_ to wxApp_ -App_GetMacSupportPCMenuShortcuts = _core.PyApp_GetMacSupportPCMenuShortcuts -App_GetMacAboutMenuItemId = _core.PyApp_GetMacAboutMenuItemId -App_GetMacPreferencesMenuItemId = _core.PyApp_GetMacPreferencesMenuItemId -App_GetMacExitMenuItemId = _core.PyApp_GetMacExitMenuItemId -App_GetMacHelpMenuTitleName = _core.PyApp_GetMacHelpMenuTitleName -App_SetMacSupportPCMenuShortcuts = _core.PyApp_SetMacSupportPCMenuShortcuts -App_SetMacAboutMenuItemId = _core.PyApp_SetMacAboutMenuItemId -App_SetMacPreferencesMenuItemId = _core.PyApp_SetMacPreferencesMenuItemId -App_SetMacExitMenuItemId = _core.PyApp_SetMacExitMenuItemId -App_SetMacHelpMenuTitleName = _core.PyApp_SetMacHelpMenuTitleName -App_GetComCtl32Version = _core.PyApp_GetComCtl32Version + +# change from wx.PyApp_XX to wx.App_XX +App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts +App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId +App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId +App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId +App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName +App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts +App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId +App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId +App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId +App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName +App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version #---------------------------------------------------------------------------- @@ -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() + + :see: `wx.App` + """ - def __init__(self, redirect=False, filename=None, useBestVisual=False): - wx.App.__init__(self, redirect, filename, useBestVisual) + def __init__(self, redirect=False, filename=None, + useBestVisual=False, clearSigInt=True): + """ + :see: `wx.App.__init__` + """ + wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt) def OnInit(self): - wx.InitAllImageHandlers() return True + # Is anybody using this one? class PyWidgetTester(wx.App): def __init__(self, size = (250, 100)): @@ -3519,32044 +3728,37928 @@ 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) #---------------------------------------------------------------------------- - + #--------------------------------------------------------------------------- - - - __init__(int flags=0, int keyCode=0, int cmd=0, MenuItem item=None) -> AcceleratorEntry - - - - - - - - - __del__() - - - Set(int flags, int keyCode, int cmd, MenuItem item=None) - - - - - - - - - SetMenuItem(MenuItem item) - - - - - - GetMenuItem() -> MenuItem - - - GetFlags() -> int - - - GetKeyCode() -> int - - - GetCommand() -> int - - - - - - __init__(entries) -> AcceleratorTable - Construct an AcceleratorTable from a list of AcceleratorEntry items or -3-tuples (flags, keyCode, cmdID) - - - - - - - __del__() - - - Ok() -> bool - - - - GetAccelFromString(String label) -> AcceleratorEntry - - - - - + + 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__(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__(self) + + + Set(self, int flags, int keyCode, int cmd) + (Re)set the attributes of a wx.AcceleratorEntry. +:see `__init__` + + + + + + + + GetFlags(self) -> int + Get the AcceleratorEntry's flags. + + + GetKeyCode(self) -> int + Get the AcceleratorEntry's keycode. + + + 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 `wx.AcceleratorEntry` +items or or of 3-tuples (flags, keyCode, cmdID) + +:see: `wx.AcceleratorEntry` + + + + + + + __del__(self) + + + Ok(self) -> bool + + + + GetAccelFromString(String label) -> AcceleratorEntry + + + + + #--------------------------------------------------------------------------- - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=PanelNameStr) -> Window - - - - - - - - - - - PreWindow() -> Window - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=PanelNameStr) -> bool - - - - - - - - - - - Close(bool force=False) -> bool - - - - - - Destroy() -> bool - Deletes the C++ object this Python object is a proxy for. - - - DestroyChildren() -> bool - - - IsBeingDeleted() -> bool - - - SetTitle(String title) - - - - - - GetTitle() -> String - - - SetLabel(String label) - - - - - - GetLabel() -> String - - - SetName(String name) - - - - - - GetName() -> String - - - SetId(int winid) - - - - - - GetId() -> int - - - Window.NewControlId() -> int - - - Window.NextControlId(int winid) -> int - - - - - - Window.PrevControlId(int winid) -> int - - - - - - SetSize(Size size) - - - - - - SetDimensions(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) - - - - - - - - - - SetRect(Rect rect, int sizeFlags=SIZE_AUTO) - - - - - - - SetSizeWH(int width, int height) - - - - - - - Move(Point pt, int flags=SIZE_USE_EXISTING) - - - - - - - MoveXY(int x, int y, int flags=SIZE_USE_EXISTING) - - - - - - - - Raise() - - - Lower() - - - SetClientSize(Size size) - - - - - - SetClientSizeWH(int width, int height) - - - - - - - SetClientRect(Rect rect) - - - - - - GetPosition() -> Point - Get the window's position. - - - GetPositionTuple() -> (x,y) - Get the window's position. - - - - - - - GetSize() -> Size - Get the window size. - - - GetSizeTuple() -> (width, height) - Get the window size. - - - - - - - GetRect() -> Rect - - - GetClientSize() -> Size - Get the window's client size. - - - GetClientSizeTuple() -> (width, height) - Get the window's client size. - - - - - - - GetClientAreaOrigin() -> Point - - - GetClientRect() -> Rect - - - GetBestSize() -> Size - Get the size best suited for the window (in fact, minimal acceptable size -using which it will still look "nice") - - - GetBestSizeTuple() -> (width, height) - Get the size best suited for the window (in fact, minimal acceptable size -using which it will still look "nice") - - - - - - - GetAdjustedBestSize() -> Size - - - Center(int direction=BOTH) - - - - - - CenterOnScreen(int dir=BOTH) - - - - - - CenterOnParent(int dir=BOTH) - - - - - - Fit() - - - FitInside() - - - SetSizeHints(int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, + + 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, + Validate/TransferDataTo/FromWindow() + only work on direct children of + the window (compatible + behaviour). Set this flag to make + them recursively descend into all + subwindows. + + wx.WS_EX_BLOCK_EVENTS wx.CommandEvents and the objects of the + derived classes are forwarded to + the parent window and so on + recursively by default. Using this + flag for the given window allows + to block this propagation at this + window, i.e. prevent the events + from being propagated further + upwards. Dialogs have this flag on + by default. + + wx.WS_EX_TRANSIENT Don't use this window as an implicit parent for + the other windows: this must be + used with transient windows as + otherwise there is the risk of + creating a dialog/frame with this + window as a parent which would + lead to a crash if the parent is + destroyed before the child. + + wx.WS_EX_PROCESS_IDLE This window should always process idle + events, even if the mode set by + wx.IdleEvent.SetMode is + wx.IDLE_PROCESS_SPECIFIED. + + wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI + update events, even if the mode + set by wxUpdateUIEvent::SetMode is + wxUPDATE_UI_PROCESS_SPECIFIED. + ============================= ===================================== + + + + + __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. + + + + + + + + + + + PreWindow() -> Window + Precreate a Window for 2-phase creation. + + + 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. + + + + + + + + + + + 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. + +The close handler should check whether the window is being deleted +forcibly, using wx.CloseEvent.GetForce, in which case it should +destroy the window using wx.Window.Destroy. + +Note that calling Close does not guarantee that the window will be +destroyed; but it provides a way to simulate a manual close of a +window, which may or may not be implemented by destroying the +window. The default EVT_CLOSE handler for wx.Dialog does not +necessarily delete the dialog, since it will simply simulate an +wxID_CANCEL event which is handled by the appropriate button event +handler and may do anything at all. + +To guarantee that the window will be destroyed, call wx.Window.Destroy +instead. + + + + + + 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 +have been processed. This prevents problems with events being sent to +non-existent windows. + +Returns True if the window has either been successfully deleted, or it +has been added to the list of windows pending real deletion. + + + DestroyChildren(self) -> bool + Destroys all children of a window. Called automatically by the +destructor. + + + IsBeingDeleted(self) -> bool + Is the window in the process of being deleted? + + + SetTitle(self, String title) + Sets the window's title. Applicable only to frames and dialogs. + + + + + + GetTitle(self) -> String + Gets the window's title. Applicable only to frames and dialogs. + + + SetLabel(self, String label) + Set the text which the window shows in its label if applicable. + + + + + + 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(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(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(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(self) -> int + + + 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 +creation and should not be modified subsequently. + + + + + + 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 +generated. + + + NewControlId() -> int + Generate a control id for the controls which were not given one. + + + NextControlId(int winid) -> int + Get the id of the control following the one with the given +autogenerated) id + + + + + + PrevControlId(int winid) -> int + Get the id of the control preceding the one with the given +autogenerated) id + + + + + + SetSize(self, Size size) + Sets the size of the window in pixels. + + + + + + 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 +shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be +used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow +dimensions of -1 and less to be interpreted as real dimensions, not +default values. + + + + + + + + + + SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO) + Sets the position and size of the window in pixels using a wx.Rect. + + + + + + + SetSizeWH(self, int width, int height) + Sets the size of the window in pixels. + + + + + + + Move(self, Point pt, int flags=SIZE_USE_EXISTING) + Moves the window to the given position. + + + + + + + MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING) + Moves the window to the given position. + + + + + + + + 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(self) + Raises the window to the top of the window hierarchy if it is a +managed window (dialog or frame). + + + Lower(self) + Lowers the window to the bottom of the window hierarchy if it is a +managed window (dialog or frame). + + + 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 +dimensions the border or title bar have when trying to fit the window +around panel items, for example. + + + + + + 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 +dimensions the border or title bar have when trying to fit the window +around panel items, for example. + + + + + + + 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 +dimensions the border or title bar have when trying to fit the window +around panel items, for example. + + + + + + GetPosition(self) -> Point + Get the window's position. + + + GetPositionTuple() -> (x,y) + Get the window's position. + + + + + + + GetSize(self) -> Size + Get the window size. + + + GetSizeTuple() -> (width, height) + Get the window size. + + + + + + + GetRect(self) -> Rect + Returns the size and position of the window as a wx.Rect object. + + + 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. + + + GetClientSizeTuple() -> (width, height) + 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. + + + + + + + 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(self) -> Rect + Get the client area position and size as a `wx.Rect` object. + + + 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 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(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 +user specified minimum size. ie. it is the minimum size the window +should currently be drawn at, not the minimal size it can possibly +tolerate. + + + 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 +on the entire screen and not on its parent window. If it is a +top-level window and has no parent then it will always be centered +relative to the screen. + + + + + + CenterOnScreen(self, int dir=BOTH) + Center on screen (only works for top level windows) + + + + + + CenterOnParent(self, int dir=BOTH) + Center with respect to the the parent window + + + + + + 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 +window has exactly one subwindow it is better (faster and the result +is more precise as Fit adds some margin to account for fuzziness of +its calculations) to call window.SetClientSize(child.GetSize()) +instead of calling Fit. + + + 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 +windows without an interior sizer. This function similarly won't do +anything if there are no subwindows. + + + 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 (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` + + + + + + + + + + + + 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(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 +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(self) -> int + + + GetMinHeight(self) -> int + + + GetMaxWidth(self) -> int + + + GetMaxHeight(self) -> int + + + 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. + + + + + + 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. + + + + + + + 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. + + + GetVirtualSizeTuple() -> (width, height) + 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. + + + + + + + GetBestVirtualSize(self) -> Size + Return the largest of ClientSize and BestSize (as determined by a +sizer, interior children, or other means) + + + 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 +the window has been shown or hidden or False if nothing was done +because it already was in the requested state. + + + + + + Hide(self) -> bool + Equivalent to calling Show(False). + + + 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 +has been enabled or disabled, false if nothing was done, i.e. if the +window had already been in the specified state. + + + + + + Disable(self) -> bool + Disables the window, same as Enable(false). + + + IsShown(self) -> bool + Returns true if the window is shown, false if it has been hidden. + + + IsEnabled(self) -> bool + Returns true if the window is enabled for input, false otherwise. + + + 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 need to be +called after changing the others for the change to take place +immediately. + + + + + + GetWindowStyleFlag(self) -> long + Gets the window style that was passed to the constructor or Create +method. + + + HasFlag(self, int flag) -> bool + Test if the given style is set for this window. + + + + + + IsRetained(self) -> bool + Returns true if the window is retained, false otherwise. Retained +windows are only available on X platforms. + + + 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() + + + + + + GetExtraStyle(self) -> long + Returns the extra style bits for the window. + + + 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. + + + + + + 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 + the notion of themes in user defined windows. One such platform is + GTK+ where windows can have (very colourful) backgrounds defined by a + user's selected theme. + +Dialogs, notebook pages and the status bar have this flag set to true +by default so that the default look and feel is simulated best. + + + + + + GetThemeEnabled(self) -> bool + Return the themeEnabled flag. + + + SetFocus(self) + Set's the focus to this window, allowing it to receive keyboard input. + + + SetFocusFromKbd(self) + Set focus to this window as the result of a keyboard action. Normally +only called internally. + + + FindFocus() -> Window + Returns the window or control that currently has the keyboard focus, +or None. + + + AcceptsFocus(self) -> bool + Can this window have focus? + + + 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(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(self, Window child) -> Window + Set this child as default, return the old default. + + + + + + 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(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(self) -> Window + Returns the parent window 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(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(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 +if the parent was changed, False otherwise (error or newParent == +oldParent) + + + + + + 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. + + + + + + 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. + + + + + + FindWindowById(self, long winid) -> Window + Find a chld of this window by window ID + + + + + + FindWindowByName(self, String name) -> Window + Find a child of this window by name + + + + + + GetEventHandler(self) -> EvtHandler + Returns the event handler for this window. By default, the window is +its own event 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 +up a chain of event handlers, where an event not handled by one event +handler is handed to the next one in the chain. + + + + + + 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 +an application may wish to substitute another, for example to allow +central implementation of event-handling for a variety of different +window classes. + +wx.Window.PushEventHandler allows an application to set up a chain of +event handlers, where an event not handled by one event handler is +handed to the next one in the chain. Use `wx.Window.PopEventHandler` to +remove the event handler. + + + + + + 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. + + + + + + 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(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. + + + + + + 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(self, AcceleratorTable accel) + Sets the accelerator table for this window. + + + + + + GetAcceleratorTable(self) -> AcceleratorTable + Gets the accelerator table for this window. + + + 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 +does not have the input focus because the user is working with some +other application. To bind an event handler function to this hotkey +use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the +hotkey was registered successfully. + + + + + + + + UnregisterHotKey(self, int hotkeyId) -> bool + Unregisters a system wide hotkey. + + + + + + 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 +average character width and then divided by 4. For the y dimension, +the dialog units are multiplied by the average character height and +then divided by 8. + + + + + + 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 +average character width and then divided by 4. For the y dimension, +the dialog units are multiplied by the average character height and +then divided by 8. + + + + + + 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 +average character width and then divided by 4. For the y dimension, +the dialog units are multiplied by the average character height and +then divided by 8. + + + + + + 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 +average character width and then divided by 4. For the y dimension, +the dialog units are multiplied by the average character height and +then divided by 8. + + + + + + ConvertPixelPointToDialog(self, Point pt) -> Point + + + + + + ConvertPixelSizeToDialog(self, Size sz) -> Size + + + + + + 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 +Interface Guidelines forbid moving the mouse cursor programmatically. + + + + + + + CaptureMouse(self) + Directs all mouse input to this window. Call wx.Window.ReleaseMouse to +release the capture. + +Note that wxWindows maintains the stack of windows having captured the +mouse and when the mouse is released the capture returns to the window +which had had captured it previously and it is only really released if +there were no previous window. In particular, this means that you must +release the mouse as many times as you capture it. + + + ReleaseMouse(self) + Releases mouse input captured with wx.Window.CaptureMouse. + + + GetCapture() -> Window + Returns the window which currently captures the mouse or None + + + HasCapture(self) -> bool + Returns true if this window has the current mouse capture. + + + 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. + + + + + + + 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. + + + + + + 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 +event loop.) Notice that this function doesn't refresh the window and +does nothing if the window has been already repainted. Use Refresh +first if you want to immediately redraw the window (or some portion of +it) unconditionally. + + + ClearBackground(self) + Clears the window by filling it with the current background +colour. Does not cause an erase background event to be generated. + + + 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 +a wxTextCtrl under wxGTK) but is not implemented on all platforms nor +for all controls so it is mostly just a hint to wxWindows and not a +mandatory directive. + + + 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. + + + 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. + + + + + + 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(self) -> Rect + Get the update rectangle region bounding box in client coords. + + + 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 +exposed. + + + + + + + + + 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 +exposed. + + + + + + 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 +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(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. Using `wx.NullColour` will reset the window +to the default background colour. + +Note that setting the background colour may not cause an immediate +refresh, so you may wish to call `ClearBackground` or `Refresh` after +calling this function. + +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(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 +not be used at all. + + + + + + SetOwnForegroundColour(self, Colour colour) + + + + + + GetBackgroundColour(self) -> Colour + Returns the background colour of the window. + + + 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(self, Cursor cursor) -> bool + Sets the window's cursor. Notice that the window cursor also sets it +for the children of the window implicitly. + +The cursor may be wx.NullCursor in which case the window cursor will +be reset back to default. + + + + + + GetCursor(self) -> Cursor + Return the cursor associated with this window. + + + SetFont(self, Font font) -> bool + Sets the font for this window. + + + + + + SetOwnFont(self, Font font) + + + + + + GetFont(self) -> Font + Returns the default font used for this window. + + + SetCaret(self, Caret caret) + Sets the caret associated with the window. + + + + + + GetCaret(self) -> Caret + Returns the caret associated with the window. + + + GetCharHeight(self) -> int + Get the (average) character size for the current font. + + + GetCharWidth(self) -> int + Get the (average) character size for the current font. + + + GetTextExtent(String string) -> (width, height) + Get the width and height of the text using the current font. + + + + + + + + GetFullTextExtent(String string, Font font=None) -> + (width, height, descent, externalLeading) + Get the width, height, decent and leading of the text using the +current or specified font. + + + + + + + + + + + ClientToScreenXY(int x, int y) -> (x,y) + Converts to screen coordinates from coordinates relative to this window. + + + + + + + ScreenToClientXY(int x, int y) -> (x,y) + Converts from screen to client window coordinates. + + + + + + + ClientToScreen(self, Point pt) -> Point + Converts to screen coordinates from coordinates relative to this window. + + + + + + ScreenToClient(self, Point pt) -> Point + Converts from screen to client window coordinates. + + + + + + HitTestXY(self, int x, int y) -> int + Test where the given (in client coords) point lies + + + + + + + HitTest(self, Point pt) -> int + Test where the given (in client coords) point lies + + + + + + Get the window border style from the given flags: this is different +from simply doing flags & wxBORDER_MASK because it uses +GetDefaultBorder() to translate wxBORDER_DEFAULT to something +reasonable. + + + + + + + GetBorder(self, long flags) -> int +GetBorder(self) -> int + Get border for the flags of this window + + + 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 +send an update UI event for each menubar menu item. You can call this +function from your application to ensure that your UI is up-to-date at +a particular point in time (as far as your EVT_UPDATE_UI handlers are +concerned). This may be necessary if you have called +wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to +limit the overhead that wxWindows incurs by sending update UI events +in idle time. +The flags should be a bitlist of one or more of the following values: + + ===================== ============================== + wx.UPDATE_UI_NONE No particular value + wx.UPDATE_UI_RECURSE Call the function for descendants + wx.UPDATE_UI_FROMIDLE Invoked from OnIdle + ===================== ============================== + +If you are calling this function from an OnIdle function, make sure +you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window +to only update the UI elements that need to be updated in idle +time. Some windows update their elements only when necessary, for +example when a menu is about to be shown. The following is an example +of how to call UpdateWindowUI from an idle function:: + + def OnIdle(self, evt): + if wx.UpdateUIEvent.CanUpdate(self): + self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE); + + + + + + + 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(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(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(self, int orient) -> bool + Does the window have the scrollbar for this orientation? + + + + + + 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. + + :param position: The position of the scrollbar in scroll units. + + :param thumbSize: The size of the thumb, or visible portion of the + scrollbar, in scroll units. + + :param range: The maximum position of the scrollbar. + + :param refresh: True to redraw the scrollbar, false otherwise. + + + + + + + + + + + SetScrollPos(self, int orientation, int pos, bool refresh=True) + Sets the position of one of the built-in scrollbars. + + + + + + + + GetScrollPos(self, int orientation) -> int + Returns the built-in scrollbar position. + + + + + + GetScrollThumb(self, int orientation) -> int + Returns the built-in scrollbar thumb size. + + + + + + GetScrollRange(self, int orientation) -> int + Returns the built-in scrollbar range. + + + + + + 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. + + :param dy: Amount to scroll vertically. + + :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. + + + + + + + + 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 +already on top/bottom and nothing was done. + + + + + + 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. + + + + + + LineUp(self) -> bool + This is just a wrapper for ScrollLines(-1). + + + LineDown(self) -> bool + This is just a wrapper for ScrollLines(1). + + + PageUp(self) -> bool + This is just a wrapper for ScrollPages(-1). + + + PageDown(self) -> bool + This is just a wrapper for ScrollPages(1). + + + 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. + + + + + + SetHelpTextForId(self, String text) + Associate this help text with all windows with the same id as this +one. + + + + + + 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(self, String tip) + Attach a tooltip to the window. + + + + + + SetToolTip(self, ToolTip tip) + Attach a tooltip to the window. + + + + + + GetToolTip(self) -> ToolTip + get the associated tooltip or None if none + + + SetDropTarget(self, DropTarget dropTarget) + Associates a drop target with this window. If the window already has +a drop target, it is deleted. + + + + + + GetDropTarget(self) -> DropTarget + Returns the associated drop target, which may be None. + + + 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 +constraints. + +You must call SetAutoLayout to tell a window to use the constraints +automatically in its default EVT_SIZE handler; otherwise, you must +handle EVT_SIZE yourself and call Layout() explicitly. When setting +both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have +effect. + + + + + + GetConstraints(self) -> LayoutConstraints + Returns a pointer to the window's layout constraints, or None if there +are none. + + + SetAutoLayout(self, bool autoLayout) + Determines whether the Layout function will be called automatically +when the window is resized. It is called implicitly by SetSizer but +if you use SetConstraints you should call it manually or otherwise the +window layout won't be correctly updated when its size changes. + + + + + + GetAutoLayout(self) -> bool + Returns the current autoLayout setting + + + 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(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 +if the deleteOld parameter is true. Note that this function will also +call SetAutoLayout implicitly with a True parameter if the sizer is +non-NoneL and False otherwise. + + + + + + + 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. + + + + + + + GetSizer(self) -> Sizer + Return the sizer associated with the window by a previous call to +SetSizer or None if there isn't one. + + + 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. + + + + + + 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): + """ + Convenience function for converting a Point or (x,y) in + dialog units to pixel units. + """ + if y is None: + return win.ConvertDialogPointToPixels(point_or_x) + else: + return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y)) + +def DLG_SZE(win, size_width, height=None): + """ + Convenience function for converting a Size or (w,h) in + dialog units to pixel units. + """ + if height is None: + return win.ConvertDialogSizeToPixels(size_width) + else: + return win.ConvertDialogSizeToPixels(wx.Size(size_width, height)) + + + FindWindowById(long id, Window parent=None) -> Window + Find the first window in the application with the given id. If parent +is None, the search will start from all top-level frames and dialog +boxes; if non-None, the search will be limited to the given window +hierarchy. The search is recursive in both cases. - - - - - - - - - - SetVirtualSizeHints(int minW, int minH, int maxW=-1, int maxH=-1) - - - - - - - - - GetMinWidth() -> int - - - GetMinHeight() -> int - - - GetMaxWidth() -> int - - - GetMaxHeight() -> int - - - GetMaxSize() -> Size - - - SetVirtualSize(Size size) - Set the the virtual size of a window. 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. - - - - - - SetVirtualSizeWH(int w, int h) - Set the the virtual size of a window. 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. - - - - - - - GetVirtualSize() -> Size - Get the the virtual size of the window. 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. - - - GetVirtualSizeTuple() -> (width, height) - Get the the virtual size of the window. 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. - - - - - - - GetBestVirtualSize() -> Size - - - Show(bool show=True) -> bool - - - - - - Hide() -> bool - - - Enable(bool enable=True) -> bool - - - - - - Disable() -> bool - - - IsShown() -> bool - - - IsEnabled() -> bool - - - SetWindowStyleFlag(long style) - - - - - - GetWindowStyleFlag() -> long - - - SetWindowStyle(long style) - - - - - - GetWindowStyle() -> long - - - HasFlag(int flag) -> bool - - - - - - IsRetained() -> bool - - - SetExtraStyle(long exStyle) - - - - - - GetExtraStyle() -> long - - - MakeModal(bool modal=True) - - - - - - SetThemeEnabled(bool enableTheme) - - - - - - GetThemeEnabled() -> bool - - - ShouldInheritColours() -> bool - - - SetFocus() - - - SetFocusFromKbd() - - - Window.FindFocus() -> Window - - - AcceptsFocus() -> bool - - - AcceptsFocusFromKeyboard() -> bool - - - GetDefaultItem() -> Window - - - SetDefaultItem(Window child) -> Window - - - - - - SetTmpDefaultItem(Window win) - - - - - - GetChildren() -> PyObject - - - GetParent() -> Window - - - GetGrandParent() -> Window - - - IsTopLevel() -> bool - - - Reparent(Window newParent) -> bool - - - - - - AddChild(Window child) - - - - - - RemoveChild(Window child) - - - - - - FindWindowById(long winid) -> Window - - - - - - FindWindowByName(String name) -> Window - - - - - - GetEventHandler() -> EvtHandler - - - SetEventHandler(EvtHandler handler) - - - - - - PushEventHandler(EvtHandler handler) - - + + - - PopEventHandler(bool deleteHandler=False) -> EvtHandler + + FindWindowByName(String name, Window parent=None) -> Window + Find a window by its name (as given in a window constructor or Create +function call). If parent is None, the search will start from all +top-level frames and dialog boxes; if non-None, the search will be +limited to the given window hierarchy. The search is recursive in both +cases. + +If no window with such name is found, wx.FindWindowByLabel is called. - + + - - RemoveEventHandler(EvtHandler handler) -> bool + + FindWindowByLabel(String label, Window parent=None) -> Window + Find a window by its label. Depending on the type of window, the label +may be a window title or panel item label. If parent is None, the +search will start from all top-level frames and dialog boxes; if +non-None, the search will be limited to the given window +hierarchy. The search is recursive in both cases. - + + - - SetValidator(Validator validator) + + Window_FromHWND(Window parent, unsigned long _hWnd) -> Window - + + - - GetValidator() -> Validator - - - SetAcceleratorTable(AcceleratorTable accel) - - - - - - GetAcceleratorTable() -> AcceleratorTable - - - RegisterHotKey(int hotkeyId, int modifiers, int keycode) -> bool - - - - - - - - UnregisterHotKey(int hotkeyId) -> bool - - - - - - ConvertDialogPointToPixels(Point pt) -> Point - - - - - - ConvertDialogSizeToPixels(Size sz) -> Size - - - - - - DLG_PNT(Point pt) -> Point - - - - - - DLG_SZE(Size sz) -> Size - - - - - - ConvertPixelPointToDialog(Point pt) -> Point - - - - - - ConvertPixelSizeToDialog(Size sz) -> Size - - - - - - WarpPointer(int x, int y) - - - - - - - CaptureMouse() - - - ReleaseMouse() - - - Window.GetCapture() -> Window - - - HasCapture() -> bool - - - Refresh(bool eraseBackground=True, Rect rect=None) - - - - - - - RefreshRect(Rect rect) - - - - - - Update() - - - ClearBackground() - - - Freeze() - - - Thaw() - - - PrepareDC(DC dc) - - - - - - GetUpdateRegion() -> Region - - - GetUpdateClientRect() -> Rect - - - IsExposed(int x, int y, int w=1, int h=1) -> bool - - - - - - - - - IsExposedPoint(Point pt) -> bool - - - - - - isExposedRect(Rect rect) -> bool - - - - - - SetBackgroundColour(Colour colour) -> bool - - - - - - SetForegroundColour(Colour colour) -> bool - - - - - - GetBackgroundColour() -> Colour - - - GetForegroundColour() -> Colour - - - SetCursor(Cursor cursor) -> bool - - - - - - GetCursor() -> Cursor - - - SetFont(Font font) -> bool - - - - - - GetFont() -> Font - - - SetCaret(Caret caret) - - - - - - GetCaret() -> Caret - - - GetCharHeight() -> int - - - GetCharWidth() -> int - - - GetTextExtent(String string) -> (width, height) - Get the width and height of the text using the current font. - - - - - - - - GetFullTextExtent(String string, Font font=None) -> - (width, height, descent, externalLeading) - Get the width, height, decent and leading of the text using the current or specified font. - - - - - - - - - - - ClientToScreenXY(int x, int y) - - - - - - - ScreenToClientXY(int x, int y) - - - - - - - ClientToScreen(Point pt) -> Point - - - - - - ScreenToClient(Point pt) -> Point - - - - - - HitTestXY(int x, int y) -> int - - - - - - - HitTest(Point pt) -> int - - - - - - GetBorderFlags(long flags) -> int - - - - - - GetBorder() -> int - - - UpdateWindowUI(long flags=UPDATE_UI_NONE) - - - - - - PopupMenuXY(Menu menu, int x, int y) -> bool - - - - - - - - PopupMenu(Menu menu, Point pos) -> bool - - - - - - - GetHandle() -> long - - - HasScrollbar(int orient) -> bool - - - - - - SetScrollbar(int orient, int pos, int thumbvisible, int range, bool refresh=True) - - - - - - - - - - SetScrollPos(int orient, int pos, bool refresh=True) - - - - - - - - GetScrollPos(int orient) -> int - - - - - - GetScrollThumb(int orient) -> int - - - - - - GetScrollRange(int orient) -> int - - - - - - ScrollWindow(int dx, int dy, Rect rect=None) - - - - - - - - ScrollLines(int lines) -> bool - - - - - - ScrollPages(int pages) -> bool - - - - - - LineUp() -> bool - - - LineDown() -> bool - - - PageUp() -> bool - - - PageDown() -> bool - - - SetHelpText(String text) - - - - - - SetHelpTextForId(String text) - - - - - - GetHelpText() -> String - - - SetToolTipString(String tip) - - - - - - SetToolTip(ToolTip tip) - - - - - - GetToolTip() -> ToolTip - - - SetDropTarget(PyDropTarget dropTarget) - - - - - - GetDropTarget() -> PyDropTarget - - - SetConstraints(LayoutConstraints constraints) - - - - - - GetConstraints() -> LayoutConstraints - - - SetAutoLayout(bool autoLayout) - - - - - - GetAutoLayout() -> bool - - - Layout() -> bool - - - SetSizer(Sizer sizer, bool deleteOld=True) - - - - - - - SetSizerAndFit(Sizer sizer, bool deleteOld=True) - - - - - - - GetSizer() -> Sizer - - - SetContainingSizer(Sizer sizer) - - - - - - GetContainingSizer() -> Sizer - - - -def DLG_PNT(win, point_or_x, y=None): - if y is None: - return win.ConvertDialogPointToPixels(point_or_x) - else: - return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y)) + +#--------------------------------------------------------------------------- + + + + + __init__(self) -> Validator + + + Clone(self) -> Validator + + + Validate(self, Window parent) -> bool + + + + + + TransferToWindow(self) -> bool + + + TransferFromWindow(self) -> bool + + + GetWindow(self) -> Window + + + SetWindow(self, Window window) + + + + + + IsSilent() -> bool + + + SetBellOnError(int doIt=True) + + + + + + + + + __init__(self) -> PyValidator + + + _setCallbackInfo(self, PyObject self, PyObject _class, int incref=True) + + + + + + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, String title=EmptyString, long style=0) -> Menu + + + + + + + Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem + + + + + + + + + AppendSeparator(self) -> MenuItem + + + AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem + + + + + + + + AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem + + + + + + + + AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem + + + + + + + + + AppendItem(self, MenuItem item) -> MenuItem + + + + + + Break(self) + + + InsertItem(self, size_t pos, MenuItem item) -> MenuItem + + + + + + + Insert(self, size_t pos, int id, String text, String help=EmptyString, + int kind=ITEM_NORMAL) -> MenuItem + + + + + + + + + + InsertSeparator(self, size_t pos) -> MenuItem + + + + + + InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem + + + + + + + + + InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem + + + + + + + + + InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem + + + + + + + + + + PrependItem(self, MenuItem item) -> MenuItem + + + + + + Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem + + + + + + + + + PrependSeparator(self) -> MenuItem + + + PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem + + + + + + + + PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem + + + + + + + + PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem + + + + + + + + + Remove(self, int id) -> MenuItem + + + + + + RemoveItem(self, MenuItem item) -> MenuItem + + + + + + Delete(self, int id) -> bool + + + + + + DeleteItem(self, MenuItem item) -> bool + + + + + + Destroy(self) + Deletes the C++ object this Python object is a proxy for. + + + DestroyId(self, int id) -> bool + Deletes the C++ object this Python object is a proxy for. + + + + + + DestroyItem(self, MenuItem item) -> bool + Deletes the C++ object this Python object is a proxy for. + + + + + + GetMenuItemCount(self) -> size_t + + + GetMenuItems(self) -> PyObject + + + FindItem(self, String item) -> int + + + + + + FindItemById(self, int id) -> MenuItem + + + + + + FindItemByPosition(self, size_t position) -> MenuItem + + + + + + Enable(self, int id, bool enable) + + + + + + + IsEnabled(self, int id) -> bool + + + + + + Check(self, int id, bool check) + + + + + + + IsChecked(self, int id) -> bool + + + + + + SetLabel(self, int id, String label) + + + + + + + GetLabel(self, int id) -> String + + + + + + SetHelpString(self, int id, String helpString) + + + + + + + GetHelpString(self, int id) -> String + + + + + + SetTitle(self, String title) + + + + + + GetTitle(self) -> String + + + SetEventHandler(self, EvtHandler handler) + + + + + + GetEventHandler(self) -> EvtHandler + + + SetInvokingWindow(self, Window win) + + + + + + GetInvokingWindow(self) -> Window + + + GetStyle(self) -> long + + + UpdateUI(self, EvtHandler source=None) + + + + + + GetMenuBar(self) -> MenuBar + + + Attach(self, wxMenuBarBase menubar) + + + + + + Detach(self) + + + IsAttached(self) -> bool + + + SetParent(self, Menu parent) + + + + + + GetParent(self) -> Menu + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, long style=0) -> MenuBar + + + + + + Append(self, Menu menu, String title) -> bool + + + + + + + Insert(self, size_t pos, Menu menu, String title) -> bool + + + + + + + + GetMenuCount(self) -> size_t + + + GetMenu(self, size_t pos) -> Menu + + + + + + Replace(self, size_t pos, Menu menu, String title) -> Menu + + + + + + + + Remove(self, size_t pos) -> Menu + + + + + + EnableTop(self, size_t pos, bool enable) + + + + + + + IsEnabledTop(self, size_t pos) -> bool + + + + + + SetLabelTop(self, size_t pos, String label) + + + + + + + GetLabelTop(self, size_t pos) -> String + + + + + + FindMenuItem(self, String menu, String item) -> int + + + + + + + FindItemById(self, int id) -> MenuItem + + + + + + FindMenu(self, String title) -> int + + + + + + Enable(self, int id, bool enable) + + + + + + + Check(self, int id, bool check) + + + + + + + IsChecked(self, int id) -> bool + + + + + + IsEnabled(self, int id) -> bool + + + + + + SetLabel(self, int id, String label) + + + + + + + GetLabel(self, int id) -> String + + + + + + SetHelpString(self, int id, String helpString) + + + + + + + GetHelpString(self, int id) -> String + + + + + + GetFrame(self) -> wxFrame + + + IsAttached(self) -> bool + + + Attach(self, wxFrame frame) + + + + + + Detach(self) + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString, + String help=EmptyString, int kind=ITEM_NORMAL, + Menu subMenu=None) -> MenuItem + + + + + + + + + + + GetMenu(self) -> Menu + + + SetMenu(self, Menu menu) + + + + + + SetId(self, int id) + + + + + + GetId(self) -> int + + + IsSeparator(self) -> bool + + + SetText(self, String str) + + + + + + GetLabel(self) -> String + + + GetText(self) -> String + + + GetLabelFromText(String text) -> String + + + + + + GetKind(self) -> int + + + SetKind(self, int kind) + + + + + + SetCheckable(self, bool checkable) + + + + + + IsCheckable(self) -> bool + + + IsSubMenu(self) -> bool + + + SetSubMenu(self, Menu menu) + + + + + + GetSubMenu(self) -> Menu + + + Enable(self, bool enable=True) + + + + + + IsEnabled(self) -> bool + + + Check(self, bool check=True) + + + + + + IsChecked(self) -> bool + + + Toggle(self) + + + SetHelp(self, String str) + + + + + + GetHelp(self) -> String + + + GetAccel(self) -> AcceleratorEntry + + + SetAccel(self, AcceleratorEntry accel) + + + + + + GetDefaultMarginWidth() -> int + + + SetBitmap(self, Bitmap bitmap) + + + + + + GetBitmap(self) -> Bitmap + + + +#--------------------------------------------------------------------------- + + + This is the base class for a control or 'widget'. -def DLG_SZE(win, size_width, height=None): - if height is None: - return win.ConvertDialogSizeToPixels(size_width) - else: - return win.ConvertDialogSizeToPixels(wx.Size(size_width, height)) +A control is generally a small window which processes user input +and/or displays one or more item of data. + + + __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. + + + + + + + + + + + + PreControl() -> Control + Precreate a Control control for 2-phase creation + + + 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. + + + + + + + + + + + + Command(self, CommandEvent event) + Simulates the effect of the user issuing a command to the item. + +:see: `wx.CommandEvent` + + + + + + + GetLabel(self) -> String + Return a control's text. + + + 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. + + + + + + +#--------------------------------------------------------------------------- - - FindWindowById(long id, Window parent=None) -> Window - - - - - - - FindWindowByName(String name, Window parent=None) -> Window - - - - - - - FindWindowByLabel(String label, Window parent=None) -> Window - - - - - - - Window_FromHWND(unsigned long hWnd) -> Window - - - - - + + wx.ItemContainer defines an interface which is implemented by all +controls which have string subitems, each of which may be selected, +such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as +`wx.ComboBox` which implements an extended interface deriving from +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. + +The items in a wx.ItemContainer have (non empty) string labels and, +optionally, client data associated with them. + + + 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(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(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. + + + + + + + + Clear(self) + Removes all items from 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(self) -> int + Returns the number of items in the control. + + + IsEmpty(self) -> bool + Returns True if the control is empty or False if it has some items. + + + GetString(self, int n) -> String + Returns the label of the item with the given index. + + + + + + GetStrings(self) -> wxArrayString + + + SetString(self, int n, String s) + Sets the label for the given item. + + + + + + + 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. + + + + + + Select(self, int n) + Sets the item at index 'n' to be the selected item. + + + + + + GetSelection(self) -> int + Returns the index of the selected item or ``wx.NOT_FOUND`` 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(self, int n) -> PyObject + Returns the client data associated with the given item, (if any.) + + + + + + SetClientData(self, int n, PyObject clientData) + Associate the given client data with the item at position n. + + + + + + + #--------------------------------------------------------------------------- - - - - __init__() -> Validator - - - Clone() -> Validator - - - Validate(Window parent) -> bool - - - - - - TransferToWindow() -> bool - - - TransferFromWindow() -> bool - - - GetWindow() -> Window - - - SetWindow(Window window) - - - - - - Validator.IsSilent() -> bool - - - Validator.SetBellOnError(int doIt=True) - - - - - - - - - __init__() -> PyValidator - - - _setCallbackInfo(PyObject self, PyObject _class, int incref=True) - - - - - - - - + + 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. + + + + #--------------------------------------------------------------------------- - - - - __init__(String title=EmptyString, long style=0) -> Menu - - - - - - - Append(int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) - - - - - - - - - AppendSeparator() - - - AppendCheckItem(int id, String text, String help=EmptyString) - - - - - - - - AppendRadioItem(int id, String text, String help=EmptyString) - - - - - - - - AppendMenu(int id, String text, Menu submenu, String help=EmptyString) - - - - - - - - - AppendItem(MenuItem item) - - - - - - Break() - - - InsertItem(size_t pos, MenuItem item) -> bool - - - - - - - Insert(size_t pos, int id, String text, String help=EmptyString, - int kind=ITEM_NORMAL) - - - - - - - - - - InsertSeparator(size_t pos) - - - - - - InsertCheckItem(size_t pos, int id, String text, String help=EmptyString) - - - - - - - - - InsertRadioItem(size_t pos, int id, String text, String help=EmptyString) - - - - - - - - - InsertMenu(size_t pos, int id, String text, Menu submenu, String help=EmptyString) - - - - - - - - - - PrependItem(MenuItem item) - - - - - - Prepend(int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) - - - - - - - - - PrependSeparator() - - - PrependCheckItem(int id, String text, String help=EmptyString) - - - - - - - - PrependRadioItem(int id, String text, String help=EmptyString) - - - - - - - - PrependMenu(int id, String text, Menu submenu, String help=EmptyString) - - - - - - - - - Remove(int id) -> MenuItem - - - - - - RemoveItem(MenuItem item) -> MenuItem - - - - - - Delete(int id) -> bool - - - - - - DeleteItem(MenuItem item) -> bool - - - - - - Destroy() - Deletes the C++ object this Python object is a proxy for. - - - DestroyId(int id) -> bool - Deletes the C++ object this Python object is a proxy for. - - - - - - DestroyItem(MenuItem item) -> bool - Deletes the C++ object this Python object is a proxy for. - - - - - - GetMenuItemCount() -> size_t - - - GetMenuItems() -> PyObject - - - FindItem(String item) -> int - - - - - - FindItemById(int id) -> MenuItem - - - - - - FindItemByPosition(size_t position) -> MenuItem - - - - - - Enable(int id, bool enable) - - - - - - - IsEnabled(int id) -> bool - - - - - - Check(int id, bool check) - - - - - - - IsChecked(int id) -> bool - - - - - - SetLabel(int id, String label) - - - - - - - GetLabel(int id) -> String - - - - - - SetHelpString(int id, String helpString) - - - - - - - GetHelpString(int id) -> String - - - - - - SetTitle(String title) - - - - - - GetTitle() -> String - - - SetEventHandler(EvtHandler handler) - - - - - - GetEventHandler() -> EvtHandler - - - SetInvokingWindow(Window win) - - - - - - GetInvokingWindow() -> Window - - - GetStyle() -> long - - - UpdateUI(EvtHandler source=None) - - - - - - GetMenuBar() -> MenuBar - - - Attach(wxMenuBarBase menubar) - - - - - - Detach() - - - IsAttached() -> bool - - - SetParent(Menu parent) - - - - - - GetParent() -> Menu - - - + + 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__(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` + + + SizerItemWindow(Window window, int proportion, int flag, int border, + PyObject userData=None) -> SizerItem + Constructs a `wx.SizerItem` for tracking a window. + + + + + + + + + + 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, + PyObject userData=None) -> SizerItem + Constructs a `wx.SizerItem` for tracking a subsizer + + + + + + + + + + DeleteWindows(self) + Destroy the window or the windows in a subsizer, depending on the type +of item. + + + DetachSizer(self) + Enable deleting the SizerItem without destroying the contained sizer. + + + GetSize(self) -> Size + Get the current size of the item, as set in the last Layout. + + + CalcMin(self) -> Size + Calculates the minimum desired size for the item, including any space +needed by borders. + + + 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(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(self, int x, int y) + + + + + + + SetRatioWH(self, int width, int height) + Set the ratio item attribute. + + + + + + + SetRatioSize(self, Size size) + Set the ratio item attribute. + + + + + + SetRatio(self, float ratio) + Set the ratio item attribute. + + + + + + GetRatio(self) -> float + Set the ratio item attribute. + + + IsWindow(self) -> bool + Is this sizer item a window? + + + IsSizer(self) -> bool + Is this sizer item a subsizer? + + + IsSpacer(self) -> bool + Is this sizer item a spacer? + + + SetProportion(self, int proportion) + Set the proportion value for this item. + + + + + + GetProportion(self) -> int + Get the proportion value for this item. + + + SetFlag(self, int flag) + Set the flag value for this item. + + + + + + GetFlag(self) -> int + Get the flag value for this item. + + + SetBorder(self, int border) + Set the border value for this item. + + + + + + GetBorder(self) -> int + Get the border value for this item. + + + GetWindow(self) -> Window + Get the window (if any) that is managed by this sizer item. + + + SetWindow(self, Window window) + Set the window to be managed by this sizer item. + + + + + + GetSizer(self) -> Sizer + Get the subsizer (if any) that is managed by this sizer item. + + + SetSizer(self, Sizer sizer) + Set the subsizer to be managed by this sizer item. + + + + + + GetSpacer(self) -> Size + Get the size of the spacer managed by this sizer item. + + + SetSpacer(self, Size size) + Set the size of the spacer to be managed by this sizer item. + + + + + + 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(self) -> bool + Is the item to be shown in the layout? + + + GetPosition(self) -> Point + Returns the current position of the item, as set in the last Layout. + + + 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(self, PyObject _self) + + + + + + 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. + + + + + + + + + + + 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. + + + + + + + + + + + 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. + + + + + + + + + + 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(self, PyObject item, Size size) + + + + + + + AddItem(self, SizerItem item) + Adds a `wx.SizerItem` to the sizer. + + + + + + InsertItem(self, int index, SizerItem item) + Inserts a `wx.SizerItem` to the sizer at the position given by *index*. + + + + + + + PrependItem(self, SizerItem item) + Prepends a `wx.SizerItem` to the sizer. + + + + + + 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. + + + + + + + + + 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(self) -> Size + Returns the current size of the space managed by the sizer. + + + GetPosition(self) -> Point + Returns the current position of the sizer's managed space. + + + 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(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(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(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(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(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(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(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(self, bool deleteWindows=False) + Clear all items from the sizer, optionally destroying the window items +as well. + + + + + + DeleteWindows(self) + Destroy all windows managed by the sizer. + + + GetChildren(sefl) -> list + Returns a list of all the `wx.SizerItem` objects managed by the sizer. + + + 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. + + + + + + + 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(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__(self) -> PySizer + Creates a wx.PySizer. Must be called from the __init__ in the derived +class. + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + #--------------------------------------------------------------------------- - - - - __init__(long style=0) -> MenuBar - - - - - - Append(Menu menu, String title) -> bool - - - - - - - Insert(size_t pos, Menu menu, String title) -> bool - - - - - - - - GetMenuCount() -> size_t - - - GetMenu(size_t pos) -> Menu - - - - - - Replace(size_t pos, Menu menu, String title) -> Menu - - - - - - - - Remove(size_t pos) -> Menu - - - - - - EnableTop(size_t pos, bool enable) - - - - - - - IsEnabledTop(size_t pos) -> bool - - - - - - SetLabelTop(size_t pos, String label) - - - - - - - GetLabelTop(size_t pos) -> String - - - - - - FindMenuItem(String menu, String item) -> int - - - - - - - FindItemById(int id) -> MenuItem - - - - - - FindMenu(String title) -> int - - - - - - Enable(int id, bool enable) - - - - - - - Check(int id, bool check) - - - - - - - IsChecked(int id) -> bool - - - - - - IsEnabled(int id) -> bool - - - - - - SetLabel(int id, String label) - - - - - - - GetLabel(int id) -> String - - - - - - SetHelpString(int id, String helpString) - - - - - - - GetHelpString(int id) -> String - - - - - - GetFrame() -> wxFrame - - - IsAttached() -> bool - - - Attach(wxFrame frame) - - - - - - Detach() - - - + + 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__(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(self) -> int + Returns the current orientation of the sizer. + + + SetOrientation(self, int orient) + Resets the orientation of the sizer. + + + + + + #--------------------------------------------------------------------------- - - - - __init__(Menu parentMenu=None, int id=ID_SEPARATOR, String text=EmptyString, - String help=EmptyString, int kind=ITEM_NORMAL, - Menu subMenu=None) -> MenuItem - - - - - - - - - - - GetMenu() -> Menu - - - SetMenu(Menu menu) - - - - - - SetId(int id) - - - - - - GetId() -> int - - - IsSeparator() -> bool - - - SetText(String str) - - - - - - GetLabel() -> String - - - GetText() -> String - - - MenuItem.GetLabelFromText(String text) -> String - - - - - - GetKind() -> int - - - SetCheckable(bool checkable) - - - - - - IsCheckable() -> bool - - - IsSubMenu() -> bool - - - SetSubMenu(Menu menu) - - - - - - GetSubMenu() -> Menu - - - Enable(bool enable=True) - - - - - - IsEnabled() -> bool - - - Check(bool check=True) - - - - - - IsChecked() -> bool - - - Toggle() - - - SetHelp(String str) - - - - - - GetHelp() -> String - - - GetAccel() -> AcceleratorEntry - - - SetAccel(AcceleratorEntry accel) - - - - - - MenuItem.GetDefaultMarginWidth() -> int - - - SetBitmap(Bitmap bitmap) - - - - - - GetBitmap() -> Bitmap - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, Validator validator=DefaultValidator, - String name=ControlNameStr) -> Control - - - - - - - - - - - - PreControl() -> Control - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, Validator validator=DefaultValidator, - String name=ControlNameStr) -> bool - - - - - - - - - - - - Command(CommandEvent event) - - - - - - GetLabel() -> String - - - SetLabel(String label) - - - - - - + + 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__(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(self) -> StaticBox + Returns the static box associated with this sizer. + + + #--------------------------------------------------------------------------- - - - Append(String item, PyObject clientData=None) -> int - - - - - - - AppendItems(wxArrayString strings) - - - - - - Insert(String item, int pos, PyObject clientData=None) -> int - - - - - - - - Clear() - - - Delete(int n) - - - - - - GetCount() -> int - - - IsEmpty() -> bool - - - GetString(int n) -> String - - - - - - GetStrings() -> wxArrayString - - - SetString(int n, String s) - - - - - - - FindString(String s) -> int - - - - - - Select(int n) - - - - - - GetSelection() -> int - - - GetStringSelection() -> String - - - GetClientData(int n) -> PyObject - - - - - - SetClientData(int n, PyObject clientData) - - - - - - - + + 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__(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. + + + + + + + + + SetCols(self, int cols) + Sets the number of columns in the sizer. + + + + + + SetRows(self, int rows) + Sets the number of rows in the sizer. + + + + + + SetVGap(self, int gap) + Sets the vertical gap (in pixels) between the cells in the sizer. + + + + + + SetHGap(self, int gap) + Sets the horizontal gap (in pixels) between cells in the sizer + + + + + + GetCols(self) -> int + Returns the number of columns in the sizer. + + + GetRows(self) -> int + Returns the number of rows in the sizer. + + + GetVGap(self) -> int + Returns the vertical gap (in pixels) between the cells in the sizer. + + + 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__(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. + + + + + + + + + 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(self, size_t idx) + Specifies that row *idx* is no longer growable. + + + + + + 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(self, size_t idx) + Specifies that column *idx* is no longer growable. + + + + + + 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(self) -> int + Returns a value that specifies whether the sizer +flexibly resizes its columns, rows, or both (default). + +:see: `SetFlexibleDirection` + + + 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(self) -> int + Returns the value that specifies how the sizer grows in the +non-flexible direction if there is one. + +:see: `SetNonFlexibleGrowMode` + + + GetRowHeights(self) -> list + Returns a list of integers representing the heights of each of the +rows in the sizer. + + + GetColWidths(self) -> list + Returns a list of integers representing the widths of each of the +columns in the sizer. + + + #--------------------------------------------------------------------------- - - - - __init__() -> SizerItem - - - SizerItemSpacer(int width, int height, int proportion, int flag, int border, - Object userData) -> SizerItem - - - - - - - - - - - SizerItemWindow(Window window, int proportion, int flag, int border, - Object userData) -> SizerItem - - - - - - - - - - SizerItemSizer(Sizer sizer, int proportion, int flag, int border, - Object userData) -> SizerItem - - - - - - - - - - DeleteWindows() - - - DetachSizer() - - - GetSize() -> Size - - - CalcMin() -> Size - - - SetDimension(Point pos, Size size) - - - - - - - GetMinSize() -> Size - - - SetInitSize(int x, int y) - - - - - - - SetRatioWH(int width, int height) - - - - - - - SetRatioSize(Size size) - - - - - - SetRatio(float ratio) - - - - - - GetRatio() -> float - - - IsWindow() -> bool - - - IsSizer() -> bool - - - IsSpacer() -> bool - - - SetProportion(int proportion) - - - - - - GetProportion() -> int - - - SetFlag(int flag) - - - - - - GetFlag() -> int - - - SetBorder(int border) - - - - - - GetBorder() -> int - - - GetWindow() -> Window - - - SetWindow(Window window) - - - - - - GetSizer() -> Sizer - - - SetSizer(Sizer sizer) - - - - - - GetSpacer() -> Size - - - SetSpacer(Size size) - - - - - - Show(bool show) - - - - - - IsShown() -> bool - - - GetPosition() -> Point - - - GetUserData() -> PyObject - - - - - - _setOORInfo(PyObject _self) - - - - - - Add(PyObject item, int proportion=0, int flag=0, int border=0, - PyObject userData=None) - - - - - - - - - - Insert(int before, PyObject item, int proportion=0, int flag=0, - int border=0, PyObject userData=None) - - - - - - - - - - - Prepend(PyObject item, int proportion=0, int flag=0, int border=0, - PyObject userData=None) - - - - - - - - - - Remove(PyObject item) -> bool - - - - - - _SetItemMinSize(PyObject item, Size size) - - - - - - - AddItem(SizerItem item) - - - - - - InsertItem(size_t index, SizerItem item) - - - - - - - PrependItem(SizerItem item) - - - - - - SetDimension(int x, int y, int width, int height) - - - - - - - - - SetMinSize(Size size) - - - - - - GetSize() -> Size - - - GetPosition() -> Point - - - GetMinSize() -> Size - - - RecalcSizes() - - - CalcMin() -> Size - - - Layout() - - - Fit(Window window) -> Size - - - - - - FitInside(Window window) - - - - - - SetSizeHints(Window window) - - - - - - SetVirtualSizeHints(Window window) - - - - - - Clear(bool delete_windows=False) - - - - - - DeleteWindows() - - - GetChildren() -> PyObject - - - Show(PyObject item, bool show=True) - - - - - - - Hide(PyObject item) - - - - - - IsShown(PyObject item) -> bool - - - - - - ShowItems(bool show) - - - - - - - - - __init__() -> PySizer - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - + + 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__(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(self) -> int + + + GetCol(self) -> int + + + SetRow(self, int row) + + + + + + SetCol(self, int col) + + + + + + __eq__(self, GBPosition other) -> bool + + + + + + __ne__(self, GBPosition other) -> bool + + + + + + Set(self, int row=0, int col=0) + + + + + + + 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__(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(self) -> int + + + GetColspan(self) -> int + + + SetRowspan(self, int rowspan) + + + + + + SetColspan(self, int colspan) + + + + + + __eq__(self, GBSpan other) -> bool + + + + + + __ne__(self, GBSpan other) -> bool + + + + + + Set(self, int rowspan=1, int colspan=1) + + + + + + + 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__(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, PyObject userData=None) -> GBSizerItem + Construct a `wx.GBSizerItem` for a window. + + + + + + + + + + + GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag, + 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, PyObject userData=None) -> GBSizerItem + Construct a `wx.GBSizerItem` for a spacer. + + + + + + + + + + + + GetPos(self) -> GBPosition + Get the grid position of the item + + + GetSpan(self) -> GBSpan + Get the row and column spanning of the item + + + 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(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. + + + + + + IntersectsPos(self, GBPosition pos, GBSpan span) -> bool + Returns True if the given pos/span would intersect with this item. + + + + + + + GetEndPos(self) -> GBPosition + Get the row and column of the endpoint of this item. + + + GetGBSizer(self) -> GridBagSizer + Get the sizer this item is a member of. + + + 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__(self, int vgap=0, int hgap=0) -> GridBagSizer + Constructor, with optional parameters to specify the gap between the +rows and columns. + + + + + + + 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. + + + + + + + + + + + + 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(self) -> Size + Get the size used for cells in the grid with no item. + + + 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(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(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(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(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(self, item) -> GBSizerItem + +Find the sizer item for the given window or subsizer, returns None if +not found. (non-recursive) + + + + + + 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(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) + + + + + + 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. + + + + + + + + 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. + + + + + + + + #--------------------------------------------------------------------------- - - - - __init__(int orient=HORIZONTAL) -> BoxSizer - - - - - - GetOrientation() -> int - - - SetOrientation(int orient) - - - - - - RecalcSizes() - - - CalcMin() -> Size - - - + + 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. + +The Edge specifies the type of edge or dimension of a window. + +Edges +------ + ================== ============================================== + wx.Left The left edge. + wx.Top The top edge. + wx.Right The right edge. + wx.Bottom The bottom edge. + wx.CentreX The x-coordinate of the centre of the window. + wx.CentreY The y-coordinate of the centre of the window. + ================== ============================================== + + +The Relationship specifies the relationship that this edge or +dimension has with another specified edge or dimension. Normally, the +user doesn't use these directly because functions such as Below and +RightOf are a convenience for using the more general Set function. + +Relationships +------------- + ================== ============================================== + wx.Unconstrained The edge or dimension is unconstrained + (the default for edges.) + wx.AsIs The edge or dimension is to be taken from the current + window position or size (the default for dimensions.) + wx.Above The edge should be above another edge. + wx.Below The edge should be below another edge. + wx.LeftOf The edge should be to the left of another edge. + wx.RightOf The edge should be to the right of another edge. + wx.SameAs The edge or dimension should be the same as another edge + or dimension. + wx.PercentOf The edge or dimension should be a percentage of another + edge or dimension. + wx.Absolute The edge or dimension should be a given absolute value. + ================== ============================================== + +:see: `wx.LayoutConstraints`, `wx.Window.SetConstraints` + + + + 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. + + + + + + + + + + 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(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(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(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(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. + + + + + + + + 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. + + + + + + + + Absolute(self, int val) + Constrains this edge or dimension to be the given absolute value. + + + + + + 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(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(self) -> Window + + + GetMyEdge(self) -> int + + + SetEdge(self, int which) + + + + + + SetValue(self, int v) + + + + + + GetMargin(self) -> int + + + SetMargin(self, int m) + + + + + + GetValue(self) -> int + + + GetPercent(self) -> int + + + GetOtherEdge(self) -> int + + + GetDone(self) -> bool + + + SetDone(self, bool d) + + + + + + GetRelationship(self) -> int + + + SetRelationship(self, int r) + + + + + + ResetIfWin(self, Window otherW) -> bool + Reset constraint if it mentions otherWin + + + + + + SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool + Try to satisfy constraint + + + + + + + GetEdge(self, int which, Window thisWin, Window other) -> int + Get the value of this edge or dimension, or if this +is not determinable, -1. + + + + + + + + + **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. + +The class consists of the following eight constraints of class +wx.IndividualLayoutConstraint, some or all of which should be accessed +directly to set the appropriate constraints. + + * left: represents the left hand edge of the window + * right: represents the right hand edge of the window + * top: represents the top edge of the window + * bottom: represents the bottom edge of the window + * width: represents the width of the window + * height: represents the height of the window + * 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 ``wx.AsIs``, the dimension will not be changed. + +:see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints` + + + + __init__(self) -> LayoutConstraints + + + + + + + + + + + SatisfyConstraints(Window win) -> (areSatisfied, noChanges) + + + + + + + AreSatisfied(self) -> bool + + + #---------------------------------------------------------------------------- + +# Use Python's bool constants if available, make some if not +try: + True +except NameError: + __builtins__.True = 1==1 + __builtins__.False = 1==0 + def bool(value): return not not value + __builtins__.bool = bool + + + +# workarounds for bad wxRTTI names +__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge' +__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider' +__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar' + + +#---------------------------------------------------------------------------- +# Load version numbers from __version__... Ensure that major and minor +# versions are the same for both wxPython and wxWidgets. + +from __version__ import * +__version__ = VERSION_STRING + +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/wxWidgets release number mismatch") + +#---------------------------------------------------------------------------- + +class PyDeadObjectError(AttributeError): + pass + +class _wxPyDeadObject(object): + """ + Instances of wx objects that are OOR capable will have their __class__ + changed to this class when the C++ object is deleted. This should help + prevent crashes due to referencing a bogus C++ pointer. + """ + reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)" + attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed." + + def __repr__(self): + if not hasattr(self, "_name"): + self._name = "[unknown]" + return self.reprStr % self._name + + def __getattr__(self, *args): + if not hasattr(self, "_name"): + self._name = "[unknown]" + raise PyDeadObjectError(self.attrStr % self._name) + + def __nonzero__(self): + return 0 + + + +class PyUnbornObjectError(AttributeError): + pass + +class _wxPyUnbornObject(object): + """ + 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 + exception will be raised if they are used before the C++ instance + is ready. + """ + + reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)" + attrStr = "The C++ part of this object has not been initialized, attribute access not allowed." + + def __repr__(self): + #if not hasattr(self, "_name"): + # self._name = "[unknown]" + return self.reprStr #% self._name + + def __getattr__(self, *args): + #if not hasattr(self, "_name"): + # self._name = "[unknown]" + raise PyUnbornObjectError(self.attrStr) # % self._name ) + + def __nonzero__(self): + return 0 + + +#---------------------------------------------------------------------------- +_wxPyCallAfterId = None + +def CallAfter(callable, *args, **kw): + """ + Call the specified function after the current and pending event + handlers have been completed. This is also good for making GUI + method calls from non-GUI threads. Any extra positional or + keyword args are passed on to the callable when it is called. + + :see: `wx.FutureCall` + """ + app = wx.GetApp() + assert app is not None, 'No wx.App created yet' + + global _wxPyCallAfterId + if _wxPyCallAfterId is None: + _wxPyCallAfterId = wx.NewEventType() + app.Connect(-1, -1, _wxPyCallAfterId, + lambda event: event.callable(*event.args, **event.kw) ) + evt = wx.PyEvent() + evt.SetEventType(_wxPyCallAfterId) + evt.callable = callable + evt.args = args + evt.kw = kw + wx.PostEvent(app, evt) + + +#---------------------------------------------------------------------------- + + +class FutureCall: + """ + A convenience class for wx.Timer, that calls the given callable + 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. + + 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 + hold a reference to itself while the timer is running (the timer + has a reference to self.Notify) but the cycle will be broken when + the timer completes, automatically cleaning up the wx.FutureCall + object. + + :see: `wx.CallAfter` + """ + def __init__(self, millis, callable, *args, **kwargs): + self.millis = millis + self.callable = callable + self.SetArgs(*args, **kwargs) + self.runCount = 0 + self.running = False + self.hasRun = False + self.result = None + self.timer = None + self.Start() + + def __del__(self): + self.Stop() + + + def Start(self, millis=None, *args, **kwargs): + """ + (Re)start the timer + """ + self.hasRun = False + if millis is not None: + self.millis = millis + if args or kwargs: + self.SetArgs(*args, **kwargs) + self.Stop() + self.timer = wx.PyTimer(self.Notify) + self.timer.Start(self.millis, wx.TIMER_ONE_SHOT) + self.running = True + Restart = Start + + + def Stop(self): + """ + Stop and destroy the timer. + """ + if self.timer is not None: + self.timer.Stop() + self.timer = None + + + def GetInterval(self): + if self.timer is not None: + return self.timer.GetInterval() + else: + return 0 + + + def IsRunning(self): + return self.timer is not None and self.timer.IsRunning() + + + def SetArgs(self, *args, **kwargs): + """ + (Re)set the args passed to the callable object. This is + useful in conjunction with Restart if you want to schedule a + new call to the same callable object but with different + parameters. + """ + self.args = args + self.kwargs = kwargs + + + def HasRun(self): + return self.hasRun + + def GetResult(self): + return self.result + + def Notify(self): + """ + The timer has expired so call the callable. + """ + if self.callable and getattr(self.callable, 'im_self', True): + self.runCount += 1 + self.running = False + self.result = self.callable(*self.args, **self.kwargs) + self.hasRun = True + if not self.running: + # if it wasn't restarted, then cleanup + 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 * + + +# Fixup the stock objects since they can't be used yet. (They will be +# restored in wx.PyApp.OnInit.) +_core_._wxPyFixStockObjects() + +#---------------------------------------------------------------------------- +#---------------------------------------------------------------------------- + + + + + wx = _core + #--------------------------------------------------------------------------- - - - - __init__(wxStaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer - - - - - - - GetStaticBox() -> wxStaticBox - - - RecalcSizes() - - - CalcMin() -> Size - - - + + + + __init__(self) -> GDIObject + + + __del__(self) + + + GetVisible(self) -> bool + + + SetVisible(self, bool visible) + + + + + + IsNull(self) -> bool + + + #--------------------------------------------------------------------------- - - - - __init__(int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer - - - - - - - - - RecalcSizes() - - - CalcMin() -> Size - - - SetCols(int cols) - - - - - - SetRows(int rows) - - - - - - SetVGap(int gap) - - - - - - SetHGap(int gap) - - - - - - GetCols() -> int - - - GetRows() -> int - - - GetVGap() -> int - - - GetHGap() -> int - - - -#--------------------------------------------------------------------------- + + 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:: + + win.SetBackgroundColour(wxColour(0,0,255)) + win.SetBackgroundColour('BLUE') + win.SetBackgroundColour('#0000FF') + +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__(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``. + + + + + + ColourRGB(unsigned long colRGB) -> Colour + Constructs a colour from a packed RGB value. + + + + + + __del__(self) + + + Red(self) -> byte + Returns the red intensity. + + + Green(self) -> byte + Returns the green intensity. + + + Blue(self) -> byte + Returns the blue intensity. + + + Ok(self) -> bool + Returns True if the colour object is valid (the colour has been +initialised with RGB values). + + + Set(self, byte red, byte green, byte blue) + Sets the RGB intensity values. + + + + + + + + SetRGB(self, unsigned long colRGB) + Sets the RGB intensity values from a packed RGB value. + + + + + + SetFromName(self, String colourName) + Sets the RGB intensity values using a colour name listed in +``wx.TheColourDatabase``. + + + + + + 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). + + + __eq__(self, Colour colour) -> bool + Compare colours for equality + + + + + + __ne__(self, Colour colour) -> bool + Compare colours for inequality + + + + + + Get() -> (r, g, b) + Returns the RGB intensity values as a tuple. + + + GetRGB(self) -> unsigned long + Return the colour as a packed RGB value + + + + Color = Colour + NamedColor = NamedColour + ColorRGB = ColourRGB - - - - __init__(int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer - - - - - - - - - RecalcSizes() - - - CalcMin() -> Size - - - AddGrowableRow(size_t idx, int proportion=0) - - - - - - - RemoveGrowableRow(size_t idx) - - - - - - AddGrowableCol(size_t idx, int proportion=0) - - - - - - - RemoveGrowableCol(size_t idx) - - - - - - SetFlexibleDirection(int direction) - - - - - - GetFlexibleDirection() -> int - - - SetNonFlexibleGrowMode(int mode) - - - - - - GetNonFlexibleGrowMode() -> int - - - GetRowHeights() -> wxArrayInt - - - GetColWidths() -> wxArrayInt - - - + + + + __init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette + + + + + + + + + __del__(self) + + + GetPixel(self, byte red, byte green, byte blue) -> int + + + + + + + + GetRGB(int pixel) -> (R,G,B) + + + + + + + + + Ok(self) -> bool + + + #--------------------------------------------------------------------------- - - - __init__(int row=0, int col=0) -> GBPosition - - - - - - - GetRow() -> int - - - GetCol() -> int - - - SetRow(int row) - - - - - - SetCol(int col) - - - - - - __eq__(GBPosition p) -> bool - - - - - - __ne__(GBPosition p) -> bool - - - - - - Set(int row=0, int col=0) - - - - - - - Get() -> PyObject - - - - - __init__(int rowspan=1, int colspan=1) -> GBSpan - - - - - - - GetRowspan() -> int - - - GetColspan() -> int - - - SetRowspan(int rowspan) - - - - - - SetColspan(int colspan) - - - - - - __eq__(GBSpan o) -> bool - - - - - - __ne__(GBSpan o) -> bool - - - - - - Set(int rowspan=1, int colspan=1) - - - - - - - Get() -> PyObject - - - - - - __init__() -> GBSizerItem - - - GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag, - int border, Object userData) -> GBSizerItem - - - - - - - - - - - GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag, - int border, Object userData) -> GBSizerItem - - - - - - - - - - - GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span, - int flag, int border, Object userData) -> GBSizerItem - - - - - - - - - - - - GetPos() -> GBPosition - - - GetSpan() -> GBSpan - - - SetPos(GBPosition pos) -> bool - - - - - - SetSpan(GBSpan span) -> bool - - - - - - - - - - - Intersects(GBSizerItem other) -> bool -Intersects(GBPosition pos, GBSpan span) -> bool - - - - - - - GetEndPos(int row, int col) - - - - - - - GetGBSizer() -> GridBagSizer - - - SetGBSizer(GridBagSizer sizer) - - - - - - - - - __init__(int vgap=0, int hgap=0) -> GridBagSizer - - - - - - - Add(PyObject item, GBPosition pos, GBSpan span=DefaultSpan, - int flag=0, int border=0, PyObject userData=None) -> bool - - - - - - - - - - - AddItem(GBSizerItem item) -> bool - - - - - - GetEmptyCellSize() -> Size - - - SetEmptyCellSize(Size sz) - - - - - - - - - - - - - - - - GetItemPosition(Window window) -> GBPosition -GetItemPosition(Sizer sizer) -> GBPosition -GetItemPosition(size_t index) -> GBPosition - - - - - - - - - - - - - - - - - - SetItemPosition(Window window, GBPosition pos) -> bool -SetItemPosition(Sizer sizer, GBPosition pos) -> bool -SetItemPosition(size_t index, GBPosition pos) -> bool - - - - - - - - - - - - - - - - - GetItemSpan(Window window) -> GBSpan -GetItemSpan(Sizer sizer) -> GBSpan -GetItemSpan(size_t index) -> GBSpan - - - - - - - - - - - - - - - - - - SetItemSpan(Window window, GBSpan span) -> bool -SetItemSpan(Sizer sizer, GBSpan span) -> bool -SetItemSpan(size_t index, GBSpan span) -> bool - - - - - - - - - - - - FindItem(Window window) -> GBSizerItem -FindItem(Sizer sizer) -> GBSizerItem - - - - - - FindItemAtPosition(GBPosition pos) -> GBSizerItem - - - - - - FindItemAtPoint(Point pt) -> GBSizerItem - - - - - - FindItemWithData(Object userData) -> GBSizerItem - - - - - - RecalcSizes() - - - CalcMin() -> Size - - - - - - - - - CheckForIntersection(GBSizerItem item, GBSizerItem excludeItem=None) -> bool -CheckForIntersection(GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool - - - - - - - - + + + + __init__(self, Colour colour, int width=1, int style=SOLID) -> Pen + + + + + + + + __del__(self) + + + GetCap(self) -> int + + + GetColour(self) -> Colour + + + GetJoin(self) -> int + + + GetStyle(self) -> int + + + GetWidth(self) -> int + + + Ok(self) -> bool + + + SetCap(self, int cap_style) + + + + + + SetColour(self, Colour colour) + + + + + + SetJoin(self, int join_style) + + + + + + SetStyle(self, int style) + + + + + + SetWidth(self, int width) + + + + + + SetDashes(self, int dashes, wxDash dashes_array) + + + + + + + GetDashes(self) -> PyObject + + + _SetDashes(self, PyObject _self, PyObject pyDashes) + + + + + + + GetDashCount(self) -> int + + + __eq__(self, Pen other) -> bool + + + + + + __ne__(self, Pen other) -> bool + + + + + + #--------------------------------------------------------------------------- - - - - Set(int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN) - - - - - - - - - - LeftOf(Window sibling, int marg=0) - - - - - - - RightOf(Window sibling, int marg=0) - - - - - - - Above(Window sibling, int marg=0) - - - - - - - Below(Window sibling, int marg=0) - - - - - - - SameAs(Window otherW, int edge, int marg=0) - - - - - - - - PercentOf(Window otherW, int wh, int per) - - - - - - - - Absolute(int val) - - - - - - Unconstrained() - - - AsIs() - - - GetOtherWindow() -> Window - - - GetMyEdge() -> int - - - SetEdge(int which) - - - - - - SetValue(int v) - - - - - - GetMargin() -> int - - - SetMargin(int m) - - - - - - GetValue() -> int - - - GetPercent() -> int - - - GetOtherEdge() -> int - - - GetDone() -> bool - - - SetDone(bool d) - - - - - - GetRelationship() -> int - - - SetRelationship(int r) - - - - - - ResetIfWin(Window otherW) -> bool - - - - - - SatisfyConstraint(LayoutConstraints constraints, Window win) -> bool - - - - - - - GetEdge(int which, Window thisWin, Window other) -> int - - - - - - - - - - - __init__() -> LayoutConstraints - - - - - - - - - - - SatisfyConstraints(Window win) -> (areSatisfied, noChanges) - - - - - - - AreSatisfied() -> bool - - - #---------------------------------------------------------------------------- + + 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. -# Use Python's bool constants if available, make some if not -try: - True -except NameError: - __builtins__.True = 1==1 - __builtins__.False = 1==0 +: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__(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: -# workarounds for bad wxRTTI names -__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge' -__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider' -__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar' + =================== ============================= + 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__(self) + + + SetColour(self, Colour col) + Set the brush's `wx.Colour`. + + + + + + SetStyle(self, int style) + Sets the style of the brush. See `__init__` for a listing of styles. + + + + + + SetStipple(self, Bitmap stipple) + Sets the stipple `wx.Bitmap`. + + + + + + GetColour(self) -> Colour + Returns the `wx.Colour` of the brush. + + + GetStyle(self) -> int + Returns the style of the brush. See `__init__` for a listing of +styles. + + + 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(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. -#---------------------------------------------------------------------------- -# Load version numbers from __version__... Ensure that major and minor -# versions are the same for both wxPython and wxWindows. +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. -from __version__ import * -__version__ = VERSION_STRING +: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? -assert MAJOR_VERSION == _core.MAJOR_VERSION, "wxPython/wxWindows version mismatch" -assert MINOR_VERSION == _core.MINOR_VERSION, "wxPython/wxWindows version mismatch" -if RELEASE_VERSION != _core.RELEASE_VERSION: - import warnings - warnings.warn("wxPython/wxWindows release number mismatch") +:todo: Find a way to do very efficient PIL Image <--> wx.Bitmap + converstions. + + + + __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 -class PyDeadObjectError(AttributeError): - pass +:see: Alternate constructors `wx.EmptyBitmap`, `wx.BitmapFromIcon`, + `wx.BitmapFromImage`, `wx.BitmapFromXPMData`, + `wx.BitmapFromBits` + + + + + + + + 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. + + + + + + + + BitmapFromIcon(Icon icon) -> Bitmap + Create a new bitmap from a `wx.Icon` object. + + + + + + BitmapFromImage(Image image, int depth=-1) -> Bitmap + 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. + + + + + + + BitmapFromXPMData(PyObject listOfStrings) -> Bitmap + Construct a Bitmap from a list of strings formatted as XPM data. + + + + + + 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. + + + + + + + + + __del__(self) + + + Ok(self) -> bool + + + GetWidth(self) -> int + Gets the width of the bitmap in pixels. + + + GetHeight(self) -> int + Gets the height of the bitmap in pixels. + + + 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(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(self) -> Mask + Gets the associated mask (if any) which may have been loaded from a +file or explpicitly set for the bitmap. -class _wxPyDeadObject(object): - """ - Instances of wx objects that are OOR capable will have their __class__ - changed to this class when the C++ object is deleted. This should help - prevent crashes due to referencing a bogus C++ pointer. - """ - reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)" - attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed." +:see: `SetMask`, `wx.Mask` + + + + SetMask(self, Mask mask) + Sets the mask for this bitmap. - def __repr__(self): - if not hasattr(self, "_name"): - self._name = "[unknown]" - return self.reprStr % self._name +:see: `GetMask`, `wx.Mask` + + + + + + + SetMaskColour(self, Colour colour) + Create a Mask based on a specified colour in the Bitmap. + + + + + + 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(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(self, String name, int type) -> bool + Loads a bitmap from a file. See `__init__` for a description of the +``type`` parameter. + + + + + + + CopyFromIcon(self, Icon icon) -> bool + + + + + + SetHeight(self, int height) + Set the height property (does not affect the existing bitmap data). + + + + + + SetWidth(self, int width) + Set the width property (does not affect the existing 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__(self, 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. - def __getattr__(self, *args): - if not hasattr(self, "_name"): - self._name = "[unknown]" - raise PyDeadObjectError(self.attrStr % self._name) +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__(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. - def __nonzero__(self): - return 0 +:see: `wx.Bitmap`, `wx.Colour` + + + + + + + MaskColour = wx._deprecated(Mask, "wx.MaskColour is deprecated, use `wx.Mask` instead.") + + + + __init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon + + + + + + + + + EmptyIcon() -> Icon + + + IconFromLocation(IconLocation loc) -> Icon + + + + + + IconFromBitmap(Bitmap bmp) -> Icon + + + + + + IconFromXPMData(PyObject listOfStrings) -> Icon + + + + + + __del__(self) + + + LoadFile(self, String name, int type) -> bool + + + + + + + Ok(self) -> bool + + + GetWidth(self) -> int + + + GetHeight(self) -> int + + + GetDepth(self) -> int + + + SetWidth(self, int w) + + + + + + SetHeight(self, int h) + + + + + + SetDepth(self, int d) + + + + + + CopyFromBitmap(self, Bitmap bmp) + + + + + + + + __init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation + + + + + + + __del__(self) + + + IsOk(self) -> bool + + + SetFileName(self, String filename) + + + + + + GetFileName(self) -> String + + + SetIndex(self, int num) + + + + + + GetIndex(self) -> int + + + + + __init__(self) -> IconBundle + + + IconBundleFromFile(String file, long type) -> IconBundle + + + + + + + IconBundleFromIcon(Icon icon) -> IconBundle + + + + + + __del__(self) + + + AddIcon(self, Icon icon) + + + + + + AddIconFromFile(self, String file, long type) + + + + + + + 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 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. -class PyUnbornObjectError(AttributeError): - pass +Stock Cursor IDs +----------------- + ======================== ====================================== + wx.CURSOR_ARROW A standard arrow cursor. + wx.CURSOR_RIGHT_ARROW A standard arrow cursor pointing to the right. + wx.CURSOR_BLANK Transparent cursor. + wx.CURSOR_BULLSEYE Bullseye cursor. + wx.CURSOR_CHAR Rectangular character cursor. + wx.CURSOR_CROSS A cross cursor. + wx.CURSOR_HAND A hand cursor. + wx.CURSOR_IBEAM An I-beam cursor (vertical line). + wx.CURSOR_LEFT_BUTTON Represents a mouse with the left button depressed. + wx.CURSOR_MAGNIFIER A magnifier icon. + wx.CURSOR_MIDDLE_BUTTON Represents a mouse with the middle button depressed. + wx.CURSOR_NO_ENTRY A no-entry sign cursor. + wx.CURSOR_PAINT_BRUSH A paintbrush cursor. + wx.CURSOR_PENCIL A pencil cursor. + wx.CURSOR_POINT_LEFT A cursor that points left. + wx.CURSOR_POINT_RIGHT A cursor that points right. + wx.CURSOR_QUESTION_ARROW An arrow and question mark. + wx.CURSOR_RIGHT_BUTTON Represents a mouse with the right button depressed. + wx.CURSOR_SIZENESW A sizing cursor pointing NE-SW. + wx.CURSOR_SIZENS A sizing cursor pointing N-S. + wx.CURSOR_SIZENWSE A sizing cursor pointing NW-SE. + wx.CURSOR_SIZEWE A sizing cursor pointing W-E. + wx.CURSOR_SIZING A general sizing cursor. + wx.CURSOR_SPRAYCAN A spraycan cursor. + wx.CURSOR_WAIT A wait cursor. + wx.CURSOR_WATCH A watch cursor. + wx.CURSOR_ARROWWAIT A cursor with both an arrow and an hourglass, (windows.) + ======================== ====================================== -class _wxPyUnbornObject(object): - """ - 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 - exception will be raised if they are used before the C++ instance - is ready. - """ + + + + __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. - reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)" - attrStr = "The C++ part of this object has not been initialized, attribute access not allowed." +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. - def __repr__(self): - #if not hasattr(self, "_name"): - # self._name = "[unknown]" - return self.reprStr #% self._name +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. - def __getattr__(self, *args): - #if not hasattr(self, "_name"): - # self._name = "[unknown]" - raise PyUnbornObjectError(self.attrStr) # % self._name ) +On MacOS the cursor is resized to 16x16 and currently only shown as +black/white (mask respected). + + + + + + __del__(self) + + + Ok(self) -> bool + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, int x=0, int y=0, int width=0, int height=0) -> Region + + + + + + + + + RegionFromBitmap(Bitmap bmp) -> Region + + + + + + RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region + + + + + + + + RegionFromPoints(int points, Point points_array, int fillStyle=WINDING_RULE) -> Region + + + + + + + + __del__(self) + + + Clear(self) + + + Offset(self, int x, int y) -> bool + + + + + + + Contains(self, int x, int y) -> int + + + + + + + ContainsPoint(self, Point pt) -> int + + + + + + ContainsRect(self, Rect rect) -> int + + + + + + ContainsRectDim(self, int x, int y, int w, int h) -> int + + + + + + + + + GetBox(self) -> Rect + + + Intersect(self, int x, int y, int width, int height) -> bool + + + + + + + + + IntersectRect(self, Rect rect) -> bool + + + + + + IntersectRegion(self, Region region) -> bool + + + + + + IsEmpty(self) -> bool + + + Union(self, int x, int y, int width, int height) -> bool + + + + + + + + + UnionRect(self, Rect rect) -> bool + + + + + + UnionRegion(self, Region region) -> bool + + + + + + Subtract(self, int x, int y, int width, int height) -> bool + + + + + + + + + SubtractRect(self, Rect rect) -> bool + + + + + + SubtractRegion(self, Region region) -> bool + + + + + + Xor(self, int x, int y, int width, int height) -> bool + + + + + + + + + XorRect(self, Rect rect) -> bool + + + + + + XorRegion(self, Region region) -> bool + + + + + + ConvertToBitmap(self) -> Bitmap + + + UnionBitmap(self, Bitmap bmp) -> bool + + + + + + UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool + + + + + + + + + + + __init__(self, Region region) -> RegionIterator + + + + + + __del__(self) + + + GetX(self) -> int + + + GetY(self) -> int + + + GetW(self) -> int + + + GetWidth(self) -> int + + + GetH(self) -> int + + + GetHeight(self) -> int + + + GetRect(self) -> Rect + + + HaveRects(self) -> bool + + + Reset(self) + + + Next(self) + + + __nonzero__(self) -> bool + + + +#--------------------------------------------------------------------------- + + +#--------------------------------------------------------------------------- + + + + __init__(self) -> NativeFontInfo + + + __del__(self) + + + Init(self) + + + InitFromFont(self, Font font) + + + + + + GetPointSize(self) -> int + + + GetStyle(self) -> int + + + GetWeight(self) -> int + + + GetUnderlined(self) -> bool + + + GetFaceName(self) -> String + + + GetFamily(self) -> int + + + GetEncoding(self) -> int + + + SetPointSize(self, int pointsize) + + + + + + SetStyle(self, int style) + + + + + + SetWeight(self, int weight) + + + + + + SetUnderlined(self, bool underlined) + + + + + + SetFaceName(self, String facename) + + + + + + SetFamily(self, int family) + + + + + + SetEncoding(self, int encoding) + + + + + + FromString(self, String s) -> bool + + + + + + ToString(self) -> String + + + __str__(self) -> String + + + FromUserString(self, String s) -> bool + + + + + + ToUserString(self) -> String + + + + + __init__(self) -> NativeEncodingInfo + + + __del__(self) + + + + + FromString(self, String s) -> bool + + + + + + ToString(self) -> String + + + + GetNativeFontEncoding(int encoding) -> NativeEncodingInfo + + + + + + TestFontEncoding(NativeEncodingInfo info) -> bool + + + + + +#--------------------------------------------------------------------------- + + + + __init__(self) -> FontMapper + + + __del__(self) + + + Get() -> FontMapper + + + Set(FontMapper mapper) -> FontMapper + + + + + + CharsetToEncoding(self, String charset, bool interactive=True) -> int + + + + + + + GetSupportedEncodingsCount() -> size_t + + + GetEncoding(size_t n) -> int + + + + + + GetEncodingName(int encoding) -> String + + + + + + GetEncodingDescription(int encoding) -> String + + + + + + GetEncodingFromName(String name) -> int + + + + + + SetConfig(self, ConfigBase config) + + + + + + SetConfigPath(self, String prefix) + + + + + + GetDefaultConfigPath() -> String + + + GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject + + + + + + + + IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool + + + + + + + SetDialogParent(self, Window parent) + + + + + + SetDialogTitle(self, String title) + + + + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, int pointSize, int family, int style, int weight, bool underline=False, + String face=EmptyString, + int encoding=FONTENCODING_DEFAULT) -> Font + + + + + + + + + + + + FontFromNativeInfo(NativeFontInfo info) -> Font + + + + + + FontFromNativeInfoString(String info) -> Font + + + + + + Font2(int pointSize, int family, int flags=FONTFLAG_DEFAULT, + String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font + + + + + + + + + + __del__(self) + + + Ok(self) -> bool + + + __eq__(self, Font other) -> bool + + + + + + __ne__(self, Font other) -> bool + + + + + + GetPointSize(self) -> int + + + GetFamily(self) -> int + + + GetStyle(self) -> int + + + GetWeight(self) -> int + + + GetUnderlined(self) -> bool + + + GetFaceName(self) -> String + + + GetEncoding(self) -> int + + + GetNativeFontInfo(self) -> NativeFontInfo + + + IsFixedWidth(self) -> bool + + + GetNativeFontInfoDesc(self) -> String + + + GetNativeFontInfoUserDesc(self) -> String + + + SetPointSize(self, int pointSize) + + + + + + SetFamily(self, int family) + + + + + + SetStyle(self, int style) + + + + + + SetWeight(self, int weight) + + + + + + SetFaceName(self, String faceName) + + + + + + SetUnderlined(self, bool underlined) + + + + + + SetEncoding(self, int encoding) + + + + + + SetNativeFontInfo(self, NativeFontInfo info) + + + + + + SetNativeFontInfoFromString(self, String info) + + + + + + SetNativeFontInfoUserDesc(self, String info) + + + + + + GetFamilyString(self) -> String + + + GetStyleString(self) -> String + + + GetWeightString(self) -> String + + + SetNoAntiAliasing(self, bool no=True) + + + + + + GetNoAntiAliasing(self) -> bool + + + GetDefaultEncoding() -> int + + + SetDefaultEncoding(int encoding) + + + + + + +#--------------------------------------------------------------------------- + + + + __init__(self) -> FontEnumerator + + + __del__(self) + + + _setCallbackInfo(self, PyObject self, PyObject _class, bool incref) + + + + + + + + EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool + + + + + + + EnumerateEncodings(self, String facename=EmptyString) -> bool + + + + + + GetEncodings(self) -> PyObject + + + GetFacenames(self) -> PyObject + + + +#--------------------------------------------------------------------------- + + + + + + + + + __init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale + + + + + + + __del__(self) + + + Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString, + bool bLoadDefault=True, + bool bConvertEncoding=False) -> bool + + + + + + + + + + Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool + + + + + + + GetSystemLanguage() -> int + + + GetSystemEncoding() -> int + + + GetSystemEncodingName() -> String + + + IsOk(self) -> bool + + + GetLocale(self) -> String + + + GetLanguage(self) -> int + + + GetSysName(self) -> String + + + GetCanonicalName(self) -> String + + + AddCatalogLookupPathPrefix(String prefix) + + + + + + AddCatalog(self, String szDomain) -> bool + + + + + + IsLoaded(self, String szDomain) -> bool + + + + + + GetLanguageInfo(int lang) -> LanguageInfo + + + + + + GetLanguageName(int lang) -> String + + + + + + FindLanguageInfo(String locale) -> LanguageInfo + + + + + + AddLanguage(LanguageInfo info) + + + + + + GetString(self, String szOrigString, String szDomain=EmptyString) -> String + + + + + + + GetName(self) -> String + + + + GetLocale() -> Locale + + + + + + + + GetTranslation(String str) -> String +GetTranslation(String str, String strPlural, size_t n) -> String + + + + + + + +#--------------------------------------------------------------------------- + + + + + __init__(self) -> EncodingConverter + + + __del__(self) + + + Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool + + + + + + + + Convert(self, String input) -> String + + + + + + GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray + + + + + + + GetAllEquivalents(int enc) -> wxFontEncodingArray + + + + + + CanConvert(int encIn, int encOut) -> bool + + + + + + + #---------------------------------------------------------------------------- +# On MSW add the directory where the wxWidgets catalogs were installed +# to the default catalog path. +if wx.Platform == "__WXMSW__": + import os + localedir = os.path.join(os.path.split(__file__)[0], "locale") + Locale_AddCatalogLookupPathPrefix(localedir) + del os - def __nonzero__(self): - return 0 +#---------------------------------------------------------------------------- + + +#--------------------------------------------------------------------------- + + + 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. -#---------------------------------------------------------------------------- -_wxPyCallAfterId = None +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__(self) + + + 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(self) + Ends the group of drawing primitives started with `BeginDrawing`, and +invokes whatever optimization is available for this DC type on the +current platform. + + + 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: -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. - """ - app = wx.GetApp() - assert app, 'No wxApp created yet' + - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than + the given colour is encountered. - global _wxPyCallAfterId - if _wxPyCallAfterId is None: - _wxPyCallAfterId = wx.NewEventType() - app.Connect(-1, -1, _wxPyCallAfterId, - lambda event: event.callable(*event.args, **event.kw) ) - evt = wx.PyEvent() - evt.SetEventType(_wxPyCallAfterId) - evt.callable = callable - evt.args = args - evt.kw = kw - wx.PostEvent(app, evt) + - **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. + + + + + + + + + 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. -class FutureCall: - """ - A convenience class for wxTimer, 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. + - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given + colour. - 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 - hold a reference to itself while the timer is running (the timer - has a reference to self.Notify) but the cycle will be broken when - the timer completes, automatically cleaning up the wx.FutureCall - object. - """ - def __init__(self, millis, callable, *args, **kwargs): - self.millis = millis - self.callable = callable - self.SetArgs(*args, **kwargs) - self.runCount = 0 - self.hasRun = False - self.result = None - self.timer = None - self.Start() +Returns False if the operation failed. - def __del__(self): - self.Stop() +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. + + + + + + + + GetPixel(self, int x, int y) -> Colour + Gets the colour at the specified location on the DC. + + + + + + + GetPixelPoint(self, Point pt) -> Colour + + + + + + 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). + + + + + + + + + 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). + + + + + + + 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. + + + + + + + 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. + + + + + + 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. + + + + + + + + + + + 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. - def Start(self, millis=None, *args, **kwargs): - """ - (Re)start the timer - """ - self.hasRun = False - if millis is not None: - self.millis = millis - if args or kwargs: - self.SetArgs(*args, **kwargs) - self.Stop() - self.timer = wx.PyTimer(self.Notify) - self.timer.Start(self.millis, wx.TIMER_ONE_SHOT) - Restart = Start +The arc is drawn in an anticlockwise direction from the start point to +the end point. + + + + + + + + DrawCheckMark(self, int x, int y, int width, int height) + Draws a check mark inside the given rectangle. + + + + + + + + + DrawCheckMarkRect(self, Rect rect) + Draws a check mark inside the given rectangle. + + + + + + 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. + + + + + + + + + + + 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. - def Stop(self): - """ - Stop and destroy the timer. - """ - if self.timer is not None: - self.timer.Stop() - self.timer = None +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. + + + + + + + + + DrawPoint(self, int x, int y) + Draws a point using the current pen. + + + + + + + DrawPointPoint(self, Point pt) + Draws a point using the current pen. + + + + + + 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. + + + + + + + + + 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. + + + + + + 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. + + + + + + + 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. + + + + + + + + + + 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. - def GetInterval(self): - if self.timer is not None: - return self.timer.GetInterval() - else: - return 0 +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. + + + + + + + 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. + + + + + + + + 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. - def IsRunning(self): - return self.timer is not None and self.timer.IsRunning() +:see: `DrawEllipse` + + + + + + + + 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` + + + + + + + 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. - def SetArgs(self, *args, **kwargs): - """ - (Re)set the args passed to the callable object. This is - useful in conjunction with Restart if you want to schedule a - new call to the same callable object but with different - parameters. - """ - self.args = args - self.kwargs = kwargs +:see: `DrawCircle` + + + + + + + + + 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` + + + + + + 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. - def HasRun(self): - return self.hasRun +:see: `DrawCircle` + + + + + + + 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. + + + + + + + + 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. + + + + + + + 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. - def GetResult(self): - return self.result +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). - def Notify(self): - """ - The timer has expired so call the callable. - """ - if self.callable and getattr(self.callable, 'im_self', True): - self.runCount += 1 - self.result = self.callable(*self.args, **self.kwargs) - self.hasRun = True - wx.CallAfter(self.Stop) +:see: `SetTextForeground`, `SetTextBackground` and `wx.MemoryDC` + + + + + + + + + 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` + + + + + + + + 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. -# 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 * +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. -# Fixup the stock objects since they can't be used yet. (They will be -# restored in wx.PyApp.OnInit.) -_core._wxPyFixStockObjects() +:see: `DrawRotatedText` + + + + + + + + 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. -#---------------------------------------------------------------------------- -#---------------------------------------------------------------------------- - - - - wx = core - +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` + + + + + + + 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` + + + + + + + + + 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` + + + + + + + + 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. + + + + + + + + + + + + + + + + + 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. + + + + + + + + + + + + + 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(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. + + + + + + + + + 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. + + + + + + + + + + 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` + + + + + + + + + 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. + + + + + + + + + + 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(self) + Clears the device context using the current background brush. + + + StartDoc(self, String message) -> bool + Starts a document (only relevant when outputting to a +printer). *Message* is a message to show whilst printing. + + + + + + EndDoc(self) + Ends a document (only relevant when outputting to a printer). + + + StartPage(self) + Starts a document page (only relevant when outputting to a printer). + + + EndPage(self) + Ends a document page (only relevant when outputting to a printer). + + + 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(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(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(self, Brush brush) + Sets the current background brush for the DC. + + + + + + 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(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` + + + + + + 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. + + + + + + + + + GetClippingRect(self) -> Rect + Gets the rectangle surrounding the current clipping region. + + + GetCharHeight(self) -> int + Gets the character height of the currently set font. + + + 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. + + + + + + + + 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. + + + + + + + + + + + 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. + + + + + + + + + + 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(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) + 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(self) -> Size + Get the DC size in milimeters. + + + GetSizeMMTuple() -> (width, height) + Get the DC size in milimeters. + + + + + + + DeviceToLogicalX(self, int x) -> int + Convert device X coordinate to logical coordinate, using the current +mapping mode. + + + + + + DeviceToLogicalY(self, int y) -> int + Converts device Y coordinate to logical coordinate, using the current +mapping mode. + + + + + + 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(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(self, int x) -> int + Converts logical X coordinate to device coordinate, using the current +mapping mode. + + + + + + LogicalToDeviceY(self, int y) -> int + Converts logical Y coordinate to device coordinate, using the current +mapping mode. + + + + + + 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(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(self) -> bool + + + CanGetTextExtent(self) -> bool + + + GetDepth(self) -> int + Returns the colour depth of the DC. + + + GetPPI(self) -> Size + Resolution in Pixels per inch + + + Ok(self) -> bool + Returns true if the DC is ok to use. + + + GetBackgroundMode(self) -> int + Returns the current background mode, either ``wx.SOLID`` or +``wx.TRANSPARENT``. + +:see: `SetBackgroundMode` + + + GetBackground(self) -> Brush + Gets the brush used for painting the background. + +:see: `SetBackground` + + + GetBrush(self) -> Brush + Gets the current brush + + + GetFont(self) -> Font + Gets the current font + + + GetPen(self) -> Pen + Gets the current pen + + + GetTextBackground(self) -> Colour + Gets the current text background colour + + + GetTextForeground(self) -> Colour + Gets the current text foreground colour + + + SetTextForeground(self, Colour colour) + Sets the current text foreground colour for the DC. + + + + + + SetTextBackground(self, Colour colour) + Sets the current text background colour for the DC. + + + + + + GetMapMode(self) -> int + Gets the current *mapping mode* for the device context + + + 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(self) -> (xScale, yScale) + Gets the current user scale factor (set by `SetUserScale`). + + + + + + + SetUserScale(self, double x, double y) + Sets the user scaling factor, useful for applications which require +'zooming'. + + + + + + + GetLogicalScale() -> (xScale, yScale) + + + + + + + SetLogicalScale(self, double x, double y) + + + + + + + GetLogicalOrigin(self) -> Point + + + GetLogicalOriginTuple() -> (x,y) + + + + + + + SetLogicalOrigin(self, int x, int y) + + + + + + + SetLogicalOriginPoint(self, Point point) + + + + + + GetDeviceOrigin(self) -> Point + + + GetDeviceOriginTuple() -> (x,y) + + + + + + + SetDeviceOrigin(self, int x, int y) + + + + + + + SetDeviceOriginPoint(self, Point point) + + + + + + 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(self) -> int + Gets the current logical function (set by `SetLogicalFunction`). + + + 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(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(self) -> bool + Returns true if device context optimization is on. See +`SetOptimization` for . + + + 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(self) + Resets the bounding box: after a call to this function, the bounding +box doesn't contain anything. + + + MinX(self) -> int + Gets the minimum horizontal extent used in drawing commands so far. + + + MaxX(self) -> int + Gets the maximum horizontal extent used in drawing commands so far. + + + MinY(self) -> int + Gets the minimum vertical extent used in drawing commands so far. + + + 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. + + + + + + + + + _DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject + + + + + + + + _DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject + + + + + + + + _DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject + + + + + + + + _DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject + + + + + + + + _DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject + + + + + + + + _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList, + PyObject backgroundList) -> PyObject + + + + + + + + + #--------------------------------------------------------------------------- - - - - __init__() -> GDIObject - - - __del__() - - - GetVisible() -> bool - - - SetVisible(bool visible) - - - - - - IsNull() -> bool - - - + + 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__(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(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. + + + + + + #--------------------------------------------------------------------------- - - - - __init__(unsigned char red=0, unsigned char green=0, unsigned char blue=0) -> Colour - - - - - - - - NamedColour(String colorName) -> Colour - - - - - - ColourRGB(unsigned long colRGB) -> Colour - - - - - - __del__() - - - Red() -> unsigned char - - - Green() -> unsigned char - - - Blue() -> unsigned char - - - Ok() -> bool - - - Set(unsigned char red, unsigned char green, unsigned char blue) - - - - - - - - SetRGB(unsigned long colRGB) - - - - - - __eq__(Colour colour) -> bool - - - - - - __ne__(Colour colour) -> bool - - - - - - InitFromName(String colourName) - - - - - - Get() -> PyObject - - - - Color = Colour - NamedColor = NamedColour + + 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__(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__(self) + Copies everything drawn on the DC so far to the underlying DC +associated with this object, if any. + + + 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__(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). + + + + + + + + + +#--------------------------------------------------------------------------- - - - - __init__(int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette - - - - - - - - - __del__() - - - GetPixel(byte red, byte green, byte blue) -> int - - - - - - - - GetRGB(int pixel) -> (R,G,B) - - - - - - - - - Ok() -> bool - - - + + 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__(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(self, Window window) -> bool + Specify that the area of the screen to be drawn upon coincides with +the given window. + +:see: `EndDrawingOnTop` + + + + + + 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(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. + + + #--------------------------------------------------------------------------- - - - - __init__(Colour colour, int width=1, int style=SOLID) -> Pen - - - - - - - - __del__() - - - GetCap() -> int - - - GetColour() -> Colour - - - GetJoin() -> int - - - GetStyle() -> int - - - GetWidth() -> int - - - Ok() -> bool - - - SetCap(int cap_style) - - - - - - SetColour(Colour colour) - - - - - - SetJoin(int join_style) - - - - - - SetStyle(int style) - - - - - - SetWidth(int width) - - - - - - SetDashes(int dashes, wxDash dashes_array) - - - - - - - GetDashes() -> PyObject - - - GetDashCount() -> int - - - - - - __init__(Colour colour, int width=1, int style=SOLID) -> PyPen - - - - - - - - __del__() - - - SetDashes(int dashes, wxDash dashes_array) - - - - - - - Pen = PyPen - + + 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__(self, Window win) -> ClientDC + Constructor. Pass the window on which you wish to paint. + + + + + + #--------------------------------------------------------------------------- - - 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. - - - __init__(Colour colour, int style=SOLID) -> Brush - Constructs a brush from a colour object and style. - - - - - - - __del__() - - - SetColour(Colour col) - - - - - - SetStyle(int style) - - - - - - SetStipple(Bitmap stipple) - - - - - - GetColour() -> Colour - - - GetStyle() -> int - - - GetStipple() -> Bitmap - - - Ok() -> bool - - - - - - __init__(String name, int type=BITMAP_TYPE_ANY) -> Bitmap - Loads a bitmap from a file. - - - - - - - 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. - - - - - - - - BitmapFromIcon(Icon icon) -> Bitmap - Create a new bitmap from an 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. - - - - - - - BitmapFromXPMData(PyObject listOfStrings) -> Bitmap - Construct a Bitmap from a list of strings formatted as XPM data. - - - - - - 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. - - - - - - - - - __del__() - - - Ok() -> bool - - - GetWidth() -> int - Gets the width of the bitmap in pixels. - - - GetHeight() -> int - Gets the height of the bitmap in pixels. - - - GetDepth() -> int - Gets the colour depth of the bitmap. A value of 1 indicates a -monochrome 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. - - - GetMask() -> Mask - Gets the associated mask (if any) which may have been loaded from a file -or explpicitly set for the bitmap. - - - SetMask(Mask mask) - Sets the mask for this bitmap. - - - - - - SetMaskColour(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. - - - - - - SaveFile(String name, int type, Palette palette=(wxPalette *) NULL) -> bool - Saves a bitmap in the named file. - - - - - - - - LoadFile(String name, int type) -> bool - Loads a bitmap from a file - - - - - - - CopyFromIcon(Icon icon) -> bool - - - - - - SetHeight(int height) - Set the height property (does not affect the bitmap data). - - - - - - SetWidth(int width) - Set the width property (does not affect the bitmap data). - - - - - - SetDepth(int depth) - Set the depth property (does not affect the bitmap data). - - - - - - - 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. - - - __init__(Bitmap bitmap) -> Mask - Constructs a mask from a monochrome bitmap. - - - - - - MaskColour(Bitmap bitmap, Colour colour) -> Mask - Constructs a mask from a bitmap and a colour in that bitmap that indicates the -background. - - - - - - - - - - __init__(String name, long flags, int desiredWidth=-1, int desiredHeight=-1) -> Icon - - - - - - - - - EmptyIcon() -> Icon - - - IconFromLocation(IconLocation loc) -> Icon - - - - - - IconFromBitmap(Bitmap bmp) -> Icon - - - - - - IconFromXPMData(PyObject listOfStrings) -> Icon - - - - - - __del__() - - - LoadFile(String name, long flags) -> bool - - - - - - - Ok() -> bool - - - GetWidth() -> int - - - GetHeight() -> int - - - GetDepth() -> int - - - SetWidth(int w) - - - - - - SetHeight(int h) - - - - - - SetDepth(int d) - - - - - - CopyFromBitmap(Bitmap bmp) - - - - - - - - __init__(String filename=&wxPyEmptyString, int num=0) -> IconLocation - - - - - - - __del__() - - - IsOk() -> bool - - - SetFileName(String filename) - - - - - - GetFileName() -> String - - - SetIndex(int num) - - - - - - GetIndex() -> int - - - - - __init__() -> IconBundle - - - IconBundleFromFile(String file, long type) -> IconBundle - - - - - - - IconBundleFromIcon(Icon icon) -> IconBundle - - - - - - __del__() - - - AddIcon(Icon icon) - - - - - - AddIconFromFile(String file, long type) - - - - - - - GetIcon(Size size) -> Icon - - - - - - - - - __init__(String cursorName, long flags, int hotSpotX=0, int hotSpotY=0) -> Cursor - - - - - - - - - StockCursor(int id) -> Cursor - - - - - - CursorFromImage(Image image) -> Cursor - - - - - - CursorFromBits(PyObject bits, int width, int height, int hotSpotX=-1, - int hotSpotY=-1, PyObject maskBits=0) -> Cursor - - - - - - - - - - - __del__() - - - Ok() -> bool - - - + + 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__(self, Window win) -> PaintDC + Constructor. Pass the window on which you wish to paint. + + + + + + #--------------------------------------------------------------------------- - - - - __init__(int x=0, int y=0, int width=0, int height=0) -> Region - - - - - - - - - RegionFromBitmap(Bitmap bmp, Colour transColour=NullColour, int tolerance=0) -> Region - - - - - - - - RegionFromPoints(int points, Point points_array, int fillStyle=WINDING_RULE) -> Region - - - - - - - - __del__() - - - Clear() - - - Offset(int x, int y) -> bool - - - - - - - Contains(int x, int y) -> int - - - - - - - ContainsPoint(Point pt) -> int - - - - - - ContainsRect(Rect rect) -> int - - - - - - ContainsRectDim(int x, int y, int w, int h) -> int - - - - - - - - - GetBox() -> Rect - - - Intersect(int x, int y, int width, int height) -> bool - - - - - - - - - IntersectRect(Rect rect) -> bool - - - - - - IntersectRegion(Region region) -> bool - - - - - - IsEmpty() -> bool - - - Union(int x, int y, int width, int height) -> bool - - - - - - - - - UnionRect(Rect rect) -> bool - - - - - - UnionRegion(Region region) -> bool - - - - - - Subtract(int x, int y, int width, int height) -> bool - - - - - - - - - SubtractRect(Rect rect) -> bool - - - - - - SubtractRegion(Region region) -> bool - - - - - - Xor(int x, int y, int width, int height) -> bool - - - - - - - - - XorRect(Rect rect) -> bool - - - - - - XorRegion(Region region) -> bool - - - - - - ConvertToBitmap() -> Bitmap - - - UnionBitmap(Bitmap bmp, Colour transColour=NullColour, int tolerance=0) -> bool - - - - - - - - - - - __init__(Region region) -> RegionIterator - - - - - - __del__() - - - GetX() -> int - - - GetY() -> int - - - GetW() -> int - - - GetWidth() -> int - - - GetH() -> int - - - GetHeight() -> int - - - GetRect() -> Rect - - - HaveRects() -> bool - - - Reset() - - - Next() - - - __nonzero__() -> bool - - - + + 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__(self, Window win) -> WindowDC + Constructor. Pass the window on which you wish to paint. + + + + + + #--------------------------------------------------------------------------- - + + 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__(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. + + + + + + + #--------------------------------------------------------------------------- - - - __init__() -> NativeFontInfo - - - __del__() - - - Init() - - - InitFromFont(Font font) - - - - - - GetPointSize() -> int - - - GetStyle() -> int - - - GetWeight() -> int - - - GetUnderlined() -> bool - - - GetFaceName() -> String - - - GetFamily() -> int - - - GetEncoding() -> int - - - SetPointSize(int pointsize) - - - - - - SetStyle(int style) - - - - - - SetWeight(int weight) - - - - - - SetUnderlined(bool underlined) - - - - - - SetFaceName(String facename) - - - - - - SetFamily(int family) - - - - - - SetEncoding(int encoding) - - - - - - FromString(String s) -> bool - - - - - - ToString() -> String - - - __str__() -> String - - - FromUserString(String s) -> bool - - - - - - ToUserString() -> String - - - - - __init__() -> NativeEncodingInfo - - - __del__() - - - - - FromString(String s) -> bool - - - - - - ToString() -> String - - - - GetNativeFontEncoding(int encoding) -> NativeEncodingInfo - - - - - - TestFontEncoding(NativeEncodingInfo info) -> bool - - - - - + + This is a `wx.DC` that can write to PostScript files on any platform. + + + __init__(self, wxPrintData printData) -> PostScriptDC + Constructs a PostScript printer device context from a `wx.PrintData` +object. + + + + + + GetPrintData(self) -> wxPrintData + + + 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__() -> FontMapper - - - __del__() - - - FontMapper.Get() -> FontMapper - - - FontMapper.Set(FontMapper mapper) -> FontMapper - - - - - - CharsetToEncoding(String charset, bool interactive=True) -> int - - - - - - - FontMapper.GetSupportedEncodingsCount() -> size_t - - - FontMapper.GetEncoding(size_t n) -> int - - - - - - FontMapper.GetEncodingName(int encoding) -> String - - - - - - FontMapper.GetEncodingDescription(int encoding) -> String - - - - - - SetConfig(ConfigBase config) - - - - - - SetConfigPath(String prefix) - - - - - - FontMapper.GetDefaultConfigPath() -> String - - - GetAltForEncoding(int encoding, String facename=EmptyString, bool interactive=True) -> PyObject - - - - - - - - IsEncodingAvailable(int encoding, String facename=EmptyString) -> bool - - - - - - - SetDialogParent(Window parent) - - - - - - SetDialogTitle(String title) - - - - - - + + + + __init__(self, String filename=EmptyString) -> MetaFile + + + + + + + + + __init__(self, String filename=EmptyString, int width=0, int height=0, + String description=EmptyString) -> MetaFileDC + + + + + + + + + + + + __init__(self, wxPrintData printData) -> PrinterDC + + + + + + #--------------------------------------------------------------------------- - - - - __init__(int pointSize, int family, int style, int weight, bool underline=False, - String face=EmptyString, + + + + __init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList + + + + + + + + + __del__(self) + + + Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int + + + + + + + AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int + + + + + + + AddIcon(self, Icon icon) -> int + + + + + + Replace(self, int index, Bitmap bitmap) -> bool + + + + + + + Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL, + bool solidBackground=False) -> bool + + + + + + + + + + + GetImageCount(self) -> int + + + Remove(self, int index) -> bool + + + + + + RemoveAll(self) -> bool + + + GetSize() -> (width,height) + + + + + + + + +#--------------------------------------------------------------------------- + + + + + AddPen(self, Pen pen) + + + + + + FindOrCreatePen(self, Colour colour, int width, int style) -> Pen + + + + + + + + RemovePen(self, Pen pen) + + + + + + GetCount(self) -> int + + + + + + AddBrush(self, Brush brush) + + + + + + FindOrCreateBrush(self, Colour colour, int style) -> Brush + + + + + + + RemoveBrush(self, Brush brush) + + + + + + GetCount(self) -> int + + + + + + __init__(self) -> ColourDatabase + + + __del__(self) + + + Find(self, String name) -> Colour + + + + + + FindName(self, Colour colour) -> String + + + + + + AddColour(self, String name, Colour colour) + + + + + + + Append(self, String name, int red, int green, int blue) + + + + + + + + + + + + AddFont(self, Font font) + + + + + + FindOrCreateFont(self, int point_size, int family, int style, int weight, + bool underline=False, String facename=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font - - - - - - - - - - - - FontFromNativeInfo(NativeFontInfo info) -> Font - - - - - - FontFromNativeInfoString(String info) -> Font - - - - - - Font2(int pointSize, int family, int flags=FONTFLAG_DEFAULT, - String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font - - - - - - - - - - __del__() - - - Ok() -> bool - - - __eq__(Font font) -> bool - - - - - - __ne__(Font font) -> bool - - - - - - GetPointSize() -> int - - - GetFamily() -> int - - - GetStyle() -> int - - - GetWeight() -> int - - - GetUnderlined() -> bool - - - GetFaceName() -> String - - - GetEncoding() -> int - - - GetNativeFontInfo() -> NativeFontInfo - - - IsFixedWidth() -> bool - - - GetNativeFontInfoDesc() -> String - - - GetNativeFontInfoUserDesc() -> String - - - SetPointSize(int pointSize) - - - - - - SetFamily(int family) - - - - - - SetStyle(int style) - - - - - - SetWeight(int weight) - - - - - - SetFaceName(String faceName) - - - - - - SetUnderlined(bool underlined) - - - - - - SetEncoding(int encoding) - - - - - - SetNativeFontInfo(NativeFontInfo info) - - - - - - SetNativeFontInfoFromString(String info) - - - - - - SetNativeFontInfoUserDesc(String info) - - - - - - GetFamilyString() -> String - - - GetStyleString() -> String - - - GetWeightString() -> String - - - SetNoAntiAliasing(bool no=True) - - - - - - GetNoAntiAliasing() -> bool - - - Font.GetDefaultEncoding() -> int - - - Font.SetDefaultEncoding(int encoding) - - - - - - + + + + + + + + + + + + RemoveFont(self, Font font) + + + + + + GetCount(self) -> int + + + #--------------------------------------------------------------------------- - - - __init__() -> FontEnumerator - - - __del__() - - - _setCallbackInfo(PyObject self, PyObject _class, bool incref) - - - - - - - - EnumerateFacenames(int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool - - - - - - - EnumerateEncodings(String facename=EmptyString) -> bool - - - - - - GetEncodings() -> PyObject - - - GetFacenames() -> PyObject - - - + NullColor = NullColour + #--------------------------------------------------------------------------- - - - - - - - - __init__(int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale - - - - - - - __del__() - - - Init1(String szName, String szShort=EmptyString, String szLocale=EmptyString, - bool bLoadDefault=True, - bool bConvertEncoding=False) -> bool - - - - - - - - - - Init2(int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool - - - - - - - Locale.GetSystemLanguage() -> int - - - Locale.GetSystemEncoding() -> int - - - Locale.GetSystemEncodingName() -> String - - - IsOk() -> bool - - - GetLocale() -> String - - - GetLanguage() -> int - - - GetSysName() -> String - - - GetCanonicalName() -> String - - - Locale.AddCatalogLookupPathPrefix(String prefix) - - - - - - AddCatalog(String szDomain) -> bool - - - - - - IsLoaded(String szDomain) -> bool - - - - - - Locale.GetLanguageInfo(int lang) -> LanguageInfo - - - - - - Locale.GetLanguageName(int lang) -> String - - - - - - Locale.FindLanguageInfo(String locale) -> LanguageInfo - - - - - - Locale.AddLanguage(LanguageInfo info) - - - - - - GetString(String szOrigString, String szDomain=EmptyString) -> String - - - - - - - GetName() -> String - - - - GetLocale() -> Locale - - - - - - - - GetTranslation(String sz) -> String -GetTranslation(String sz1, String sz2, size_t n) -> String - - - - - - - + + + + __init__(self) -> Effects + + + GetHighlightColour(self) -> Colour + + + GetLightShadow(self) -> Colour + + + GetFaceColour(self) -> Colour + + + GetMediumShadow(self) -> Colour + + + GetDarkShadow(self) -> Colour + + + SetHighlightColour(self, Colour c) + + + + + + SetLightShadow(self, Colour c) + + + + + + SetFaceColour(self, Colour c) + + + + + + SetMediumShadow(self, Colour c) + + + + + + SetDarkShadow(self, Colour c) + + + + + + Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour, + Colour mediumShadow, Colour darkShadow) + + + + + + + + + + DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1) + + + + + + + + TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool + + + + + + + + + + + wx = _core + #--------------------------------------------------------------------------- - - - - __init__() -> EncodingConverter - - - __del__() - - - Init(int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool - - - - - - - - Convert(String input) -> String - - - - - - EncodingConverter.GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray - - - - - - - EncodingConverter.GetAllEquivalents(int enc) -> wxFontEncodingArray - - - - - - EncodingConverter.CanConvert(int encIn, int encOut) -> bool - - - - - - - #---------------------------------------------------------------------------- -# 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 -# to the default catalog path. -if wx.Platform == "__WXMSW__": - import os - localedir = os.path.join(os.path.split(__file__)[0], "locale") - Locale_AddCatalogLookupPathPrefix(localedir) - del os + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, + String name=PanelNameStr) -> Panel + + + + + + + + + + + PrePanel() -> Panel + + + 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. + + + + + + + + + + + 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__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL, + String name=PanelNameStr) -> ScrolledWindow + + + + + + + + + + + PreScrolledWindow() -> ScrolledWindow + + + 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. + + + + + + + + + + + SetScrollbars(self, int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX, + int noUnitsY, int xPos=0, int yPos=0, bool noRefresh=False) + + + + + + + + + + + + Scroll(self, int x, int y) + + + + + + + GetScrollPageSize(self, int orient) -> int + + + + + + SetScrollPageSize(self, int orient, int pageSize) + + + + + + + SetScrollRate(self, int xstep, int ystep) + + + + + + + GetScrollPixelsPerUnit() -> (xUnit, yUnit) + Get the size of one logical unit in physical units. + + + + + + + EnableScrolling(self, bool x_scrolling, bool y_scrolling) + + + + + + + GetViewStart() -> (x,y) + Get the view start + + + + + + + SetScale(self, double xs, double ys) + + + + + + + GetScaleX(self) -> double + + + GetScaleY(self) -> double + + + Translate between scrolled and unscrolled coordinates. + + + + + + CalcScrolledPosition(self, Point pt) -> Point +CalcScrolledPosition(int x, int y) -> (sx, sy) + Translate between scrolled and unscrolled coordinates. + + + + + + + + + Translate between scrolled and unscrolled coordinates. + + + + + + CalcUnscrolledPosition(self, Point pt) -> Point +CalcUnscrolledPosition(int x, int y) -> (ux, uy) + Translate between scrolled and unscrolled coordinates. + + + + + + + + + AdjustScrollbars(self) + + + CalcScrollInc(self, ScrollWinEvent event) -> int + + + + + + SetTargetWindow(self, Window target) + + + + + + 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. + + + + + + #--------------------------------------------------------------------------- - - - - __del__() - - - BeginDrawing() - - - EndDrawing() - - - FloodFillXY(int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool - - - - - - - - - FloodFill(Point pt, Colour col, int style=FLOOD_SURFACE) -> bool - - - - - - - - GetPixelXY(int x, int y) -> Colour - - - - - - - GetPixel(Point pt) -> Colour - - - - - - DrawLineXY(int x1, int y1, int x2, int y2) - - - - - - - - - DrawLine(Point pt1, Point pt2) - - - - - - - CrossHairXY(int x, int y) - - - - - - - CrossHair(Point pt) - - - - - - DrawArcXY(int x1, int y1, int x2, int y2, int xc, int yc) - - - - - - - - - - - DrawArc(Point pt1, Point pt2, Point centre) - - - - - - - - DrawCheckMarkXY(int x, int y, int width, int height) - - - - - - - - - DrawCheckMark(Rect rect) - - - - - - DrawEllipticArcXY(int x, int y, int w, int h, double sa, double ea) - - - - - - - - - - - DrawEllipticArc(Point pt, Size sz, double sa, double ea) - - - - - - - - - DrawPointXY(int x, int y) - - - - - - - DrawPoint(Point pt) - - - - - - DrawRectangleXY(int x, int y, int width, int height) - - - - - - - - - DrawRectangle(Point pt, Size sz) - - - - - - - DrawRectangleRect(Rect rect) - - - - - - DrawRoundedRectangleXY(int x, int y, int width, int height, double radius) - - - - - - - - - - DrawRoundedRectangle(Point pt, Size sz, double radius) - - - - - - - - DrawRoundedRectangleRect(Rect r, double radius) - - - - - - - DrawCircleXY(int x, int y, int radius) - - - - - - - - DrawCircle(Point pt, int radius) - - - - - - - DrawEllipseXY(int x, int y, int width, int height) - - - - - - - - - DrawEllipse(Point pt, Size sz) - - - - - - - DrawEllipseRect(Rect rect) - - - - - - DrawIconXY(Icon icon, int x, int y) - - - - - - - - DrawIcon(Icon icon, Point pt) - - - - - - - DrawBitmapXY(Bitmap bmp, int x, int y, bool useMask=False) - - - - - - - - - DrawBitmap(Bitmap bmp, Point pt, bool useMask=False) - - - - - - - - DrawTextXY(String text, int x, int y) - - - - - - - - DrawText(String text, Point pt) - - - - - - - DrawRotatedTextXY(String text, int x, int y, double angle) - - - - - - - - - DrawRotatedText(String text, Point pt, double angle) - - - - - - - - BlitXY(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 - - - - - - - - - - - - - - - - Blit(Point destPt, Size sz, DC source, Point srcPt, int rop=COPY, - bool useMask=False, Point srcPtMask=DefaultPosition) -> bool - - - - - - - - - - - - DrawLines(int points, Point points_array, int xoffset=0, int yoffset=0) - - - - - - - - - DrawPolygon(int points, Point points_array, int xoffset=0, int yoffset=0, - int fillStyle=ODDEVEN_RULE) - - - - - - - - - - DrawLabel(String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, - int indexAccel=-1) - - - - - - - - - DrawImageLabel(String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, - int indexAccel=-1) -> Rect - - - - - - - - - - DrawSpline(int points, Point points_array) - - - - - - - Clear() - - - StartDoc(String message) -> bool - - - - - - EndDoc() - - - StartPage() - - - EndPage() - - - SetFont(Font font) - - - - - - SetPen(Pen pen) - - - - - - SetBrush(Brush brush) - - - - - - SetBackground(Brush brush) - - - - - - SetBackgroundMode(int mode) - - - - - - SetPalette(Palette palette) - - - - - - SetClippingRegionXY(int x, int y, int width, int height) - - - - - - - - - SetClippingRegion(Point pt, Size sz) - - - - - - - SetClippingRect(Rect rect) - - - - - - SetClippingRegionAsRegion(Region region) - - - - - - DestroyClippingRegion() - - - GetClippingBox() -> (x, y, width, height) - - - - - - - - - GetClippingRect() -> Rect - - - GetCharHeight() -> int - - - GetCharWidth() -> int - - - GetTextExtent(wxString string) -> (width, height) - Get the width and height of the text using the current font. -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. - - - - - - - - - - - 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. - - - - - - - - - - GetSize() -> Size - Get the DC size in device units. - - - GetSizeTuple() -> (width, height) - Get the DC size in device units. - - - - - - - GetSizeMM() -> Size - Get the DC size in milimeters. - - - GetSizeMMTuple() -> (width, height) - Get the DC size in milimeters. - - - - - - - DeviceToLogicalX(int x) -> int - - - - - - DeviceToLogicalY(int y) -> int - - - - - - DeviceToLogicalXRel(int x) -> int - - - - - - DeviceToLogicalYRel(int y) -> int - - - - - - LogicalToDeviceX(int x) -> int - - - - - - LogicalToDeviceY(int y) -> int - - - - - - LogicalToDeviceXRel(int x) -> int - - - - - - LogicalToDeviceYRel(int y) -> int - - - - - - CanDrawBitmap() -> bool - - - CanGetTextExtent() -> bool - - - GetDepth() -> int - - - GetPPI() -> Size - - - Ok() -> bool - - - GetBackgroundMode() -> int - - - GetBackground() -> Brush - - - GetBrush() -> Brush - - - GetFont() -> Font - - - GetPen() -> Pen - - - GetTextBackground() -> Colour - - - GetTextForeground() -> Colour - - - SetTextForeground(Colour colour) - - - - - - SetTextBackground(Colour colour) - - - - - - GetMapMode() -> int - - - SetMapMode(int mode) - - - - - - GetUserScale() -> (xScale, yScale) - - - - - - - SetUserScale(double x, double y) - - - - - - - GetLogicalScale() -> (xScale, yScale) - - - - - - - SetLogicalScale(double x, double y) - - - - - - - GetLogicalOrigin() -> Point - - - GetLogicalOriginTuple() -> (x,y) - - - - - - - SetLogicalOrigin(int x, int y) - - - - - - - GetDeviceOrigin() -> Point - - - GetDeviceOriginTuple() -> (x,y) - - - - - - - SetDeviceOrigin(int x, int y) - - - - - - - SetAxisOrientation(bool xLeftRight, bool yBottomUp) - - - - - - - GetLogicalFunction() -> int - - - SetLogicalFunction(int function) - - - - - - SetOptimization(bool opt) - - - - - - GetOptimization() -> bool - - - CalcBoundingBox(int x, int y) - - - - - - - ResetBoundingBox() - - - MinX() -> int - - - MaxX() -> int - - - MinY() -> int - - - MaxY() -> int - - - GetBoundingBox() -> (x1,y1, x2,y2) - - - - - - - - - _DrawPointList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject - - - - - - - - _DrawLineList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject - - - - - - - - _DrawRectangleList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject - - - - - - - - _DrawEllipseList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject - - - - - - - - _DrawPolygonList(PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject - - - - - - - - _DrawTextList(PyObject textList, PyObject pyPoints, PyObject foregroundList, - PyObject backgroundList) -> PyObject - - - - - - - - - + + + + Maximize(self, bool maximize=True) + + + + + + Restore(self) + + + Iconize(self, bool iconize=True) + + + + + + IsMaximized(self) -> bool + + + IsIconized(self) -> bool + + + GetIcon(self) -> Icon + + + SetIcon(self, Icon icon) + + + + + + SetIcons(self, wxIconBundle icons) + + + + + + ShowFullScreen(self, bool show, long style=FULLSCREEN_ALL) -> bool + + + + + + + IsFullScreen(self) -> bool + + + SetTitle(self, String title) + Sets the window's title. Applicable only to frames and dialogs. + + + + + + GetTitle(self) -> String + Gets the window's title. Applicable only to frames and dialogs. + + + SetShape(self, Region region) -> bool + + + + + + #--------------------------------------------------------------------------- - - - - __init__() -> MemoryDC - - - MemoryDCFromDC(DC oldDC) -> MemoryDC - - - - - - SelectObject(Bitmap bitmap) - - - - - - + + + + __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 + + + + + + + + + + + + PreFrame() -> Frame + + + 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 + + + + + + + + + + + + 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(self) + + + SetMenuBar(self, MenuBar menubar) + + + + + + GetMenuBar(self) -> MenuBar + + + ProcessCommand(self, int winid) -> bool + + + + + + CreateStatusBar(self, int number=1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE, + int winid=0, String name=StatusLineNameStr) -> StatusBar + + + + + + + + + GetStatusBar(self) -> StatusBar + + + SetStatusBar(self, StatusBar statBar) + + + + + + SetStatusText(self, String text, int number=0) + + + + + + + SetStatusWidths(self, int widths, int widths_field) + + + + + + + PushStatusText(self, String text, int number=0) + + + + + + + PopStatusText(self, int number=0) + + + + + + SetStatusBarPane(self, int n) + + + + + + GetStatusBarPane(self) -> int + + + CreateToolBar(self, long style=-1, int winid=-1, String name=ToolBarNameStr) -> wxToolBar + + + + + + + + GetToolBar(self) -> wxToolBar + + + SetToolBar(self, wxToolBar toolbar) + + + + + + DoGiveHelp(self, String text, bool show) + + + + + + + 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__(DC dc, Bitmap buffer) -> BufferedDC - - - - - - - BufferedDCInternalBuffer(DC dc, Size area) -> BufferedDC - - - - - - - UnMask() - - - - - - __init__(Window window, Bitmap buffer=NullBitmap) -> BufferedPaintDC - - - - - - - + + + + __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 + + + + + + + + + + + + PreDialog() -> Dialog + + + 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 + + + + + + + + + + + + SetReturnCode(self, int returnCode) + + + + + + GetReturnCode(self) -> int + + + CreateTextSizer(self, String message) -> Sizer + + + + + + CreateButtonSizer(self, long flags) -> Sizer + + + + + + IsModal(self) -> bool + + + ShowModal(self) -> int + + + EndModal(self, int retCode) + + + + + + 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__() -> ScreenDC - - - StartDrawingOnTopWin(Window window) -> bool - - - - - - StartDrawingOnTop(Rect rect=None) -> bool - - - - - - EndDrawingOnTop() -> bool - - - + + + + __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 + + + + + + + + + + + + PreMiniFrame() -> MiniFrame + + + 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 + + + + + + + + + + + + #--------------------------------------------------------------------------- - - - - __init__(Window win) -> ClientDC - - - - - - + + + + __init__(self, Bitmap bitmap, Window parent, int id, Point pos=DefaultPosition, + Size size=DefaultSize, long style=NO_BORDER) -> SplashScreenWindow + + + + + + + + + + + SetBitmap(self, Bitmap bitmap) + + + + + + GetBitmap(self) -> Bitmap + + + + + + __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(self) -> long + + + GetSplashWindow(self) -> SplashScreenWindow + + + GetTimeout(self) -> int + + + #--------------------------------------------------------------------------- - - - - __init__(Window win) -> PaintDC - - - - - - + + + + __init__(self, Window parent, int id=-1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE, + String name=StatusLineNameStr) -> StatusBar + + + + + + + + + PreStatusBar() -> StatusBar + + + Create(self, Window parent, int id=-1, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> bool + + + + + + + + + SetFieldsCount(self, int number=1) + + + + + + GetFieldsCount(self) -> int + + + SetStatusText(self, String text, int number=0) + + + + + + + GetStatusText(self, int number=0) -> String + + + + + + PushStatusText(self, String text, int number=0) + + + + + + + PopStatusText(self, int number=0) + + + + + + SetStatusWidths(self, int widths, int widths_field) + + + + + + + SetStatusStyles(self, int styles, int styles_field) + + + + + + + GetFieldRect(self, int i) -> Rect + + + + + + SetMinHeight(self, int height) + + + + + + GetBorderX(self) -> 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. + + + + + + #--------------------------------------------------------------------------- - - - - __init__(Window win) -> WindowDC - - - - - - + + 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. + wx.SP_BORDER Draws a standard border. + wx.SP_NOBORDER No border (default). + wx.SP_NO_XP_THEME Under Windows XP, switches off the + attempt to draw the splitter + using Windows XP theming, so the + borders and sash will take on the + pre-XP look. + wx.SP_PERMIT_UNSPLIT Always allow to unsplit, even with + the minimum pane size other than zero. + wx.SP_LIVE_UPDATE Don't draw XOR line but resize the + child windows immediately. + ==================== ====================================== + +Events +------ + ============================== ======================================= + EVT_SPLITTER_SASH_POS_CHANGING The sash position is in the + process of being changed. May be + used to modify the position of + the tracking bar to properly + reflect the position that would + be set if the drag were to be + completed at this point. + + EVT_SPLITTER_SASH_POS_CHANGED + The sash position was + changed. May be used to modify + the sash position before it is + set, or to prevent the change + from taking place. + + EVT_SPLITTER_UNSPLIT The splitter has been just unsplit. + + EVT_SPLITTER_DCLICK The sash was double clicked. The + default behaviour is to unsplit + the window when this happens + (unless the minimum pane size has + been set to a value greater than + zero.) + ============================== ======================================= + + + + + __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. + + + + + + + + + + + PreSplitterWindow() -> SplitterWindow + Precreate a SplitterWindow for 2-phase creation. + + + 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. + + + + + + + + + + + GetWindow1(self) -> Window + Gets the only or left/top pane. + + + GetWindow2(self) -> Window + Gets the right/bottom pane. + + + 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. + + + + + + GetSplitMode(self) -> int + Gets the split mode + + + 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(self, Window window1, Window window2, int sashPosition=0) -> bool + Initializes the left and right panes of the splitter window. + :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. + + + + + + + + + SplitHorizontally(self, Window window1, Window window2, int sashPosition=0) -> bool + Initializes the top and bottom panes of the splitter window. + :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). + +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. + + + + + + + + + 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 +for the desired behaviour. By default, the pane being +removed is only hidden. + + + + + + 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. + + + + + + + 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(self) -> bool + Is the window split? + + + SetSashSize(self, int width) + Sets the sash size + + + + + + SetBorderSize(self, int width) + Sets the border size + + + + + + GetSashSize(self) -> int + Gets the sash size + + + GetBorderSize(self) -> int + Gets the border size + + + 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(self) -> int + Returns the surrent sash position. + + + 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. + + + + + + GetMinimumPaneSize(self) -> int + Gets the minimum pane size in pixels. + + + SashHitTest(self, int x, int y, int tolerance=5) -> bool + Tests for x, y over the sash + + + + + + + + SizeWindows(self) + Resizes subwindows + + + SetNeedUpdating(self, bool needUpdating) + + + + + + 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__(self, wxEventType type=wxEVT_NULL, SplitterWindow splitter=(wxSplitterWindow *) NULL) -> SplitterEvent + This class represents the events generated by a splitter control. + + + + + + + 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(self) -> int + Returns the new sash position while in EVT_SPLITTER_SASH_POS_CHANGING +and EVT_SPLITTER_SASH_POS_CHANGED events. + + + GetWindowBeingRemoved(self) -> Window + Returns a pointer to the window being removed when a splitter window +is unsplit. + + + GetX(self) -> int + Returns the x coordinate of the double-click point in a +EVT_SPLITTER_DCLICK event. + + + GetY(self) -> int + Returns the y coordinate of the double-click point in a +EVT_SPLITTER_DCLICK event. + + + +EVT_SPLITTER_SASH_POS_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, 1 ) +EVT_SPLITTER_SASH_POS_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, 1 ) +EVT_SPLITTER_DOUBLECLICKED = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, 1 ) +EVT_SPLITTER_UNSPLIT = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_UNSPLIT, 1 ) +EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED + + #--------------------------------------------------------------------------- - - - - __init__(DC dc, bool mirror) -> MirrorDC - - - - - - - + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, + String name=SashNameStr) -> SashWindow + + + + + + + + + + + PreSashWindow() -> SashWindow + + + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, + String name=SashNameStr) -> bool + + + + + + + + + + + SetSashVisible(self, int edge, bool sash) + + + + + + + GetSashVisible(self, int edge) -> bool + + + + + + SetSashBorder(self, int edge, bool border) + + + + + + + HasBorder(self, int edge) -> bool + + + + + + GetEdgeMargin(self, int edge) -> int + + + + + + SetDefaultBorderSize(self, int width) + + + + + + GetDefaultBorderSize(self) -> int + + + SetExtraBorderSize(self, int width) + + + + + + GetExtraBorderSize(self) -> int + + + SetMinimumSizeX(self, int min) + + + + + + SetMinimumSizeY(self, int min) + + + + + + GetMinimumSizeX(self) -> int + + + GetMinimumSizeY(self) -> int + + + SetMaximumSizeX(self, int max) + + + + + + SetMaximumSizeY(self, int max) + + + + + + GetMaximumSizeX(self) -> int + + + GetMaximumSizeY(self) -> int + + + SashHitTest(self, int x, int y, int tolerance=2) -> int + + + + + + + + SizeWindows(self) + + + + + + __init__(self, int id=0, int edge=SASH_NONE) -> SashEvent + + + + + + + SetEdge(self, int edge) + + + + + + GetEdge(self) -> int + + + SetDragRect(self, Rect rect) + + + + + + GetDragRect(self) -> Rect + + + SetDragStatus(self, int status) + + + + + + GetDragStatus(self) -> int + + + + EVT_SASH_DRAGGED = wx.PyEventBinder( wxEVT_SASH_DRAGGED, 1 ) + EVT_SASH_DRAGGED_RANGE = wx.PyEventBinder( wxEVT_SASH_DRAGGED, 2 ) + + #--------------------------------------------------------------------------- - - - - __init__(wxPrintData printData) -> PostScriptDC - - - - - - GetPrintData() -> wxPrintData - - - SetPrintData(wxPrintData data) - - - - - - PostScriptDC.SetResolution(int ppi) - - - - - - PostScriptDC.GetResolution() -> int - - - + + + + __init__(self, int id=0) -> QueryLayoutInfoEvent + + + + + + SetRequestedLength(self, int length) + + + + + + GetRequestedLength(self) -> int + + + SetFlags(self, int flags) + + + + + + GetFlags(self) -> int + + + SetSize(self, Size size) + + + + + + GetSize(self) -> Size + + + SetOrientation(self, int orient) + + + + + + GetOrientation(self) -> int + + + SetAlignment(self, int align) + + + + + + GetAlignment(self) -> int + + + + + + __init__(self, int id=0) -> CalculateLayoutEvent + + + + + + SetFlags(self, int flags) + + + + + + GetFlags(self) -> int + + + SetRect(self, Rect rect) + + + + + + GetRect(self) -> Rect + + + + EVT_QUERY_LAYOUT_INFO = wx.PyEventBinder( wxEVT_QUERY_LAYOUT_INFO ) + EVT_CALCULATE_LAYOUT = wx.PyEventBinder( wxEVT_CALCULATE_LAYOUT ) + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, + String name=SashLayoutNameStr) -> SashLayoutWindow + + + + + + + + + + + PreSashLayoutWindow() -> SashLayoutWindow + + + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, + String name=SashLayoutNameStr) -> bool + + + + + + + + + + + GetAlignment(self) -> int + + + GetOrientation(self) -> int + + + SetAlignment(self, int alignment) + + + + + + SetDefaultSize(self, Size size) + + + + + + SetOrientation(self, int orientation) + + + + + + + + + __init__(self) -> LayoutAlgorithm + + + __del__(self) + + + LayoutMDIFrame(self, MDIParentFrame frame, Rect rect=None) -> bool + + + + + + + LayoutFrame(self, Frame frame, Window mainWindow=None) -> bool + + + + + + + LayoutWindow(self, Window parent, Window mainWindow=None) -> bool + + + + + + + #--------------------------------------------------------------------------- - - - - __init__(String filename=EmptyString) -> MetaFile - - - - - - - - - __init__(String filename=EmptyString, int width=0, int height=0, - String description=EmptyString) -> MetaFileDC - - - - - - - - - - - - __init__(wxPrintData printData) -> PrinterDC - - - - - - + + + + __init__(self, Window parent, int flags=BORDER_NONE) -> PopupWindow + + + + + + + PrePopupWindow() -> PopupWindow + + + Create(self, Window parent, int flags=BORDER_NONE) -> bool + + + + + + + Position(self, Point ptOrigin, Size size) + + + + + + + #--------------------------------------------------------------------------- - - - - __init__(int width, int height, int mask=True, int initialCount=1) -> ImageList - - - - - - - - - __del__() - - - Add(Bitmap bitmap, Bitmap mask=NullBitmap) -> int - - - - - - - AddWithColourMask(Bitmap bitmap, Colour maskColour) -> int - - - - - - - AddIcon(Icon icon) -> int - - - - - - Replace(int index, Bitmap bitmap) -> bool - - - - - - - Draw(int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL, - bool solidBackground=False) -> bool - - - - - - - - - - - GetImageCount() -> int - - - Remove(int index) -> bool - - - - - - RemoveAll() -> bool - - - GetSize() -> (width,height) - - - - - - - - + + + + __init__(self, Window parent, int style=BORDER_NONE) -> PopupTransientWindow + + + + + + + PrePopupTransientWindow() -> PopupTransientWindow + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + Popup(self, Window focus=None) + + + + + + Dismiss(self) + + + #--------------------------------------------------------------------------- - - - - AddPen(Pen pen) - - - - - - FindOrCreatePen(Colour colour, int width, int style) -> Pen - - - - - - - - RemovePen(Pen pen) - - - - - - GetCount() -> int - - - - - - AddBrush(Brush brush) - - - - - - FindOrCreateBrush(Colour colour, int style) -> Brush - - - - - - - RemoveBrush(Brush brush) - - - - - - GetCount() -> int - - - - - - __init__() -> ColourDatabase - - - __del__() - - - Find(String name) -> Colour - - - - - - FindName(Colour colour) -> String - - - - - - AddColour(String name, Colour colour) - - - - - - - Append(String name, int red, int green, int blue) - - - - - - - - - - - - AddFont(Font font) - - - - - - FindOrCreateFont(int point_size, int family, int style, int weight, - bool underline=False, String facename=EmptyString, - int encoding=FONTENCODING_DEFAULT) -> Font - - - - - - - - - - - - RemoveFont(Font font) - - - - - - GetCount() -> int - - - + + + + __init__(self, Window parent, String text, int maxLength=100, Rect rectBound=None) -> TipWindow + + + + + + + + + SetBoundingRect(self, Rect rectBound) + + + + + + Close(self) + + + #--------------------------------------------------------------------------- - + + + + __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=PanelNameStr) -> VScrolledWindow + + + + + + + + + + + PreVScrolledWindow() -> VScrolledWindow + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool + + + + + + + + + + + SetLineCount(self, size_t count) + + + + + + ScrollToLine(self, size_t line) -> 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 +already on top/bottom and nothing was done. + + + + + + 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. + + + + + + RefreshLine(self, size_t line) + + + + + + RefreshLines(self, size_t from, size_t to) + + + + + + + HitTestXY(self, int x, int y) -> int + Test where the given (in client coords) point lies + + + + + + + HitTest(self, Point pt) -> int + Test where the given (in client coords) point lies + + + + + + RefreshAll(self) + + + GetLineCount(self) -> size_t + + + GetFirstVisibleLine(self) -> size_t + + + GetLastVisibleLine(self) -> size_t + + + IsVisible(self, size_t line) -> bool + + + + + + + + + __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> VListBox + + + + + + + + + + + PreVListBox() -> VListBox + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool + + + + + + + + + + + GetItemCount(self) -> size_t + + + HasMultipleSelection(self) -> bool + + + GetSelection(self) -> int + + + IsCurrent(self, size_t item) -> bool + + + + + + IsSelected(self, size_t item) -> bool + + + + + + GetSelectedCount(self) -> size_t + + + GetFirstSelected(self) -> PyObject + + + GetNextSelected(self, unsigned long cookie) -> PyObject + + + + + + GetMargins(self) -> Point + + + GetSelectionBackground(self) -> Colour + + + SetItemCount(self, size_t count) + + + + + + Clear(self) + + + SetSelection(self, int selection) + + + + + + Select(self, size_t item, bool select=True) -> bool + + + + + + + SelectRange(self, size_t from, size_t to) -> bool + + + + + + + Toggle(self, size_t item) + + + + + + SelectAll(self) -> bool + + + DeselectAll(self) -> bool + + + SetMargins(self, Point pt) + + + + + + SetMarginsXY(self, int x, int y) + + + + + + + SetSelectionBackground(self, Colour col) + + + + + + + + + __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> HtmlListBox + + + + + + + + + + + PreHtmlListBox() -> HtmlListBox + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool + + + + + + + + + + + RefreshAll(self) + + + SetItemCount(self, size_t count) + + + + + + GetFileSystem(self) -> FileSystem + + + #--------------------------------------------------------------------------- - - - - __init__() -> Effects - - - GetHighlightColour() -> Colour - - - GetLightShadow() -> Colour - - - GetFaceColour() -> Colour - - - GetMediumShadow() -> Colour - - - GetDarkShadow() -> Colour - - - SetHighlightColour(Colour c) - - - - - - SetLightShadow(Colour c) - - - - - - SetFaceColour(Colour c) - - - - - - SetMediumShadow(Colour c) - - - - - - SetDarkShadow(Colour c) - - - - - - Set(Colour highlightColour, Colour lightShadow, Colour faceColour, - Colour mediumShadow, Colour darkShadow) - - - - - - - - - - DrawSunkenEdge(DC dc, Rect rect, int borderSize=1) - - - - - - - - TileBitmap(Rect rect, DC dc, Bitmap bitmap) -> bool - - - - - - - - - - wx = core - + + + + __init__(self) -> TaskBarIcon + + + __del__(self) + + + Destroy(self) + Deletes the C++ object this Python object is a proxy for. + + + IsOk(self) -> bool + + + IsIconInstalled(self) -> bool + + + SetIcon(self, Icon icon, String tooltip=EmptyString) -> bool + + + + + + + RemoveIcon(self) -> bool + + + PopupMenu(self, Menu menu) -> bool + + + + + + + + + __init__(self, wxEventType evtType, TaskBarIcon tbIcon) -> TaskBarIconEvent + + + + + + + +EVT_TASKBAR_MOVE = wx.PyEventBinder ( wxEVT_TASKBAR_MOVE ) +EVT_TASKBAR_LEFT_DOWN = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_DOWN ) +EVT_TASKBAR_LEFT_UP = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_UP ) +EVT_TASKBAR_RIGHT_DOWN = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_DOWN ) +EVT_TASKBAR_RIGHT_UP = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_UP ) +EVT_TASKBAR_LEFT_DCLICK = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_DCLICK ) +EVT_TASKBAR_RIGHT_DCLICK = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_DCLICK ) + + #--------------------------------------------------------------------------- - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, - String name=PanelNameStr) -> Panel - - - - - - - - - - - PrePanel() -> Panel - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxTAB_TRAVERSAL|wxNO_BORDER, - String name=PanelNameStr) -> bool - - - - - - - - - - - InitDialog() - - - + + 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__(self) -> ColourData + Constructor, sets default values. + + + __del__(self) + + + 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(self) -> Colour + Gets the colour (pre)selected by the dialog. + + + 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(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(self, Colour colour) + Sets the default colour for the colour dialog. The default colour is +black. + + + + + + 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__(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(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__(self, Window parent, String message=DirSelectorPromptStr, + String defaultPath=EmptyString, long style=0, + Point pos=DefaultPosition, Size size=DefaultSize, + String name=DirDialogNameStr) -> DirDialog + Constructor. Use ShowModal method to show the dialog. + + + + + + + + + + + + GetPath(self) -> String + Returns the default or user-selected path. + + + GetMessage(self) -> String + Returns the message that will be displayed on the dialog. + + + GetStyle(self) -> long + Returns the dialog style. + + + SetMessage(self, String message) + Sets the message that will be displayed on the dialog. + + + + + + SetPath(self, String path) + Sets the default path. + + + + + + + wx.FileDialog allows the user to select one or more files from the +filesystem. + +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" + + +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.OVERWRITE_PROMPT For save dialog only: prompt for a confirmation + if a file will be overwritten. + + wx.MULTIPLE For open dialog only: allows selecting multiple + files. + + wx.CHANGE_DIR Change the current working directory to the + directory where the file(s) chosen by the user + are. + =================== ========================================== + + + + __init__(self, Window parent, String message=FileSelectorPromptStr, + String defaultDir=EmptyString, String defaultFile=EmptyString, + String wildcard=FileSelectorDefaultWildcardStr, + long style=0, Point pos=DefaultPosition) -> FileDialog + Constructor. Use ShowModal method to show the dialog. + + + + + + + + + + + + SetMessage(self, String message) + Sets the message that will be displayed on the dialog. + + + + + + SetPath(self, String path) + Sets the path (the combined directory and filename that will be +returned when the dialog is dismissed). + + + + + + SetDirectory(self, String dir) + Sets the default directory. + + + + + + SetFilename(self, String name) + Sets the default filename. + + + + + + SetWildcard(self, String wildCard) + Sets the wildcard, which can contain multiple file types, for +example:: + + "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" + + + + + + + SetStyle(self, long style) + Sets the dialog style. + + + + + + SetFilterIndex(self, int filterIndex) + Sets the default filter index, starting from zero. + + + + + + GetMessage(self) -> String + Returns the message that will be displayed on the dialog. + + + GetPath(self) -> String + Returns the full path (directory and filename) of the selected file. + + + GetDirectory(self) -> String + Returns the default directory. + + + GetFilename(self) -> String + Returns the default filename. + + + GetWildcard(self) -> String + Returns the file dialog wildcard. + + + GetStyle(self) -> long + Returns the dialog style. + + + 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. + + + 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(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. + + + + A simple dialog with a multi selection listbox. + + + __init__(Window parent, String message, String caption, + List choices=[], long style=CHOICEDLG_STYLE, + Point pos=DefaultPosition) -> MultiChoiceDialog + Constructor. Use ShowModal method to show the dialog. + + + + + + + + + + + + SetSelections(List selections) + Specify the items in the list that should be selected, using a list of +integers. + + + + + + GetSelections() -> [selections] + Returns a list of integers representing the items that are selected. + + + + A simple dialog with a single selection listbox. + + + __init__(Window parent, String message, String caption, + List choices=[], long style=CHOICEDLG_STYLE, + Point pos=DefaultPosition) -> SingleChoiceDialog + Constructor. Use ShowModal method to show the dialog. + + + + + + + + + + + + GetSelection(self) -> int + Get the index of teh currently selected item. + + + GetStringSelection(self) -> String + Returns the string value of the currently selected item + + + SetSelection(self, int sel) + Set the current selected item to sel + + + + + + + A dialog with text control, [ok] and [cancel] buttons + + + __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. + + + + + + + + + + + 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(self, String value) + Sets the default text value. + + + + + + + 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__(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__(self) + + + 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(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(self) -> Colour + Gets the colour associated with the font dialog. The default value is +black. + + + GetChosenFont(self) -> Font + Gets the font chosen by the user. + + + GetEnableEffects(self) -> bool + Determines whether 'effects' are enabled under Windows. + + + 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(self) -> bool + Returns true if the Help button will be shown (Windows only). The +default value is false. + + + 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(self, Font font) + Sets the font that will be returned to the user (normally for internal +use only). + + + + + + SetColour(self, Colour colour) + Sets the colour that will be used for the font foreground colour. The +default colour is black. + + + + + + SetInitialFont(self, Font font) + Sets the font that will be initially used by the font dialog. + + + + + + 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(self, bool showHelp) + Determines whether the Help button will be displayed in the font +dialog (Windows only). The default value is false. + + + + + + + wx.FontDialog allows the user to select a system font and its attributes. + +:see: `wx.FontData` + + + + __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(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__(self, Window parent, String message, String caption=MessageBoxCaptionStr, + long style=wxOK|wxCANCEL|wxCENTRE, + Point pos=DefaultPosition) -> MessageDialog + Constructor, use `ShowModal` to display the dialog. + + + + + + + + + + + A dialog that shows a short message and a progress bar. Optionally, it +can display an ABORT button. + +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_CAN_ABORT This flag tells the dialog that it should have + a "Cancel" button which the user may press. If + this happens, the next call to Update() will + return false. + + wx.PD_ELAPSED_TIME This flag tells the dialog that it should show + elapsed time (since creating the dialog). + + wx.PD_ESTIMATED_TIME This flag tells the dialog that it should show + estimated time. + + wx.PD_REMAINING_TIME This flag tells the dialog that it should show + remaining time. + ==================== ============================================= + + + + __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 wx.PD_APP_MODAL flag is not given, for its +parent window only. + + + + + + + + + + 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. + + + + + + + Resume(self) + Can be used to continue with the dialog, after the user had chosen to +abort. + + + +EVT_FIND = wx.PyEventBinder( wxEVT_COMMAND_FIND, 1 ) +EVT_FIND_NEXT = wx.PyEventBinder( wxEVT_COMMAND_FIND_NEXT, 1 ) +EVT_FIND_REPLACE = wx.PyEventBinder( wxEVT_COMMAND_FIND_REPLACE, 1 ) +EVT_FIND_REPLACE_ALL = wx.PyEventBinder( wxEVT_COMMAND_FIND_REPLACE_ALL, 1 ) +EVT_FIND_CLOSE = wx.PyEventBinder( wxEVT_COMMAND_FIND_CLOSE, 1 ) + +# For backwards compatibility. Should they be removed? +EVT_COMMAND_FIND = EVT_FIND +EVT_COMMAND_FIND_NEXT = EVT_FIND_NEXT +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__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> FindDialogEvent + Events for the FindReplaceDialog + + + + + + + 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(self) -> String + Return the string to find (never empty). + + + GetReplaceString(self) -> String + Return the string to replace the search string with (only for replace +and replace all events). + + + GetDialog(self) -> FindReplaceDialog + Return the pointer to the dialog which generated this event. + + + SetFlags(self, int flags) + + + + + + SetFindString(self, String str) + + + + + + SetReplaceString(self, String str) + + + + + + + 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. + +Flags +----- + ================ =============================================== + wx.FR_DOWN Downward search/replace selected (otherwise, + upwards) + + wx.FR_WHOLEWORD Whole word search/replace selected + + wx.FR_MATCHCASE Case sensitive search/replace selected + (otherwise, case insensitive) + ================ =============================================== + + + + __init__(self, int flags=0) -> FindReplaceData + Constuctor initializes the flags to default value (0). + + + + + + __del__(self) + + + GetFindString(self) -> String + Get the string to find. + + + GetReplaceString(self) -> String + Get the replacement string. + + + GetFlags(self) -> int + Get the combination of flag values. + + + SetFlags(self, int flags) + Set the flags to use to initialize the controls of the dialog. + + + + + + SetFindString(self, String str) + Set the string to find (used as initial value by the dialog). + + + + + + SetReplaceString(self, String str) + Set the replacement string (used as initial value by the 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. + + +Window Styles +------------- + + ===================== ========================================= + wx.FR_REPLACEDIALOG replace dialog (otherwise find dialog) + + wx.FR_NOUPDOWN don't allow changing the search direction + + wx.FR_NOMATCHCASE don't allow case sensitive searching + + wx.FR_NOWHOLEWORD don't allow whole word searching + ===================== ========================================= + + + + __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. + + + + + + + + + PreFindReplaceDialog() -> FindReplaceDialog + Precreate a FindReplaceDialog for 2-phase creation + + + Create(self, Window parent, FindReplaceData data, String title, + int style=0) -> bool + Create the dialog, for 2-phase create. + + + + + + + + + GetData(self) -> FindReplaceData + Get the FindReplaceData object used by this dialog. + + + SetData(self, FindReplaceData data) + Set the FindReplaceData object used by this dialog. + + + + + + #--------------------------------------------------------------------------- - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL, - String name=PanelNameStr) -> ScrolledWindow - - - - - - - - - - - PreScrolledWindow() -> ScrolledWindow - - - Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL, - String name=PanelNameStr) -> bool - - - - - - - - - - - SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX, - int noUnitsY, int xPos=0, int yPos=0, bool noRefresh=False) - - - - - - - - - - - - Scroll(int x, int y) - - - - - - - GetScrollPageSize(int orient) -> int - - - - - - SetScrollPageSize(int orient, int pageSize) - - - - - - - SetScrollRate(int xstep, int ystep) - - - - - - - GetScrollPixelsPerUnit() -> (xUnit, yUnit) - Get the size of one logical unit in physical units. - - - - - - - EnableScrolling(bool x_scrolling, bool y_scrolling) - - - - - - - GetViewStart() -> (x,y) - Get the view start - - - - - - - SetScale(double xs, double ys) - - - - - - - GetScaleX() -> double - - - GetScaleY() -> double - - - Translate between scrolled and unscrolled coordinates. - - - - - - CalcScrolledPosition(Point pt) -> Point -CalcScrolledPosition(int x, int y) -> (sx, sy) - Translate between scrolled and unscrolled coordinates. - - - - - - - - - Translate between scrolled and unscrolled coordinates. - - - - - - CalcUnscrolledPosition(Point pt) -> Point -CalcUnscrolledPosition(int x, int y) -> (ux, uy) - Translate between scrolled and unscrolled coordinates. - - - - - - - - - AdjustScrollbars() - - - CalcScrollInc(ScrollWinEvent event) -> int - - - - - - SetTargetWindow(Window target) - - - - - - GetTargetWindow() -> Window - - - + + + + __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 + + + + + + + + + + + + PreMDIParentFrame() -> MDIParentFrame + + + 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 + + + + + + + + + + + + ActivateNext(self) + + + ActivatePrevious(self) + + + ArrangeIcons(self) + + + Cascade(self) + + + GetActiveChild(self) -> MDIChildFrame + + + GetClientWindow(self) -> MDIClientWindow + + + GetToolBar(self) -> Window + + + Tile(self) + + + + + + __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 + + + + + + + + + + + + PreMDIChildFrame() -> MDIChildFrame + + + 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 + + + + + + + + + + + + Activate(self) + + + Maximize(self, bool maximize) + + + + + + Restore(self) + + + + + + __init__(self, MDIParentFrame parent, long style=0) -> MDIClientWindow + + + + + + + PreMDIClientWindow() -> MDIClientWindow + + + Create(self, MDIParentFrame parent, long style=0) -> bool + + + + + + + #--------------------------------------------------------------------------- - - - - Maximize(bool maximize=True) - - - - - - Restore() - - - Iconize(bool iconize=True) - - - - - - IsMaximized() -> bool - - - IsIconized() -> bool - - - GetIcon() -> Icon - - - SetIcon(Icon icon) - - - - - - SetIcons(wxIconBundle icons) - - - - - - ShowFullScreen(bool show, long style=FULLSCREEN_ALL) -> bool - - - - - - - IsFullScreen() -> bool - - - SetTitle(String title) - - - - - - GetTitle() -> String - - - SetShape(Region region) -> bool - - - - - - + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=PanelNameStr) -> PyWindow + + + + + + + + + + + PrePyWindow() -> PyWindow + + + _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) -> 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(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__(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, - String name=FrameNameStr) -> Frame - - - - - - - - - - - - PreFrame() -> Frame - - - Create(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, - String name=FrameNameStr) -> bool - - - - - - - - - - - - GetClientAreaOrigin() -> Point - - - SendSizeEvent() - - - SetMenuBar(MenuBar menubar) - - - - - - GetMenuBar() -> MenuBar - - - ProcessCommand(int winid) -> bool - - - - - - CreateStatusBar(int number=1, long style=ST_SIZEGRIP, int winid=0, - String name=StatusLineNameStr) -> StatusBar - - - - - - - - - GetStatusBar() -> StatusBar - - - SetStatusBar(StatusBar statBar) - - - - - - SetStatusText(String text, int number=0) - - - - - - - SetStatusWidths(int widths, int widths_field) - - - - - - - PushStatusText(String text, int number=0) - - - - - - - PopStatusText(int number=0) - - - - - - SetStatusBarPane(int n) - - - - - - GetStatusBarPane() -> int - - - CreateToolBar(long style=-1, int winid=-1, String name=ToolBarNameStr) -> wxToolBar - - - - - - - - GetToolBar() -> wxToolBar - - - SetToolBar(wxToolBar toolbar) - - - - - - DoGiveHelp(String text, bool show) - - - - - - - DoMenuUpdates(Menu menu=None) - - - - - - + + + + + __init__(self) -> PrintData +__init__(self, PrintData data) -> PrintData + + + + + + __del__(self) + + + GetNoCopies(self) -> int + + + GetCollate(self) -> bool + + + GetOrientation(self) -> int + + + Ok(self) -> bool + + + GetPrinterName(self) -> String + + + GetColour(self) -> bool + + + GetDuplex(self) -> int + + + GetPaperId(self) -> int + + + GetPaperSize(self) -> Size + + + GetQuality(self) -> int + + + SetNoCopies(self, int v) + + + + + + SetCollate(self, bool flag) + + + + + + SetOrientation(self, int orient) + + + + + + SetPrinterName(self, String name) + + + + + + SetColour(self, bool colour) + + + + + + SetDuplex(self, int duplex) + + + + + + SetPaperId(self, int sizeId) + + + + + + SetPaperSize(self, Size sz) + + + + + + SetQuality(self, int quality) + + + + + + GetPrinterCommand(self) -> String + + + GetPrinterOptions(self) -> String + + + GetPreviewCommand(self) -> String + + + GetFilename(self) -> String + + + GetFontMetricPath(self) -> String + + + GetPrinterScaleX(self) -> double + + + GetPrinterScaleY(self) -> double + + + GetPrinterTranslateX(self) -> long + + + GetPrinterTranslateY(self) -> long + + + GetPrintMode(self) -> int + + + SetPrinterCommand(self, String command) + + + + + + SetPrinterOptions(self, String options) + + + + + + SetPreviewCommand(self, String command) + + + + + + SetFilename(self, String filename) + + + + + + SetFontMetricPath(self, String path) + + + + + + SetPrinterScaleX(self, double x) + + + + + + SetPrinterScaleY(self, double y) + + + + + + SetPrinterScaling(self, double x, double y) + + + + + + + SetPrinterTranslateX(self, long x) + + + + + + SetPrinterTranslateY(self, long y) + + + + + + SetPrinterTranslation(self, long x, long y) + + + + + + + SetPrintMode(self, int printMode) + + + + + + GetOutputStream(self) -> OutputStream + + + SetOutputStream(self, OutputStream outputstream) + + + + + + + + + + __init__(self) -> PageSetupDialogData +__init__(self, PageSetupDialogData data) -> PageSetupDialogData + + + + + + __del__(self) + + + EnableHelp(self, bool flag) + + + + + + EnableMargins(self, bool flag) + + + + + + EnableOrientation(self, bool flag) + + + + + + EnablePaper(self, bool flag) + + + + + + EnablePrinter(self, bool flag) + + + + + + GetDefaultMinMargins(self) -> bool + + + GetEnableMargins(self) -> bool + + + GetEnableOrientation(self) -> bool + + + GetEnablePaper(self) -> bool + + + GetEnablePrinter(self) -> bool + + + GetEnableHelp(self) -> bool + + + GetDefaultInfo(self) -> bool + + + GetMarginTopLeft(self) -> Point + + + GetMarginBottomRight(self) -> Point + + + GetMinMarginTopLeft(self) -> Point + + + GetMinMarginBottomRight(self) -> Point + + + GetPaperId(self) -> int + + + GetPaperSize(self) -> Size + + + GetPrintData(self) -> PrintData + + + Ok(self) -> bool + + + SetDefaultInfo(self, bool flag) + + + + + + SetDefaultMinMargins(self, bool flag) + + + + + + SetMarginTopLeft(self, Point pt) + + + + + + SetMarginBottomRight(self, Point pt) + + + + + + SetMinMarginTopLeft(self, Point pt) + + + + + + SetMinMarginBottomRight(self, Point pt) + + + + + + SetPaperId(self, int id) + + + + + + SetPaperSize(self, Size size) + + + + + + SetPrintData(self, PrintData printData) + + + + + + + + + __init__(self, Window parent, PageSetupDialogData data=None) -> PageSetupDialog + + + + + + + GetPageSetupData(self) -> PageSetupDialogData + + + ShowModal(self) -> int + + + + + + + __init__(self) -> PrintDialogData +__init__(self, PrintData printData) -> PrintDialogData + + + + + + __del__(self) + + + GetFromPage(self) -> int + + + GetToPage(self) -> int + + + GetMinPage(self) -> int + + + GetMaxPage(self) -> int + + + GetNoCopies(self) -> int + + + GetAllPages(self) -> bool + + + GetSelection(self) -> bool + + + GetCollate(self) -> bool + + + GetPrintToFile(self) -> bool + + + GetSetupDialog(self) -> bool + + + SetFromPage(self, int v) + + + + + + SetToPage(self, int v) + + + + + + SetMinPage(self, int v) + + + + + + SetMaxPage(self, int v) + + + + + + SetNoCopies(self, int v) + + + + + + SetAllPages(self, bool flag) + + + + + + SetSelection(self, bool flag) + + + + + + SetCollate(self, bool flag) + + + + + + SetPrintToFile(self, bool flag) + + + + + + SetSetupDialog(self, bool flag) + + + + + + EnablePrintToFile(self, bool flag) + + + + + + EnableSelection(self, bool flag) + + + + + + EnablePageNumbers(self, bool flag) + + + + + + EnableHelp(self, bool flag) + + + + + + GetEnablePrintToFile(self) -> bool + + + GetEnableSelection(self) -> bool + + + GetEnablePageNumbers(self) -> bool + + + GetEnableHelp(self) -> bool + + + Ok(self) -> bool + + + GetPrintData(self) -> PrintData + + + SetPrintData(self, PrintData printData) + + + + + + + + + __init__(self, Window parent, PrintDialogData data=None) -> PrintDialog + + + + + + + GetPrintDialogData(self) -> PrintDialogData + + + GetPrintDC(self) -> DC + + + ShowModal(self) -> int + + + + + + __init__(self, PrintDialogData data=None) -> Printer + + + + + + __del__(self) + + + CreateAbortWindow(self, Window parent, Printout printout) + + + + + + + GetPrintDialogData(self) -> PrintDialogData + + + Print(self, Window parent, Printout printout, int prompt=True) -> bool + + + + + + + + PrintDialog(self, Window parent) -> DC + + + + + + ReportError(self, Window parent, Printout printout, String message) + + + + + + + + Setup(self, Window parent) -> bool + + + + + + GetAbort(self) -> bool + + + GetLastError() -> int + + + + + + __init__(self, String title=PrintoutTitleStr) -> Printout + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + GetTitle(self) -> String + + + GetDC(self) -> DC + + + SetDC(self, DC dc) + + + + + + SetPageSizePixels(self, int w, int h) + + + + + + + GetPageSizePixels() -> (w, h) + + + + + + + SetPageSizeMM(self, int w, int h) + + + + + + + GetPageSizeMM() -> (w, h) + + + + + + + SetPPIScreen(self, int x, int y) + + + + + + + GetPPIScreen() -> (x,y) + + + + + + + SetPPIPrinter(self, int x, int y) + + + + + + + GetPPIPrinter() -> (x,y) + + + + + + + IsPreview(self) -> bool + + + SetIsPreview(self, bool p) + + + + + + base_OnBeginDocument(self, int startPage, int endPage) -> bool + + + + + + + base_OnEndDocument(self) + + + base_OnBeginPrinting(self) + + + base_OnEndPrinting(self) + + + base_OnPreparePrinting(self) + + + base_HasPage(self, int page) -> bool + + + + + + base_GetPageInfo() -> (minPage, maxPage, pageFrom, pageTo) + + + + + + + + + + + + __init__(self, PrintPreview preview, Window parent, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, + String name=PreviewCanvasNameStr) -> PreviewCanvas + + + + + + + + + + + + + + __init__(self, PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition, + Size size=DefaultSize, + long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PreviewFrame + + + + + + + + + + + + Initialize(self) + + + CreateControlBar(self) + + + CreateCanvas(self) + + + GetControlBar(self) -> PreviewControlBar + + + + + + __init__(self, PrintPreview preview, long buttons, Window parent, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=TAB_TRAVERSAL, String name=PanelNameStr) -> PreviewControlBar + + + + + + + + + + + + GetZoomControl(self) -> int + + + SetZoomControl(self, int zoom) + + + + + + GetPrintPreview(self) -> PrintPreview + + + OnNext(self) + + + OnPrevious(self) + + + OnFirst(self) + + + OnLast(self) + + + OnGoto(self) + + + + + + + + + + + + + __init__(self, Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PrintPreview +__init__(self, Printout printout, Printout printoutForPrinting, PrintData data) -> PrintPreview + + + + + + + + SetCurrentPage(self, int pageNum) -> bool + + + + + + GetCurrentPage(self) -> int + + + SetPrintout(self, Printout printout) + + + + + + GetPrintout(self) -> Printout + + + GetPrintoutForPrinting(self) -> Printout + + + SetFrame(self, Frame frame) + + + + + + SetCanvas(self, PreviewCanvas canvas) + + + + + + GetFrame(self) -> Frame + + + GetCanvas(self) -> PreviewCanvas + + + PaintPage(self, PreviewCanvas canvas, DC dc) -> bool + + + + + + + DrawBlankPage(self, PreviewCanvas canvas, DC dc) -> bool + + + + + + + RenderPage(self, int pageNum) -> bool + + + + + + AdjustScrollbars(self, PreviewCanvas canvas) + + + + + + GetPrintDialogData(self) -> PrintDialogData + + + SetZoom(self, int percent) + + + + + + GetZoom(self) -> int + + + GetMaxPage(self) -> int + + + GetMinPage(self) -> int + + + Ok(self) -> bool + + + SetOk(self, bool ok) + + + + + + Print(self, bool interactive) -> bool + + + + + + DetermineScaling(self) + + + + + + + + + + + + + __init__(self, Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PyPrintPreview +__init__(self, Printout printout, Printout printoutForPrinting, PrintData data) -> PyPrintPreview + + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + base_SetCurrentPage(self, int pageNum) -> bool + + + + + + base_PaintPage(self, PreviewCanvas canvas, DC dc) -> bool + + + + + + + base_DrawBlankPage(self, PreviewCanvas canvas, DC dc) -> bool + + + + + + + base_RenderPage(self, int pageNum) -> bool + + + + + + base_SetZoom(self, int percent) + + + + + + base_Print(self, bool interactive) -> bool + + + + + + base_DetermineScaling(self) + + + + + + __init__(self, PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition, + Size size=DefaultSize, + long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PyPreviewFrame + + + + + + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + SetPreviewCanvas(self, PreviewCanvas canvas) + + + + + + SetControlBar(self, PreviewControlBar bar) + + + + + + base_Initialize(self) + + + base_CreateCanvas(self) + + + base_CreateControlBar(self) + + + + + + __init__(self, PrintPreview preview, long buttons, Window parent, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=PanelNameStr) -> PyPreviewControlBar + + + + + + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + SetPrintPreview(self, PrintPreview preview) + + + + + + base_CreateButtons(self) + + + base_SetZoomControl(self, int zoom) + + + + + + + + + wx = _core + #--------------------------------------------------------------------------- - - - - __init__(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_DIALOG_STYLE, - String name=DialogNameStr) -> Dialog - - - - - - - - - - - - PreDialog() -> Dialog - - - Create(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_DIALOG_STYLE, - String name=DialogNameStr) -> bool - - - - - - - - - - - - SetReturnCode(int returnCode) - - - - - - GetReturnCode() -> int - - - CreateTextSizer(String message) -> Sizer - - - - - - CreateButtonSizer(long flags) -> Sizer - - - - - - SetModal(bool flag) - - - - - - IsModal() -> bool - - - ShowModal() -> int - - - EndModal(int retCode) - - - - - - IsModalShowing() -> bool - - - + + 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. + +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__(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' + ================== ==================== + + + + + + + + + + + + + + PreButton() -> Button + Precreate a Button for 2-phase creation. + + + 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. + + + + + + + + + + + + + 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 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. + +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. + =========== ================================== + +:see: `wx.Button`, `wx.Bitmap` + + + + __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. + + + + + + + + + + + + + PreBitmapButton() -> BitmapButton + Precreate a BitmapButton for 2-phase creation. + + + 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. + + + + + + + + + + + + + GetBitmapLabel(self) -> Bitmap + Returns the label bitmap (the one passed to the constructor). + + + GetBitmapDisabled(self) -> Bitmap + Returns the bitmap for the disabled state. + + + GetBitmapFocus(self) -> Bitmap + Returns the bitmap for the focused state. + + + GetBitmapSelected(self) -> Bitmap + Returns the bitmap for the selected state. + + + SetBitmapDisabled(self, Bitmap bitmap) + Sets the bitmap for the disabled button appearance. + + + + + + SetBitmapFocus(self, Bitmap bitmap) + Sets the bitmap for the button appearance when it has the keyboard focus. + + + + + + SetBitmapSelected(self, Bitmap bitmap) + Sets the bitmap for the selected (depressed) button appearance. + + + + + + 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. + + + + + + SetMargins(self, int x, int y) + + + + + + + GetMarginX(self) -> int + + + GetMarginY(self) -> int + + + #--------------------------------------------------------------------------- - - - - __init__(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, - String name=FrameNameStr) -> MiniFrame - - - - - - - - - - - - PreMiniFrame() -> MiniFrame - - - Create(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, - String name=FrameNameStr) -> bool - - - - - - - - - - - - + + 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__(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 + + + + + + + + + + + + + PreCheckBox() -> CheckBox + Precreate a CheckBox for 2-phase creation. + + + 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. + + + + + + + + + + + + + GetValue(self) -> bool + Gets the state of a 2-state CheckBox. Returns True if it is checked, +False otherwise. + + + IsChecked(self) -> bool + Similar to GetValue, but raises an exception if it is not a 2-state +CheckBox. + + + SetValue(self, bool state) + Set the state of a 2-state CheckBox. Pass True for checked, False for +unchecked. + + + + + + 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(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(self) -> bool + Returns whether or not the CheckBox is a 3-state CheckBox. + + + 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. + + + + + + #--------------------------------------------------------------------------- - - - - __init__(Bitmap bitmap, Window parent, int id, Point pos=DefaultPosition, - Size size=DefaultSize, long style=NO_BORDER) -> SplashScreenWindow - - - - - - - - - - - SetBitmap(Bitmap bitmap) - - - - - - GetBitmap() -> Bitmap - - - - - - __init__(Bitmap bitmap, long splashStyle, int milliseconds, - Window parent, int id, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxSIMPLE_BORDER|wxFRAME_NO_TASKBAR|wxSTAY_ON_TOP) -> SplashScreen - - - - - - - - - - - - - GetSplashStyle() -> long - - - GetSplashWindow() -> SplashScreenWindow - - - GetTimeout() -> int - - - + + 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, + List choices=[], long style=0, Validator validator=DefaultValidator, + String name=ChoiceNameStr) -> Choice + Create and show a Choice control + + + + + + + + + + + + + PreChoice() -> Choice + Precreate a Choice control for 2-phase creation. + + + Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + List choices=[], long style=0, Validator validator=DefaultValidator, + String name=ChoiceNameStr) -> bool + Actually create the GUI Choice control for 2-phase creation + + + + + + + + + + + + + SetSelection(self, int n) + Select the n'th item (zero based) in the list. + + + + + + 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. + + + + + + + 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, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> StatusBar - - - - - - - - - PreStatusBar() -> StatusBar - - - Create(Window parent, int id, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> bool - - - - - - - - - SetFieldsCount(int number=1) - - - - - - GetFieldsCount() -> int - - - SetStatusText(String text, int number=0) - - - - - - - GetStatusText(int number=0) -> String - - - - - - PushStatusText(String text, int number=0) - - - - - - - PopStatusText(int number=0) - - - - - - SetStatusWidths(int widths, int widths_field) - - - - - - - GetFieldRect(int i) -> Rect - - - - - - SetMinHeight(int height) - - - - - - GetBorderX() -> int - - - GetBorderY() -> int - - - + + 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 + Constructor, creates and shows a ComboBox control. + + + + + + + + + + + + + + PreComboBox() -> ComboBox + Precreate a ComboBox control for 2-phase creation. + + + Create(Window parent, int id, String value=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + List choices=[], long style=0, Validator validator=DefaultValidator, + String name=ChoiceNameStr) -> bool + Actually create the GUI wxComboBox control for 2-phase creation + + + + + + + + + + + + + + GetValue(self) -> String + Returns the current value in the combobox text field. + + + SetValue(self, String value) + + + + + + Copy(self) + Copies the selected text to the clipboard. + + + Cut(self) + Copies the selected text to the clipboard and removes the selection. + + + Paste(self) + Pastes text from the clipboard to the text field. + + + SetInsertionPoint(self, long pos) + Sets the insertion point in the combobox text field. + + + + + + GetInsertionPoint(self) -> long + Returns the insertion point for the combobox's text field. + + + GetLastPosition(self) -> long + Returns the last position in the combobox text field. + + + Replace(self, long from, long to, String value) + Replaces the text between two positions with the given text, in the +combobox text field. + + + + + + + + SetSelection(self, int n) + Sets the item at index 'n' to be the selected item. + + + + + + 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(self, bool editable) + + + + + + SetInsertionPointEnd(self) + Sets the insertion point at the end of the combobox text field. + + + 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, Point point=DefaultPosition, - Size size=DefaultSize, long style=SP_3D, String name=SplitterNameStr) -> SplitterWindow - - - - - - - - - - - PreSplitterWindow() -> SplitterWindow - - - Create(Window parent, int id, Point point=DefaultPosition, - Size size=DefaultSize, long style=SP_3D, String name=SplitterNameStr) -> bool - - - - - - - - - - - GetWindow1() -> Window - - - GetWindow2() -> Window - - - SetSplitMode(int mode) - - - - - - GetSplitMode() -> int - - - Initialize(Window window) - - - - - - SplitVertically(Window window1, Window window2, int sashPosition=0) -> bool - - - - - - - - SplitHorizontally(Window window1, Window window2, int sashPosition=0) -> bool - - - - - - - - Unsplit(Window toRemove=None) -> bool - - - - - - ReplaceWindow(Window winOld, Window winNew) -> bool - - - - - - - IsSplit() -> bool - - - SetSashSize(int width) - - - - - - SetBorderSize(int width) - - - - - - GetSashSize() -> int - - - GetBorderSize() -> int - - - SetSashPosition(int position, bool redraw=True) - - - - - - - GetSashPosition() -> int - - - SetMinimumPaneSize(int min) - - - - - - GetMinimumPaneSize() -> int - - - SashHitTest(int x, int y, int tolerance=5) -> bool - - - - - - - - SizeWindows() - - - SetNeedUpdating(bool needUpdating) - - - - - - GetNeedUpdating() -> bool - - - - - - __init__(wxEventType type=wxEVT_NULL, SplitterWindow splitter=(wxSplitterWindow *) NULL) -> SplitterEvent - - - - - - - SetSashPosition(int pos) - - - - - - GetSashPosition() -> int - - - GetWindowBeingRemoved() -> Window - - - GetX() -> int - - - GetY() -> int - - - -EVT_SPLITTER_SASH_POS_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, 1 ) -EVT_SPLITTER_SASH_POS_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, 1 ) -EVT_SPLITTER_DOUBLECLICKED = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, 1 ) -EVT_SPLITTER_UNSPLIT = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_UNSPLIT, 1 ) + + + + __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 + + + + + + + + + + + + + PreGauge() -> Gauge + + + 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 + + + + + + + + + + + + + SetRange(self, int range) + + + + + + GetRange(self) -> int + + + SetValue(self, int pos) + + + + + + GetValue(self) -> int + + + IsVertical(self) -> bool + + + SetShadowWidth(self, int w) + + + + + + GetShadowWidth(self) -> int + + + SetBezelFace(self, int w) + + + + + + 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__(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticBoxNameStr) -> StaticBox + + + + + + + + + + + + PreStaticBox() -> StaticBox + + + 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=wxCLIP_CHILDREN|wxSW_3D, - String name=SashNameStr) -> SashWindow - - - - - - - - - - - PreSashWindow() -> SashWindow - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCLIP_CHILDREN|wxSW_3D, - String name=SashNameStr) -> bool - - - - - - - - - - - SetSashVisible(int edge, bool sash) - - - - - - - GetSashVisible(int edge) -> bool - - - - - - SetSashBorder(int edge, bool border) - - - - - - - HasBorder(int edge) -> bool - - - - - - GetEdgeMargin(int edge) -> int - - - - - - SetDefaultBorderSize(int width) - - - - - - GetDefaultBorderSize() -> int - - - SetExtraBorderSize(int width) - - - - - - GetExtraBorderSize() -> int - - - SetMinimumSizeX(int min) - - - - - - SetMinimumSizeY(int min) - - - - - - GetMinimumSizeX() -> int - - - GetMinimumSizeY() -> int - - - SetMaximumSizeX(int max) - - - - - - SetMaximumSizeY(int max) - - - - - - GetMaximumSizeX() -> int - - - GetMaximumSizeY() -> int - - - SashHitTest(int x, int y, int tolerance=2) -> int - - - - - - - - SizeWindows() - - - - - - __init__(int id=0, int edge=SASH_NONE) -> SashEvent - - - - - - - SetEdge(int edge) - - - - - - GetEdge() -> int - - - SetDragRect(Rect rect) - - - - - - GetDragRect() -> Rect - - - SetDragStatus(int status) - - - - - - GetDragStatus() -> int - - - - EVT_SASH_DRAGGED = wx.PyEventBinder( wxEVT_SASH_DRAGGED, 1 ) - EVT_SASH_DRAGGED_RANGE = wx.PyEventBinder( wxEVT_SASH_DRAGGED, 2 ) + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=LI_HORIZONTAL, + String name=StaticTextNameStr) -> StaticLine + + + + + + + + + + + PreStaticLine() -> StaticLine + + + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=LI_HORIZONTAL, + String name=StaticTextNameStr) -> 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__(self, Window parent, int id=-1, String label=EmptyString, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticTextNameStr) -> StaticText + + + + + + + + + + + + PreStaticText() -> StaticText + + + 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__(int id=0) -> QueryLayoutInfoEvent - - - - - - SetRequestedLength(int length) - - - - - - GetRequestedLength() -> int - - - SetFlags(int flags) - - - - - - GetFlags() -> int - - - SetSize(Size size) - - - - - - GetSize() -> Size - - - SetOrientation(int orient) - - - - - - GetOrientation() -> int - - - SetAlignment(int align) - - - - - - GetAlignment() -> int - - - - - - __init__(int id=0) -> CalculateLayoutEvent - - - - - - SetFlags(int flags) - - - - - - GetFlags() -> int - - - SetRect(Rect rect) - - - - - - GetRect() -> Rect - - - - EVT_QUERY_LAYOUT_INFO = wx.PyEventBinder( wxEVT_QUERY_LAYOUT_INFO ) - EVT_CALCULATE_LAYOUT = wx.PyEventBinder( wxEVT_CALCULATE_LAYOUT ) + + + + __init__(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticBitmapNameStr) -> StaticBitmap + + + + + + + + + + + + PreStaticBitmap() -> StaticBitmap + + + Create(self, Window parent, int id=-1, Bitmap bitmap=wxNullBitmap, + Point pos=DefaultPosition, Size size=DefaultSize, + long style=0, String name=StaticBitmapNameStr) -> bool + + + + + + + + + + + + GetBitmap(self) -> Bitmap + + + SetBitmap(self, Bitmap bitmap) + + + + + + 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, - long style=wxCLIP_CHILDREN|wxSW_3D, - String name=SashLayoutNameStr) -> SashLayoutWindow - - - - - - - - - - - PreSashLayoutWindow() -> SashLayoutWindow - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCLIP_CHILDREN|wxSW_3D, - String name=SashLayoutNameStr) -> bool - - - - - - - - - - - GetAlignment() -> int - - - GetOrientation() -> int - - - SetAlignment(int alignment) - - - - - - SetDefaultSize(Size size) - - - - - - SetOrientation(int orientation) - - - - - - - - - __init__() -> LayoutAlgorithm - - - __del__() - - - LayoutMDIFrame(MDIParentFrame frame, Rect rect=None) -> bool - - - - - - - LayoutFrame(Frame frame, Window mainWindow=None) -> bool - - - - - - - LayoutWindow(Window parent, Window mainWindow=None) -> bool - - - - - - - + + + + __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 + + + + + + + + + + + + + PreListBox() -> ListBox + + + 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 + + + + + + + + + + + + + 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. + + + + + + + + InsertItems(self, wxArrayString items, int pos) + + + + + + + Set(self, wxArrayString items) + + + + + + IsSelected(self, int n) -> bool + + + + + + SetSelection(self, int n, bool select=True) + + + + + + + Select(self, int n) + Sets the item at index 'n' to be the selected item. + + + + + + Deselect(self, int n) + + + + + + DeselectAll(self, int itemToLeaveSelected=-1) + + + + + + SetStringSelection(self, String s, bool select=True) -> bool + + + + + + + GetSelections(self) -> PyObject + + + SetFirstItem(self, int n) + + + + + + SetFirstItemStr(self, String s) + + + + + + EnsureVisible(self, int n) + + + + + + AppendAndEnsureVisible(self, String s) + + + + + + IsSorted(self) -> bool + + + SetItemForegroundColour(self, int item, Colour c) + + + + + + + SetItemBackgroundColour(self, int item, Colour c) + + + + + + + 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 flags=BORDER_NONE) -> PopupWindow - - - - - - - PrePopupWindow() -> PopupWindow - - - Create(Window parent, int flags=BORDER_NONE) -> bool - - - - - - - Position(Point ptOrigin, Size size) - - - - - - - + + + + __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 + + + + + + + + + + + + + PreCheckListBox() -> CheckListBox + + + 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 + + + + + + + + + + + + + IsChecked(self, int index) -> bool + + + + + + Check(self, int index, int check=True) + + + + + + + GetItemHeight(self) -> int + + + HitTest(self, Point pt) -> int + Test where the given (in client coords) point lies + + + + + + HitTestXY(self, int x, int y) -> int + Test where the given (in client coords) point lies + + + + + + + #--------------------------------------------------------------------------- - - - - __init__(Window parent, int style=BORDER_NONE) -> PopupTransientWindow - - - - - - - PrePopupTransientWindow() -> PopupTransientWindow - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - Popup(Window focus=None) - - - - - - Dismiss() - - - + + + __init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour, + Font font=wxNullFont, int alignment=TEXT_ALIGNMENT_DEFAULT) -> TextAttr + + + + + + + + + __del__(self) + + + Init(self) + + + SetTextColour(self, Colour colText) + + + + + + SetBackgroundColour(self, Colour colBack) + + + + + + SetFont(self, Font font, long flags=TEXT_ATTR_FONT) + + + + + + + SetAlignment(self, int alignment) + + + + + + SetTabs(self, wxArrayInt tabs) + + + + + + SetLeftIndent(self, int indent, int subIndent=0) + + + + + + + SetRightIndent(self, int indent) + + + + + + SetFlags(self, long flags) + + + + + + HasTextColour(self) -> bool + + + HasBackgroundColour(self) -> bool + + + HasFont(self) -> bool + + + HasAlignment(self) -> bool + + + HasTabs(self) -> bool + + + HasLeftIndent(self) -> bool + + + HasRightIndent(self) -> bool + + + HasFlag(self, long flag) -> bool + + + + + + GetTextColour(self) -> Colour + + + GetBackgroundColour(self) -> Colour + + + GetFont(self) -> Font + + + GetAlignment(self) -> int + + + GetTabs(self) -> wxArrayInt + + + GetLeftIndent(self) -> long + + + GetLeftSubIndent(self) -> long + + + GetRightIndent(self) -> long + + + GetFlags(self) -> long + + + IsDefault(self) -> bool + + + Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr + + + + + + + + + + + __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 + + + + + + + + + + + + + PreTextCtrl() -> TextCtrl + + + 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 + + + + + + + + + + + + + GetValue(self) -> String + + + SetValue(self, String value) + + + + + + GetRange(self, long from, long to) -> String + + + + + + + GetLineLength(self, long lineNo) -> int + + + + + + GetLineText(self, long lineNo) -> String + + + + + + GetNumberOfLines(self) -> int + + + IsModified(self) -> bool + + + IsEditable(self) -> bool + + + IsSingleLine(self) -> bool + + + IsMultiLine(self) -> bool + + + GetSelection() -> (from, to) + If the return values from and to are the same, there is no selection. + + + + + + + GetStringSelection(self) -> String + + + Clear(self) + + + Replace(self, long from, long to, String value) + + + + + + + + Remove(self, long from, long to) + + + + + + + LoadFile(self, String file) -> bool + + + + + + SaveFile(self, String file=EmptyString) -> bool + + + + + + MarkDirty(self) + + + DiscardEdits(self) + + + SetMaxLength(self, unsigned long len) + + + + + + WriteText(self, String text) + + + + + + AppendText(self, String text) + + + + + + EmulateKeyPress(self, KeyEvent event) -> bool + + + + + + SetStyle(self, long start, long end, TextAttr style) -> bool + + + + + + + + GetStyle(self, long position, TextAttr style) -> bool + + + + + + + SetDefaultStyle(self, TextAttr style) -> bool + + + + + + GetDefaultStyle(self) -> TextAttr + + + XYToPosition(self, long x, long y) -> long + + + + + + + PositionToXY(long pos) -> (x, y) + + + + + + + + ShowPosition(self, long pos) + + + + + + HitTest(Point pt) -> (result, row, col) + 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(self) + + + Cut(self) + + + Paste(self) + + + CanCopy(self) -> bool + + + CanCut(self) -> bool + + + CanPaste(self) -> bool + + + Undo(self) + + + Redo(self) + + + CanUndo(self) -> bool + + + CanRedo(self) -> bool + + + SetInsertionPoint(self, long pos) + + + + + + SetInsertionPointEnd(self) + + + GetInsertionPoint(self) -> long + + + GetLastPosition(self) -> long + + + SetSelection(self, long from, long to) + + + + + + + SelectAll(self) + + + SetEditable(self, bool editable) + + + + + + write(self, String text) + + + + + + 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__(self, int winid, MouseEvent evtMouse, long start, long end) -> TextUrlEvent + + + + + + + + + GetMouseEvent(self) -> MouseEvent + + + GetURLStart(self) -> long + + + GetURLEnd(self) -> long + + + +EVT_TEXT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_UPDATED, 1) +EVT_TEXT_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TEXT_ENTER, 1) +EVT_TEXT_URL = wx.PyEventBinder( wxEVT_COMMAND_TEXT_URL, 1) +EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1) + + #--------------------------------------------------------------------------- - - - - __init__(Window parent, String text, int maxLength=100, Rect rectBound=None) -> TipWindow - - - - - - - - - SetBoundingRect(Rect rectBound) - - - - - - Close() - - - + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=SB_HORIZONTAL, + Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> ScrollBar + + + + + + + + + + + + PreScrollBar() -> ScrollBar + + + 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. + + + + + + + + + + + + GetThumbPosition(self) -> int + + + GetThumbSize(self) -> int + + + GetPageSize(self) -> int + + + GetRange(self) -> int + + + IsVertical(self) -> bool + + + SetThumbPosition(self, int viewStart) + + + + + + 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. + + :param position: The position of the scrollbar in scroll units. + + :param thumbSize: The size of the thumb, or visible portion of the + scrollbar, in scroll units. + + :param range: The maximum position of the scrollbar. + + :param refresh: True to redraw the scrollbar, false otherwise. + + + + + + + + + + + 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=ID_ANY, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, String name=PanelNameStr) -> VScrolledWindow - - - - - - - - - - - PreVScrolledWindow() -> VScrolledWindow - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - Create(Window parent, int id=ID_ANY, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool - - - - - - - - - - - SetLineCount(size_t count) - - - - - - ScrollToLine(size_t line) -> bool - - - - - - ScrollLines(int lines) -> bool - - - - - - ScrollPages(int pages) -> bool - - - - - - RefreshLine(size_t line) - - - - - - RefreshLines(size_t from, size_t to) - - - - - - - HitTestXT(int x, int y) -> int - - - - - - - HitTest(Point pt) -> int - - - - - - RefreshAll() - - - GetLineCount() -> size_t - - - GetFirstVisibleLine() -> size_t - - - GetLastVisibleLine() -> size_t - - - IsVisible(size_t line) -> bool - - - - - - - - - __init__(Window parent, int id=ID_ANY, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> VListBox - - - - - - - - - - - PreVListBox() -> VListBox - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - Create(Window parent, int id=ID_ANY, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool - - - - - - - - - - - GetItemCount() -> size_t - - - HasMultipleSelection() -> bool - - - GetSelection() -> int - - - IsCurrent(size_t item) -> bool - - - - - - IsSelected(size_t item) -> bool - - - - - - GetSelectedCount() -> size_t - - - GetFirstSelected(unsigned long cookie) -> int - - - - - - GetNextSelected(unsigned long cookie) -> int - - - - - - GetMargins() -> Point - - - GetSelectionBackground() -> Colour - - - SetItemCount(size_t count) - - - - - - Clear() - - - SetSelection(int selection) - - - - - - Select(size_t item, bool select=True) -> bool - - - - - - - SelectRange(size_t from, size_t to) -> bool - - - - - - - Toggle(size_t item) - - - - - - SelectAll() -> bool - - - DeselectAll() -> bool - - - SetMargins(Point pt) - - - - - - SetMarginsXY(int x, int y) - - - - - - - SetSelectionBackground(Colour col) - - - - - - - - - __init__(Window parent, int id=ID_ANY, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> HtmlListBox - - - - - - - - - - - PreHtmlListBox() -> HtmlListBox - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - Create(Window parent, int id=ID_ANY, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool - - - - - - - - - - - RefreshAll() - - - SetItemCount(size_t count) - - - - - - + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=SP_HORIZONTAL, + String name=SPIN_BUTTON_NAME) -> SpinButton + + + + + + + + + + + PreSpinButton() -> SpinButton + + + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=SP_HORIZONTAL, + String name=SPIN_BUTTON_NAME) -> bool + + + + + + + + + + + GetValue(self) -> int + + + GetMin(self) -> int + + + GetMax(self) -> int + + + SetValue(self, int val) + + + + + + SetMin(self, int minVal) + + + + + + SetMax(self, int maxVal) + + + + + + SetRange(self, int minVal, int maxVal) + + + + + + + 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__(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 + + + + + + + + + + + + + + + PreSpinCtrl() -> SpinCtrl + + + 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 + + + + + + + + + + + + + + + GetValue(self) -> int + + + SetValue(self, int value) + + + + + + SetValueString(self, String text) + + + + + + SetRange(self, int minVal, int maxVal) + + + + + + + GetMin(self) -> int + + + GetMax(self) -> int + + + 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__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> SpinEvent + + + + + + + GetPosition(self) -> int + + + SetPosition(self, int pos) + + + + + + +EVT_SPIN_UP = wx.PyEventBinder( wx.wxEVT_SCROLL_LINEUP, 1) +EVT_SPIN_DOWN = wx.PyEventBinder( wx.wxEVT_SCROLL_LINEDOWN, 1) +EVT_SPIN = wx.PyEventBinder( wx.wxEVT_SCROLL_THUMBTRACK, 1) +EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) + + #--------------------------------------------------------------------------- - - - - __init__() -> TaskBarIcon - - - __del__() - - - IsOk() -> bool - - - IsIconInstalled() -> bool - - - SetIcon(Icon icon, String tooltip=EmptyString) -> bool - - - - - - - RemoveIcon() -> bool - - - PopupMenu(Menu menu) -> bool - - - - - - - - - __init__(wxEventType evtType, TaskBarIcon tbIcon) -> TaskBarIconEvent - - - - - - - -EVT_TASKBAR_MOVE = wx.PyEventBinder ( wxEVT_TASKBAR_MOVE ) -EVT_TASKBAR_LEFT_DOWN = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_DOWN ) -EVT_TASKBAR_LEFT_UP = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_UP ) -EVT_TASKBAR_RIGHT_DOWN = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_DOWN ) -EVT_TASKBAR_RIGHT_UP = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_UP ) -EVT_TASKBAR_LEFT_DCLICK = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_DCLICK ) -EVT_TASKBAR_RIGHT_DCLICK = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_DCLICK ) - - + + + + __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 + + + + + + + + + + + + + + + PreRadioBox() -> RadioBox + + + 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 + + + + + + + + + + + + + + + SetSelection(self, int n) + + + + + + GetSelection(self) -> int + + + GetStringSelection(self) -> String + + + SetStringSelection(self, String s) -> bool + + + + + + GetCount(self) -> int + + + FindString(self, String s) -> int + + + + + + GetString(self, int n) -> String + + + + + + SetString(self, int n, String label) + + + + + + + EnableItem(self, int n, bool enable=True) + + + + + + + ShowItem(self, int n, bool show=True) + + + + + + + GetColumnCount(self) -> int + + + GetRowCount(self) -> 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__() -> ColourData - - - __del__() - - - GetChooseFull() -> bool - - - GetColour() -> Colour - - - GetCustomColour(int i) -> Colour - - - - - - SetChooseFull(int flag) - - - - - - SetColour(Colour colour) - - - - - - SetCustomColour(int i, Colour colour) - - - - - - - - - - __init__(Window parent, ColourData data=None) -> ColourDialog - - - - - - - GetColourData() -> ColourData - - - ShowModal() -> int - - - - - - __init__(Window parent, String message=DirSelectorPromptStr, - String defaultPath=EmptyString, long style=0, + + + + __init__(self, Window parent, int id=-1, String label=EmptyString, Point pos=DefaultPosition, Size size=DefaultSize, - String name=DirDialogNameStr) -> DirDialog - - - - - - - - - - - - GetPath() -> String - - - GetMessage() -> String - - - GetStyle() -> long - - - SetMessage(String message) - - - - - - SetPath(String path) - - - - - - ShowModal() -> int - - - - - - __init__(Window parent, String message=FileSelectorPromptStr, - String defaultDir=EmptyString, String defaultFile=EmptyString, - String wildcard=FileSelectorDefaultWildcardStr, - long style=0, Point pos=DefaultPosition) -> FileDialog - - - - - - - - - - - - SetMessage(String message) - - - - - - SetPath(String path) - - - - - - SetDirectory(String dir) - - - - - - SetFilename(String name) - - - - - - SetWildcard(String wildCard) - - - - - - SetStyle(long style) - - - - - - SetFilterIndex(int filterIndex) - - - - - - GetMessage() -> String - - - GetPath() -> String - - - GetDirectory() -> String - - - GetFilename() -> String - - - GetWildcard() -> String - - - GetStyle() -> long - - - GetFilterIndex() -> int - - - GetFilenames() -> PyObject - - - GetPaths() -> PyObject - - - - - - __init__(Window parent, String message, String caption, int LCOUNT, - String choices, long style=CHOICEDLG_STYLE, - Point pos=DefaultPosition) -> MultiChoiceDialog - - - - - - - - - - - - SetSelections(wxArrayInt selections) - - - - - - GetSelections() -> PyObject - - - - - - __init__(Window parent, String message, String caption, int choices, - String choices_array, long style=CHOICEDLG_STYLE, - Point pos=DefaultPosition) -> SingleChoiceDialog - - - - - - - - - - - - GetSelection() -> int - - - GetStringSelection() -> String - - - SetSelection(int sel) - - - - - - ShowModal() -> int - - - - - - __init__(Window parent, String message, String caption=GetTextFromUserPromptStr, - String defaultValue=EmptyString, - long style=wxOK|wxCANCEL|wxCENTRE, Point pos=DefaultPosition) -> TextEntryDialog - - - - - - - - - - - GetValue() -> String - - - SetValue(String value) - - - - - - ShowModal() -> int - - - - - - __init__() -> FontData - - - __del__() - - - EnableEffects(bool enable) - - - - - - GetAllowSymbols() -> bool - - - GetColour() -> Colour - - - GetChosenFont() -> Font - - - GetEnableEffects() -> bool - - - GetInitialFont() -> Font - - - GetShowHelp() -> bool - - - SetAllowSymbols(bool allowSymbols) - - - - - - SetChosenFont(Font font) - - - - - - SetColour(Colour colour) - - - - - - SetInitialFont(Font font) - - - - - - SetRange(int min, int max) - - - - - - - SetShowHelp(bool showHelp) - - - - - - - - - __init__(Window parent, FontData data) -> FontDialog - - - - - - - GetFontData() -> FontData - - - ShowModal() -> int - - - - - - __init__(Window parent, String message, String caption=MessageBoxCaptionStr, - long style=wxOK|wxCANCEL|wxCENTRE, - Point pos=DefaultPosition) -> MessageDialog - - - - - - - - - - ShowModal() -> int - - - - - - __init__(String title, String message, int maximum=100, Window parent=None, - int style=wxPD_AUTO_HIDE|wxPD_APP_MODAL) -> ProgressDialog - - - - - - - - - - Update(int value, String newmsg=EmptyString) -> bool - - - - - - - Resume() - - - -EVT_FIND = wx.PyEventBinder( wxEVT_COMMAND_FIND, 1 ) -EVT_FIND_NEXT = wx.PyEventBinder( wxEVT_COMMAND_FIND_NEXT, 1 ) -EVT_FIND_REPLACE = wx.PyEventBinder( wxEVT_COMMAND_FIND_REPLACE, 1 ) -EVT_FIND_REPLACE_ALL = wx.PyEventBinder( wxEVT_COMMAND_FIND_REPLACE_ALL, 1 ) -EVT_FIND_CLOSE = wx.PyEventBinder( wxEVT_COMMAND_FIND_CLOSE, 1 ) + long style=0, Validator validator=DefaultValidator, + String name=RadioButtonNameStr) -> RadioButton + + + + + + + + + + + + + PreRadioButton() -> RadioButton + + + 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 + + + + + + + + + + + + + GetValue(self) -> bool + + + 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. -# For backwards compatibility. Should they be removed? -EVT_COMMAND_FIND = EVT_FIND -EVT_COMMAND_FIND_NEXT = EVT_FIND_NEXT -EVT_COMMAND_FIND_REPLACE = EVT_FIND_REPLACE -EVT_COMMAND_FIND_REPLACE_ALL = EVT_FIND_REPLACE_ALL -EVT_COMMAND_FIND_CLOSE = EVT_FIND_CLOSE - - - - - __init__(wxEventType commandType=wxEVT_NULL, int id=0) -> FindDialogEvent - - - - - - - GetFlags() -> int - - - GetFindString() -> String - - - GetReplaceString() -> String - - - GetDialog() -> FindReplaceDialog - - - SetFlags(int flags) - - - - - - SetFindString(String str) - - - - - - SetReplaceString(String str) - - - - - - - - - __init__(int flags=0) -> FindReplaceData - - - - - - __del__() - - - GetFindString() -> String - - - GetReplaceString() -> String - - - GetFlags() -> int - - - SetFlags(int flags) - - - - - - SetFindString(String str) - - - - - - SetReplaceString(String str) - - - - - - - - - __init__(Window parent, FindReplaceData data, String title, - int style=0) -> FindReplaceDialog - - - - - - - - - PreFindReplaceDialog() -> FindReplaceDialog - - - Create(Window parent, FindReplaceData data, String title, - int style=0) -> bool - - - - - - - - - GetData() -> FindReplaceData - - - SetData(FindReplaceData data) - - - - - - +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=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL, - String name=FrameNameStr) -> MDIParentFrame - - - - - - - - - - - - PreMDIParentFrame() -> MDIParentFrame - - - Create(Window parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL, - String name=FrameNameStr) -> bool - - - - - - - - - - - - ActivateNext() - - - ActivatePrevious() - - - ArrangeIcons() - - - Cascade() - - - GetActiveChild() -> MDIChildFrame - - - GetClientWindow() -> MDIClientWindow - - - GetToolBar() -> Window - - - Tile() - - - - - - __init__(MDIParentFrame parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, - String name=FrameNameStr) -> MDIChildFrame - - - - - - - - - - - - PreMDIChildFrame() -> MDIChildFrame - - - Create(MDIParentFrame parent, int id, String title, Point pos=DefaultPosition, - Size size=DefaultSize, long style=DEFAULT_FRAME_STYLE, - String name=FrameNameStr) -> bool - - - - - - - - - - - - Activate() - - - Maximize(bool maximize) - - - - - - Restore() - - - - - - __init__(MDIParentFrame parent, long style=0) -> MDIClientWindow - - - - - - - PreMDIClientWindow() -> MDIClientWindow - - - Create(MDIParentFrame parent, long style=0) -> bool - - - - - - - + + + + __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 + + + + + + + + + + + + + + + PreSlider() -> Slider + + + 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 + + + + + + + + + + + + + + + GetValue(self) -> int + + + SetValue(self, int value) + + + + + + SetRange(self, int minValue, int maxValue) + + + + + + + GetMin(self) -> int + + + GetMax(self) -> int + + + SetMin(self, int minValue) + + + + + + SetMax(self, int maxValue) + + + + + + SetLineSize(self, int lineSize) + + + + + + SetPageSize(self, int pageSize) + + + + + + GetLineSize(self) -> int + + + GetPageSize(self) -> int + + + SetThumbLength(self, int lenPixels) + + + + + + GetThumbLength(self) -> int + + + SetTickFreq(self, int n, int pos=1) + + + + + + + GetTickFreq(self) -> int + + + ClearTicks(self) + + + SetTick(self, int tickPos) + + + + + + ClearSel(self) + + + GetSelEnd(self) -> int + + + GetSelStart(self) -> int + + + 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. + + + + + + #--------------------------------------------------------------------------- - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=PanelNameStr) -> PyWindow - - - - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_DoMoveWindow(int x, int y, int width, int height) - - - - - - - - - base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) - - - - - - - - - - base_DoSetClientSize(int width, int height) - - - - - - - base_DoSetVirtualSize(int x, int y) - - - - - - - base_DoGetSize() -> (width, height) - - - - - - - base_DoGetClientSize() -> (width, height) - - - - - - - base_DoGetPosition() -> (x,y) - - - - - - - base_DoGetVirtualSize() -> Size - - - base_DoGetBestSize() -> Size - - - base_InitDialog() - - - base_TransferDataToWindow() -> bool - - - base_TransferDataFromWindow() -> bool - - - base_Validate() -> bool - - - base_AcceptsFocus() -> bool - - - base_AcceptsFocusFromKeyboard() -> bool - - - base_GetMaxSize() -> Size - - - base_AddChild(Window child) - - - - - - base_RemoveChild(Window child) - - - - - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=PanelNameStr) -> PyPanel - - - - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_DoMoveWindow(int x, int y, int width, int height) - - - - - - - - - base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) - - - - - - - - - - base_DoSetClientSize(int width, int height) - - - - - - - base_DoSetVirtualSize(int x, int y) - - - - - - - base_DoGetSize() -> (width, height) - - - - - - - base_DoGetClientSize() -> (width, height) - - - - - - - base_DoGetPosition() -> (x,y) - - - - - - - base_DoGetVirtualSize() -> Size - - - base_DoGetBestSize() -> Size - - - base_InitDialog() - - - base_TransferDataToWindow() -> bool - - - base_TransferDataFromWindow() -> bool - - - base_Validate() -> bool - - - base_AcceptsFocus() -> bool - - - base_AcceptsFocusFromKeyboard() -> bool - - - base_GetMaxSize() -> Size - - - base_AddChild(Window child) - - - - - - base_RemoveChild(Window child) - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__() -> PrintData - - - __del__() - - - GetNoCopies() -> int - - - GetCollate() -> bool - - - GetOrientation() -> int - - - Ok() -> bool - - - GetPrinterName() -> String - - - GetColour() -> bool - - - GetDuplex() -> int - - - GetPaperId() -> int - - - GetPaperSize() -> Size - - - GetQuality() -> int - - - SetNoCopies(int v) - - - - - - SetCollate(bool flag) - - - - - - SetOrientation(int orient) - - - - - - SetPrinterName(String name) - - - - - - SetColour(bool colour) - - - - - - SetDuplex(int duplex) - - - - - - SetPaperId(int sizeId) - - - - - - SetPaperSize(Size sz) - - - - - - SetQuality(int quality) - - - - - - GetPrinterCommand() -> String - - - GetPrinterOptions() -> String - - - GetPreviewCommand() -> String - - - GetFilename() -> String - - - GetFontMetricPath() -> String - - - GetPrinterScaleX() -> double - - - GetPrinterScaleY() -> double - - - GetPrinterTranslateX() -> long - - - GetPrinterTranslateY() -> long - - - GetPrintMode() -> int - - - SetPrinterCommand(String command) - - - - - - SetPrinterOptions(String options) - - - - - - SetPreviewCommand(String command) - - - - - - SetFilename(String filename) - - - - - - SetFontMetricPath(String path) - - - - - - SetPrinterScaleX(double x) - - - - - - SetPrinterScaleY(double y) - - - - - - SetPrinterScaling(double x, double y) - - - - - - - SetPrinterTranslateX(long x) - - - - - - SetPrinterTranslateY(long y) - - - - - - SetPrinterTranslation(long x, long y) - - - - - - - SetPrintMode(int printMode) - - - - - - - - - __init__() -> PageSetupDialogData - - - __del__() - - - EnableHelp(bool flag) - - - - - - EnableMargins(bool flag) - - - - - - EnableOrientation(bool flag) - - - - - - EnablePaper(bool flag) - - - - - - EnablePrinter(bool flag) - - - - - - GetDefaultMinMargins() -> bool - - - GetEnableMargins() -> bool - - - GetEnableOrientation() -> bool - - - GetEnablePaper() -> bool - - - GetEnablePrinter() -> bool - - - GetEnableHelp() -> bool - - - GetDefaultInfo() -> bool - - - GetMarginTopLeft() -> Point - - - GetMarginBottomRight() -> Point - - - GetMinMarginTopLeft() -> Point - - - GetMinMarginBottomRight() -> Point - - - GetPaperId() -> int - - - GetPaperSize() -> Size - - - GetPrintData() -> PrintData - - - Ok() -> bool - - - SetDefaultInfo(bool flag) - - - - - - SetDefaultMinMargins(bool flag) - - - - - - SetMarginTopLeft(Point pt) - - - - - - SetMarginBottomRight(Point pt) - - - - - - SetMinMarginTopLeft(Point pt) - - - - - - SetMinMarginBottomRight(Point pt) - - - - - - SetPaperId(int id) - - - - - - SetPaperSize(Size size) - - - - - - SetPrintData(PrintData printData) - - - - - - - - - __init__(Window parent, PageSetupDialogData data=None) -> PageSetupDialog - - - - - - - GetPageSetupData() -> PageSetupDialogData - - - ShowModal() -> int - - - - - - __init__() -> PrintDialogData - - - __del__() - - - GetFromPage() -> int - - - GetToPage() -> int - - - GetMinPage() -> int - - - GetMaxPage() -> int - - - GetNoCopies() -> int - - - GetAllPages() -> bool - - - GetSelection() -> bool - - - GetCollate() -> bool - - - GetPrintToFile() -> bool - - - GetSetupDialog() -> bool - - - SetFromPage(int v) - - - - - - SetToPage(int v) - - - - - - SetMinPage(int v) - - - - - - SetMaxPage(int v) - - - - - - SetNoCopies(int v) - - - - - - SetAllPages(bool flag) - - - - - - SetSelection(bool flag) - - - - - - SetCollate(bool flag) - - - - - - SetPrintToFile(bool flag) - - - - - - SetSetupDialog(bool flag) - - - - - - EnablePrintToFile(bool flag) - - - - - - EnableSelection(bool flag) - - - - - - EnablePageNumbers(bool flag) - - - - - - EnableHelp(bool flag) - - - - - - GetEnablePrintToFile() -> bool - - - GetEnableSelection() -> bool - - - GetEnablePageNumbers() -> bool - - - GetEnableHelp() -> bool - - - Ok() -> bool - - - GetPrintData() -> PrintData - - - SetPrintData(PrintData printData) - - - - - - - - - __init__(Window parent, PrintDialogData data=None) -> PrintDialog - - - - - - - GetPrintDialogData() -> PrintDialogData - - - GetPrintDC() -> DC - - - ShowModal() -> int - - - - - - __init__(PrintDialogData data=None) -> Printer - - - - - - __del__() - - - CreateAbortWindow(Window parent, Printout printout) - - - - - - - GetPrintDialogData() -> PrintDialogData - - - Print(Window parent, Printout printout, int prompt=True) -> bool - - - - - - - - PrintDialog(Window parent) -> DC - - - - - - ReportError(Window parent, Printout printout, String message) - - - - - - - - Setup(Window parent) -> bool - - - - - - GetAbort() -> bool - - - Printer.GetLastError() -> int - - - - - - __init__(String title=PrintoutTitleStr) -> Printout - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - GetTitle() -> String - - - GetDC() -> DC - - - SetDC(DC dc) - - - - - - SetPageSizePixels(int w, int h) - - - - - - - GetPageSizePixels() -> (w, h) - - - - - - - SetPageSizeMM(int w, int h) - - - - - - - GetPageSizeMM() -> (w, h) - - - - - - - SetPPIScreen(int x, int y) - - - - - - - GetPPIScreen() -> (x,y) - - - - - - - SetPPIPrinter(int x, int y) - - - - - - - GetPPIPrinter() -> (x,y) - - - - - - - IsPreview() -> bool - - - SetIsPreview(bool p) - - - - - - base_OnBeginDocument(int startPage, int endPage) -> bool - - - - - - - base_OnEndDocument() - - - base_OnBeginPrinting() - - - base_OnEndPrinting() - - - base_OnPreparePrinting() - - - base_HasPage(int page) -> bool - - - - - - base_GetPageInfo() -> (minPage, maxPage, pageFrom, pageTo) - - - - - - - - - - - - __init__(PrintPreview preview, Window parent, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=PreviewCanvasNameStr) -> PreviewCanvas - - - - - - - - - - - - - - __init__(PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition, - Size size=DefaultSize, - long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PreviewFrame - - - - - - - - - - - - Initialize() - - - CreateControlBar() - - - CreateCanvas() - - - GetControlBar() -> PreviewControlBar - - - - - - __init__(PrintPreview preview, long buttons, Window parent, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=TAB_TRAVERSAL, String name=PanelNameStr) -> PreviewControlBar - - - - - - - - - - - - GetZoomControl() -> int - - - SetZoomControl(int zoom) - - - - - - GetPrintPreview() -> PrintPreview - - - OnNext() - - - OnPrevious() - - - OnFirst() - - - OnLast() - - - OnGoto() - - - - - - __init__(Printout printout, Printout printoutForPrinting, PrintData data=None) -> PrintPreview - - - - - - - - SetCurrentPage(int pageNum) -> bool - - - - - - GetCurrentPage() -> int - - - SetPrintout(Printout printout) - - - - - - GetPrintout() -> Printout - - - GetPrintoutForPrinting() -> Printout - - - SetFrame(Frame frame) - - - - - - SetCanvas(PreviewCanvas canvas) - - - - - - GetFrame() -> Frame - - - GetCanvas() -> PreviewCanvas - - - PaintPage(PreviewCanvas canvas, DC dc) -> bool - - - - - - - DrawBlankPage(PreviewCanvas canvas, DC dc) -> bool - - - - - - - RenderPage(int pageNum) -> bool - - - - - - AdjustScrollbars(PreviewCanvas canvas) - - - - - - GetPrintDialogData() -> PrintDialogData - - - SetZoom(int percent) - - - - - - GetZoom() -> int - - - GetMaxPage() -> int - - - GetMinPage() -> int - - - Ok() -> bool - - - SetOk(bool ok) - - - - - - Print(bool interactive) -> bool - - - - - - DetermineScaling() - - - - - - __init__(Printout printout, Printout printoutForPrinting, PrintData data=None) -> PyPrintPreview - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_SetCurrentPage(int pageNum) -> bool - - - - - - base_PaintPage(PreviewCanvas canvas, DC dc) -> bool - - - - - - - base_DrawBlankPage(PreviewCanvas canvas, DC dc) -> bool - - - - - - - base_RenderPage(int pageNum) -> bool - - - - - - base_SetZoom(int percent) - - - - - - base_Print(bool interactive) -> bool - - - - - - base_DetermineScaling() - - - - - - __init__(PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition, - Size size=DefaultSize, - long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PyPreviewFrame - - - - - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - SetPreviewCanvas(PreviewCanvas canvas) - - - - - - SetControlBar(PreviewControlBar bar) - - - - - - base_Initialize() - - - base_CreateCanvas() - - - base_CreateControlBar() - - - - - - __init__(PrintPreview preview, long buttons, Window parent, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=PanelNameStr) -> PyPreviewControlBar - - - - - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - SetPrintPreview(PrintPreview preview) - - - - - - base_CreateButtons() - - - base_SetZoomControl(int zoom) - - - - - - - - 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. - - - - __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. - - - - - - - - - - - - - PreButton() -> Button - 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 - Acutally create the GUI Button for 2-phase creation. - - - - - - - - - - - - - SetDefault() - This sets the button to be the default item for the panel or dialog box. - - - Button.GetDefaultSize() -> Size - - - - A Buttont that contains a bitmap. - - - __init__(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=BU_AUTODRAW, - Validator validator=DefaultValidator, - String name=ButtonNameStr) -> BitmapButton - Create and show a button. - - - - - - - - - - - - - PreBitmapButton() -> BitmapButton - 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, - String name=ButtonNameStr) -> bool - Acutally create the GUI BitmapButton for 2-phase creation. - - - - - - - - - - - - - GetBitmapLabel() -> Bitmap - Returns the label bitmap (the one passed to the constructor). - - - GetBitmapDisabled() -> Bitmap - Returns the bitmap for the disabled state. - - - GetBitmapFocus() -> Bitmap - Returns the bitmap for the focused state. - - - GetBitmapSelected() -> Bitmap - Returns the bitmap for the selected state. - - - SetBitmapDisabled(Bitmap bitmap) - Sets the bitmap for the disabled button appearance. - - - - - - SetBitmapFocus(Bitmap bitmap) - Sets the bitmap for the button appearance when it has the keyboard focus. - - - - - - SetBitmapSelected(Bitmap bitmap) - Sets the bitmap for the selected (depressed) button appearance. - - - - - - SetBitmapLabel(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. - - - - - - SetMargins(int x, int y) - - - - - - - GetMarginX() -> int - - - GetMarginY() -> int - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> CheckBox - - - - - - - - - - - - - PreCheckBox() -> CheckBox - - - Create(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=CheckBoxNameStr) -> bool - - - - - - - - - - - - - GetValue() -> bool - - - IsChecked() -> bool - - - SetValue(bool state) - - - - - - Get3StateValue() -> int - - - Set3StateValue(int state) - - - - - - Is3State() -> bool - - - Is3rdStateAllowedForUser() -> bool - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=ChoiceNameStr) -> Choice - - - - - - - - - - - - - - PreChoice() -> Choice - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=ChoiceNameStr) -> bool - - - - - - - - - - - - - - GetColumns() -> int - - - SetColumns(int n=1) - - - - - - SetSelection(int n) - - - - - - SetStringSelection(String string) - - - - - - SetString(int n, String s) - - - - - - - -#--------------------------------------------------------------------------- - - - - - - __init__(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, - Size size=DefaultSize, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=ComboBoxNameStr) -> ComboBox - - - - - - - - - - - - - - - PreComboBox() -> ComboBox - - - Create(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, - Size size=DefaultSize, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=ComboBoxNameStr) -> bool - - - - - - - - - - - - - - - GetValue() -> String - - - SetValue(String value) - - - - - - Copy() - - - Cut() - - - Paste() - - - SetInsertionPoint(long pos) - - - - - - GetInsertionPoint() -> long - - - GetLastPosition() -> long - - - Replace(long from, long to, String value) - - - - - - - - SetSelection(int n) - - - - - - SetMark(long from, long to) - - - - - - - SetEditable(bool editable) - - - - - - SetInsertionPointEnd() - - - Remove(long from, long to) - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, int range, Point pos=DefaultPosition, - Size size=DefaultSize, long style=GA_HORIZONTAL, - Validator validator=DefaultValidator, - String name=GaugeNameStr) -> Gauge - - - - - - - - - - - - - PreGauge() -> Gauge - - - Create(Window parent, int id, int range, Point pos=DefaultPosition, - Size size=DefaultSize, long style=GA_HORIZONTAL, - Validator validator=DefaultValidator, - String name=GaugeNameStr) -> bool - - - - - - - - - - - - - SetRange(int range) - - - - - - GetRange() -> int - - - SetValue(int pos) - - - - - - GetValue() -> int - - - IsVertical() -> bool - - - SetShadowWidth(int w) - - - - - - GetShadowWidth() -> int - - - SetBezelFace(int w) - - - - - - GetBezelFace() -> int - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBoxNameStr) -> StaticBox - - - - - - - - - - - - PreStaticBox() -> StaticBox - - - Create(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBoxNameStr) -> bool - - - - - - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=LI_HORIZONTAL, - String name=StaticTextNameStr) -> StaticLine - - - - - - - - - - - PreStaticLine() -> StaticLine - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=LI_HORIZONTAL, - String name=StaticTextNameStr) -> bool - - - - - - - - - - - IsVertical() -> bool - - - StaticLine.GetDefaultSize() -> int - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticTextNameStr) -> StaticText - - - - - - - - - - - - PreStaticText() -> StaticText - - - Create(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticTextNameStr) -> bool - - - - - - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBitmapNameStr) -> StaticBitmap - - - - - - - - - - - - PreStaticBitmap() -> StaticBitmap - - - Create(Window parent, int id, Bitmap bitmap, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - String name=StaticBitmapNameStr) -> bool - - - - - - - - - - - - GetBitmap() -> Bitmap - - - SetBitmap(Bitmap bitmap) - - - - - - SetIcon(Icon icon) - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=ListBoxNameStr) -> ListBox - - - - - - - - - - - - - - PreListBox() -> ListBox - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=ListBoxNameStr) -> bool - - - - - - - - - - - - - - Insert(String item, int pos, PyObject clientData=None) - - - - - - - - InsertItems(wxArrayString items, int pos) - - - - - - - Set(wxArrayString items) - - - - - - IsSelected(int n) -> bool - - - - - - SetSelection(int n, bool select=True) - - - - - - - Select(int n) - - - - - - Deselect(int n) - - - - - - DeselectAll(int itemToLeaveSelected=-1) - - - - - - SetStringSelection(String s, bool select=True) -> bool - - - - - - - GetSelections() -> PyObject - - - SetFirstItem(int n) - - - - - - SetFirstItemStr(String s) - - - - - - EnsureVisible(int n) - - - - - - AppendAndEnsureVisible(String s) - - - - - - IsSorted() -> bool - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=ListBoxNameStr) -> CheckListBox - - - - - - - - - - - - - - PreCheckListBox() -> CheckListBox - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - int choices=0, String choices_array=None, - long style=0, Validator validator=DefaultValidator, - String name=ListBoxNameStr) -> bool - - - - - - - - - - - - - - IsChecked(int index) -> bool - - - - - - Check(int index, int check=True) - - - - - - - GetItemHeight() -> int - - - HitTest(Point pt) -> int - - - - - - HitTestXY(int x, int y) -> int - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__() -> TextAttr -__init__(Colour colText, Colour colBack=wxNullColour, Font font=wxNullFont, - int alignment=TEXT_ALIGNMENT_DEFAULT) -> TextAttr - - - - - - - - - Init() - - - SetTextColour(Colour colText) - - - - - - SetBackgroundColour(Colour colBack) - - - - - - SetFont(Font font, long flags=TEXT_ATTR_FONT) - - - - - - - SetAlignment(int alignment) - - - - - - SetTabs(wxArrayInt tabs) - - - - - - SetLeftIndent(int indent) - - - - - - SetRightIndent(int indent) - - - - - - SetFlags(long flags) - - - - - - HasTextColour() -> bool - - - HasBackgroundColour() -> bool - - - HasFont() -> bool - - - HasAlignment() -> bool - - - HasTabs() -> bool - - - HasLeftIndent() -> bool - - - HasRightIndent() -> bool - - - HasFlag(long flag) -> bool - - - - - - GetTextColour() -> Colour - - - GetBackgroundColour() -> Colour - - - GetFont() -> Font - - - GetAlignment() -> int - - - GetTabs() -> wxArrayInt - - - GetLeftIndent() -> long - - - GetRightIndent() -> long - - - GetFlags() -> long - - - IsDefault() -> bool - - - TextAttr.Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr - - - - - - - - - - - __init__(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, - Size size=DefaultSize, - long style=0, Validator validator=DefaultValidator, - String name=TextCtrlNameStr) -> TextCtrl - - - - - - - - - - - - - PreTextCtrl() -> TextCtrl - - - Create(Window parent, int id, String value=EmptyString, Point pos=DefaultPosition, - Size size=DefaultSize, - long style=0, Validator validator=DefaultValidator, - String name=TextCtrlNameStr) -> bool - - - - - - - - - - - - - GetValue() -> String - - - SetValue(String value) - - - - - - GetRange(long from, long to) -> String - - - - - - - GetLineLength(long lineNo) -> int - - - - - - GetLineText(long lineNo) -> String - - - - - - GetNumberOfLines() -> int - - - IsModified() -> bool - - - IsEditable() -> bool - - - IsSingleLine() -> bool - - - IsMultiLine() -> bool - - - GetSelection() -> (from, to) - If the return values from and to are the same, there is no selection. - - - - - - - GetStringSelection() -> String - - - Clear() - - - Replace(long from, long to, String value) - - - - - - - - Remove(long from, long to) - - - - - - - LoadFile(String file) -> bool - - - - - - SaveFile(String file=EmptyString) -> bool - - - - - - MarkDirty() - - - DiscardEdits() - - - SetMaxLength(unsigned long len) - - - - - - WriteText(String text) - - - - - - AppendText(String text) - - - - - - EmulateKeyPress(KeyEvent event) -> bool - - - - - - SetStyle(long start, long end, TextAttr style) -> bool - - - - - - - - GetStyle(long position, TextAttr style) -> bool - - - - - - - SetDefaultStyle(TextAttr style) -> bool - - - - - - GetDefaultStyle() -> TextAttr - - - XYToPosition(long x, long y) -> long - - - - - - - PositionToXY(long pos) -> (x, y) - - - - - - - - ShowPosition(long pos) - - - - - - Copy() - - - Cut() - - - Paste() - - - CanCopy() -> bool - - - CanCut() -> bool - - - CanPaste() -> bool - - - Undo() - - - Redo() - - - CanUndo() -> bool - - - CanRedo() -> bool - - - SetInsertionPoint(long pos) - - - - - - SetInsertionPointEnd() - - - GetInsertionPoint() -> long - - - GetLastPosition() -> long - - - SetSelection(long from, long to) - - - - - - - SelectAll() - - - SetEditable(bool editable) - - - - - - write(String text) - - - - - - GetString(long from, long to) -> String - - - - - - - - - - __init__(int winid, MouseEvent evtMouse, long start, long end) -> TextUrlEvent - - - - - - - - - GetMouseEvent() -> MouseEvent - - - GetURLStart() -> long - - - GetURLEnd() -> long - - - -EVT_TEXT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_UPDATED, 1) -EVT_TEXT_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TEXT_ENTER, 1) -EVT_TEXT_URL = wx.PyEventBinder( wxEVT_COMMAND_TEXT_URL, 1) -EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1) - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=SB_HORIZONTAL, - Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> ScrollBar - - - - - - - - - - - - PreScrollBar() -> ScrollBar - - - Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=SB_HORIZONTAL, - Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> bool - - - - - - - - - - - - GetThumbPosition() -> int - - - GetThumbSize() -> int - - - GetPageSize() -> int - - - GetRange() -> int - - - IsVertical() -> bool - - - SetThumbPosition(int viewStart) - - - - - - SetScrollbar(int position, int thumbSize, int range, int pageSize, - bool refresh=True) - - - - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=SP_HORIZONTAL, - String name=SPIN_BUTTON_NAME) -> SpinButton - - - - - - - - - - - PreSpinButton() -> SpinButton - - - Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=SP_HORIZONTAL, - String name=SPIN_BUTTON_NAME) -> bool - - - - - - - - - - - GetValue() -> int - - - GetMin() -> int - - - GetMax() -> int - - - SetValue(int val) - - - - - - SetMin(int minVal) - - - - - - SetMax(int maxVal) - - - - - - SetRange(int minVal, int maxVal) - - - - - - - IsVertical() -> bool - - - - - - __init__(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 - - - - - - - - - - - - - - - PreSpinCtrl() -> SpinCtrl - - - Create(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 - - - - - - - - - - - - - - - GetValue() -> int - - - SetValue(int value) - - - - - - SetValueString(String text) - - - - - - SetRange(int minVal, int maxVal) - - - - - - - GetMin() -> int - - - GetMax() -> int - - - SetSelection(long from, long to) - - - - - - - -EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED, 1) - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, String label, Point point=DefaultPosition, - Size size=DefaultSize, int choices=0, - String choices_array=None, int majorDimension=0, - long style=RA_HORIZONTAL, Validator validator=DefaultValidator, - String name=RadioBoxNameStr) -> RadioBox - - - - - - - - - - - - - - - - PreRadioBox() -> RadioBox - - - Create(Window parent, int id, String label, Point point=DefaultPosition, - Size size=DefaultSize, int choices=0, - String choices_array=None, int majorDimension=0, - long style=RA_HORIZONTAL, Validator validator=DefaultValidator, - String name=RadioBoxNameStr) -> bool - - - - - - - - - - - - - - - - SetSelection(int n) - - - - - - GetSelection() -> int - - - GetStringSelection() -> String - - - SetStringSelection(String s) -> bool - - - - - - GetCount() -> int - - - FindString(String s) -> int - - - - - - GetString(int n) -> String - - - - - - SetString(int n, String label) - - - - - - - EnableItem(int n, bool enable=True) - - - - - - - ShowItem(int n, bool show=True) - - - - - - - GetColumnCount() -> int - - - GetRowCount() -> int - - - GetNextItem(int item, int dir, long style) -> int - - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, - Validator validator=DefaultValidator, String name=RadioButtonNameStr) -> RadioButton - - - - - - - - - - - - - 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 - - - - - - - - - - - - - GetValue() -> bool - - - SetValue(bool value) - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, int value, int minValue, int maxValue, - Point point=DefaultPosition, Size size=DefaultSize, - long style=SL_HORIZONTAL, Validator validator=DefaultValidator, - String name=SliderNameStr) -> Slider - - - - - - - - - - - - - - - PreSlider() -> Slider - - - Create(Window parent, int id, int value, int minValue, int maxValue, - Point point=DefaultPosition, Size size=DefaultSize, - long style=SL_HORIZONTAL, Validator validator=DefaultValidator, - String name=SliderNameStr) -> bool - - - - - - - - - - - - - - - GetValue() -> int - - - SetValue(int value) - - - - - - SetRange(int minValue, int maxValue) - - - - - - - GetMin() -> int - - - GetMax() -> int - - - SetMin(int minValue) - - - - - - SetMax(int maxValue) - - - - - - SetLineSize(int lineSize) - - - - - - SetPageSize(int pageSize) - - - - - - GetLineSize() -> int - - - GetPageSize() -> int - - - SetThumbLength(int lenPixels) - - - - - - GetThumbLength() -> int - - - SetTickFreq(int n, int pos) - - - - - - - GetTickFreq() -> int - - - ClearTicks() - - - SetTick(int tickPos) - - - - - - ClearSel() - - - GetSelEnd() -> int - - - GetSelStart() -> int - - - SetSelection(int min, int max) - - - - - - - -#--------------------------------------------------------------------------- - - - 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 - - - - - - - - - - - - - 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 - - - - - - - - - - - - - SetValue(bool value) - - - - - - GetValue() -> bool - - - SetLabel(String label) - - - - - - -#--------------------------------------------------------------------------- - - - - - GetPageCount() -> size_t - - - GetPage(size_t n) -> Window - - - - - - GetSelection() -> int - - - SetPageText(size_t n, String strText) -> bool - - - - - - - GetPageText(size_t n) -> String - - - - - - SetImageList(ImageList imageList) - - - - - - AssignImageList(ImageList imageList) - - - - - - GetImageList() -> ImageList - - - GetPageImage(size_t n) -> int - - - - - - SetPageImage(size_t n, int imageId) -> bool - - - - - - - SetPageSize(Size size) - - - - - - CalcSizeFromPage(Size sizePage) -> Size - - - - - - DeletePage(size_t n) -> bool - - - - - - RemovePage(size_t n) -> bool - - - - - - DeleteAllPages() -> bool - - - AddPage(Window page, String text, bool select=False, int imageId=-1) -> bool - - - - - - - - - InsertPage(size_t n, Window page, String text, bool select=False, - int imageId=-1) -> bool - - - - - - - - - - SetSelection(size_t n) -> int - - - - - - AdvanceSelection(bool forward=True) - - - - - - - - - __init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, - int nOldSel=-1) -> BookCtrlEvent - - - - - - - - - GetSelection() -> int - - - SetSelection(int nSel) - - - - - - GetOldSelection() -> int - - - SetOldSelection(int nOldSel) - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=NOTEBOOK_NAME) -> Notebook - - - - - - - - - - - PreNotebook() -> Notebook - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=NOTEBOOK_NAME) -> bool - - - - - - - - - - - GetRowCount() -> int - - - SetPadding(Size padding) - - - - - - SetTabSize(Size sz) - - - - - - HitTest(Point pt) -> (tab, where) - Returns the tab which is hit, and flags indicating where using wxNB_HITTEST_ flags. - - - - - - - CalcSizeFromPage(Size sizePage) -> Size - - - - - - - - - __init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, - int nOldSel=-1) -> NotebookEvent - - - - - - - - - - # wxNotebook events - EVT_NOTEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 1 ) - EVT_NOTEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 1 ) - - -#---------------------------------------------------------------------------- - -class NotebookPage(wx.Panel): - """ - There is an old (and apparently unsolvable) bug when placing a - window with a nonstandard background colour in a wxNotebook on - wxGTK, as the notbooks's background colour would always be used - when the window is refreshed. The solution is to place a panel in - the notbook and the coloured window on the panel, sized to cover - the panel. This simple class does that for you, just put an - instance of this in the notebook and make your regular window a - child of this one and it will handle the resize for you. - """ - def __init__(self, parent, id=-1, - pos=wx.DefaultPosition, size=wx.DefaultSize, - style=wx.TAB_TRAVERSAL, name="panel"): - wx.Panel.__init__(self, parent, id, pos, size, style, name) - self.child = None - EVT_SIZE(self, self.OnSize) - - def OnSize(self, evt): - if self.child is None: - children = self.GetChildren() - if len(children): - self.child = children[0] - if self.child: - self.child.SetPosition((0,0)) - self.child.SetSize(self.GetSize()) - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=EmptyString) -> Listbook - - - - - - - - - - - PreListbook() -> Listbook - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=EmptyString) -> bool - - - - - - - - - - - IsVertical() -> bool - - - - - - __init__(wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, - int nOldSel=-1) -> ListbookEvent - - - - - - - - - - EVT_LISTBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, 1 ) - EVT_LISTBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, 1 ) - - -#--------------------------------------------------------------------------- - - - - - __init__(BookCtrl nb) -> BookCtrlSizer - - - - - - RecalcSizes() - - - CalcMin() -> Size - - - GetControl() -> BookCtrl - - - - - - __init__(Notebook nb) -> NotebookSizer - - - - - - RecalcSizes() - - - CalcMin() -> Size - - - GetNotebook() -> Notebook - - - -#--------------------------------------------------------------------------- - - - - - GetId() -> int - - - GetControl() -> Control - - - GetToolBar() -> ToolBarBase - - - IsButton() -> int - - - IsControl() -> int - - - IsSeparator() -> int - - - GetStyle() -> int - - - GetKind() -> int - - - IsEnabled() -> bool - - - IsToggled() -> bool - - - CanBeToggled() -> bool - - - GetNormalBitmap() -> Bitmap - - - GetDisabledBitmap() -> Bitmap - - - GetBitmap() -> Bitmap - - - GetLabel() -> String - - - GetShortHelp() -> String - - - GetLongHelp() -> String - - - Enable(bool enable) -> bool - - - - - - Toggle() - - - SetToggle(bool toggle) -> bool - - - - - - SetShortHelp(String help) -> bool - - - - - - SetLongHelp(String help) -> bool - - - - - - SetNormalBitmap(Bitmap bmp) - - - - - - SetDisabledBitmap(Bitmap bmp) - - - - - - SetLabel(String label) - - - - - - Detach() - - - Attach(ToolBarBase tbar) - - - - - - GetClientData() -> PyObject - - - SetClientData(PyObject clientData) - - - - - - - - - DoAddTool(int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap, - int kind=ITEM_NORMAL, String shortHelp=EmptyString, - String longHelp=EmptyString, - PyObject clientData=None) -> ToolBarToolBase - - - - - - - - - - - - - DoInsertTool(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 - - - - - - - - - - - - - - AddToolItem(ToolBarToolBase tool) -> ToolBarToolBase - - - - - - InsertToolItem(size_t pos, ToolBarToolBase tool) -> ToolBarToolBase - - - - - - - AddControl(Control control) -> ToolBarToolBase - - - - - - InsertControl(size_t pos, Control control) -> ToolBarToolBase - - - - - - - FindControl(int id) -> Control - - - - - - AddSeparator() -> ToolBarToolBase - - - InsertSeparator(size_t pos) -> ToolBarToolBase - - - - - - RemoveTool(int id) -> ToolBarToolBase - - - - - - DeleteToolByPos(size_t pos) -> bool - - - - - - DeleteTool(int id) -> bool - - - - - - ClearTools() - - - Realize() -> bool - - - EnableTool(int id, bool enable) - - - - - - - ToggleTool(int id, bool toggle) - - - - - - - SetToggle(int id, bool toggle) - - - - - - - GetToolClientData(int id) -> PyObject - - - - - - SetToolClientData(int id, PyObject clientData) - - - - - - - GetToolPos(int id) -> int - - - - - - GetToolState(int id) -> bool - - - - - - GetToolEnabled(int id) -> bool - - - - - - SetToolShortHelp(int id, String helpString) - - - - - - - GetToolShortHelp(int id) -> String - - - - - - SetToolLongHelp(int id, String helpString) - - - - - - - GetToolLongHelp(int id) -> String - - - - - - SetMarginsXY(int x, int y) - - - - - - - SetMargins(Size size) - - - - - - SetToolPacking(int packing) - - - - - - SetToolSeparation(int separation) - - - - - - GetToolMargins() -> Size - - - GetMargins() -> Size - - - GetToolPacking() -> int - - - GetToolSeparation() -> int - - - SetRows(int nRows) - - - - - - SetMaxRowsCols(int rows, int cols) - - - - - - - GetMaxRows() -> int - - - GetMaxCols() -> int - - - SetToolBitmapSize(Size size) - - - - - - GetToolBitmapSize() -> Size - - - GetToolSize() -> Size - - - FindToolForPosition(int x, int y) -> ToolBarToolBase - - - - - - - FindById(int toolid) -> ToolBarToolBase - - - - - - IsVertical() -> bool - - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxNO_BORDER|wxTB_HORIZONTAL, - String name=wxPyToolBarNameStr) -> ToolBar - - - - - - - - - - - PreToolBar() -> ToolBar - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxNO_BORDER|wxTB_HORIZONTAL, - String name=wxPyToolBarNameStr) -> bool - - - - - - - - - - - FindToolForPosition(int x, int y) -> ToolBarToolBase - - - - - - - -#--------------------------------------------------------------------------- - - -#--------------------------------------------------------------------------- - - - - __init__(Colour colText=wxNullColour, Colour colBack=wxNullColour, - Font font=wxNullFont) -> ListItemAttr - - - - - - - - SetTextColour(Colour colText) - - - - - - SetBackgroundColour(Colour colBack) - - - - - - SetFont(Font font) - - - - - - HasTextColour() -> bool - - - HasBackgroundColour() -> bool - - - HasFont() -> bool - - - GetTextColour() -> Colour - - - GetBackgroundColour() -> Colour - - - GetFont() -> Font - - - Destroy() - - - -#--------------------------------------------------------------------------- - - - - - __init__() -> ListItem - - - __del__() - - - Clear() - - - ClearAttributes() - - - SetMask(long mask) - - - - - - SetId(long id) - - - - - - SetColumn(int col) - - - - - - SetState(long state) - - - - - - SetStateMask(long stateMask) - - - - - - SetText(String text) - - - - - - SetImage(int image) - - - - - - SetData(long data) - - - - - - SetWidth(int width) - - - - - - SetAlign(int align) - - - - - - SetTextColour(Colour colText) - - - - - - SetBackgroundColour(Colour colBack) - - - - - - SetFont(Font font) - - - - - - GetMask() -> long - - - GetId() -> long - - - GetColumn() -> int - - - GetState() -> long - - - GetText() -> String - - - GetImage() -> int - - - GetData() -> long - - - GetWidth() -> int - - - GetAlign() -> int - - - GetAttributes() -> ListItemAttr - - - HasAttributes() -> bool - - - GetTextColour() -> Colour - - - GetBackgroundColour() -> Colour - - - GetFont() -> Font - - - - - - - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(wxEventType commandType=wxEVT_NULL, int id=0) -> ListEvent - - - - - - - - - - - - - GetKeyCode() -> int - - - GetIndex() -> long - - - GetColumn() -> int - - - GetPoint() -> Point - - - GetLabel() -> String - - - GetText() -> String - - - GetImage() -> int - - - GetData() -> long - - - GetMask() -> long - - - GetItem() -> ListItem - - - GetCacheFrom() -> long - - - GetCacheTo() -> long - - - IsEditCancelled() -> bool - - - SetEditCanceled(bool editCancelled) - - - - - - - -EVT_LIST_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_DRAG , 1) -EVT_LIST_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_RDRAG , 1) -EVT_LIST_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT , 1) -EVT_LIST_END_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_LIST_END_LABEL_EDIT , 1) -EVT_LIST_DELETE_ITEM = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ITEM , 1) -EVT_LIST_DELETE_ALL_ITEMS = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS , 1) -EVT_LIST_GET_INFO = wx.PyEventBinder(wxEVT_COMMAND_LIST_GET_INFO , 1) -EVT_LIST_SET_INFO = wx.PyEventBinder(wxEVT_COMMAND_LIST_SET_INFO , 1) -EVT_LIST_ITEM_SELECTED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_SELECTED , 1) -EVT_LIST_ITEM_DESELECTED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_DESELECTED , 1) -EVT_LIST_KEY_DOWN = wx.PyEventBinder(wxEVT_COMMAND_LIST_KEY_DOWN , 1) -EVT_LIST_INSERT_ITEM = wx.PyEventBinder(wxEVT_COMMAND_LIST_INSERT_ITEM , 1) -EVT_LIST_COL_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_CLICK , 1) -EVT_LIST_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK , 1) -EVT_LIST_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, 1) -EVT_LIST_ITEM_ACTIVATED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_ACTIVATED , 1) -EVT_LIST_CACHE_HINT = wx.PyEventBinder(wxEVT_COMMAND_LIST_CACHE_HINT , 1) -EVT_LIST_COL_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK , 1) -EVT_LIST_COL_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG , 1) -EVT_LIST_COL_DRAGGING = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_DRAGGING , 1) -EVT_LIST_COL_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_END_DRAG , 1) -EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED , 1) - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=LC_ICON, - Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListCtrl - - - - - - - - - - - - PreListCtrl() -> ListCtrl - - - Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=LC_ICON, - Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool - - - - - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - SetForegroundColour(Colour col) -> bool - - - - - - SetBackgroundColour(Colour col) -> bool - - - - - - GetColumn(int col) -> ListItem - - - - - - SetColumn(int col, ListItem item) -> bool - - - - - - - GetColumnWidth(int col) -> int - - - - - - SetColumnWidth(int col, int width) -> bool - - - - - - - GetCountPerPage() -> int - - - GetViewRect() -> Rect - - - GetItem(long itemId, int col=0) -> ListItem - - - - - - - SetItem(ListItem info) -> bool - - - - - - SetStringItem(long index, int col, String label, int imageId=-1) -> long - - - - - - - - - GetItemState(long item, long stateMask) -> int - - - - - - - SetItemState(long item, long state, long stateMask) -> bool - - - - - - - - SetItemImage(long item, int image, int selImage) -> bool - - - - - - - - GetItemText(long item) -> String - - - - - - SetItemText(long item, String str) - - - - - - - GetItemData(long item) -> long - - - - - - SetItemData(long item, long data) -> bool - - - - - - - GetItemPosition(long item) -> Point - - - - - - GetItemRect(long item, int code=LIST_RECT_BOUNDS) -> Rect - - - - - - - SetItemPosition(long item, Point pos) -> bool - - - - - - - GetItemCount() -> int - - - GetColumnCount() -> int - - - GetItemSpacing() -> Size - - - SetItemSpacing(int spacing, bool isSmall=False) - - - - - - - GetSelectedItemCount() -> int - - - GetTextColour() -> Colour - - - SetTextColour(Colour col) - - - - - - GetTopItem() -> long - - - SetSingleStyle(long style, bool add=True) - - - - - - - SetWindowStyleFlag(long style) - - - - - - GetNextItem(long item, int geometry=LIST_NEXT_ALL, int state=LIST_STATE_DONTCARE) -> long - - - - - - - - GetImageList(int which) -> ImageList - - - - - - SetImageList(ImageList imageList, int which) - - - - - - - AssignImageList(ImageList imageList, int which) - - - - - - - IsVirtual() -> bool - - - RefreshItem(long item) - - - - - - RefreshItems(long itemFrom, long itemTo) - - - - - - - Arrange(int flag=LIST_ALIGN_DEFAULT) -> bool - - - - - - DeleteItem(long item) -> bool - - - - - - DeleteAllItems() -> bool - - - DeleteColumn(int col) -> bool - - - - - - DeleteAllColumns() -> bool - - - ClearAll() - - - EditLabel(long item) - - - - - - EnsureVisible(long item) -> bool - - - - - - FindItem(long start, String str, bool partial=False) -> long - - - - - - - - FindItemData(long start, long data) -> long - - - - - - - FindItemAtPos(long start, Point pt, int direction) -> long - - - - - - - - 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.) - - - - - - - InsertItem(ListItem info) -> long - - - - - - InsertStringItem(long index, String label) -> long - - - - - - - InsertImageItem(long index, int imageIndex) -> long - - - - - - - InsertImageStringItem(long index, String label, int imageIndex) -> long - - - - - - - - InsertColumnInfo(long col, ListItem info) -> long - - - - - - - InsertColumn(long col, String heading, int format=LIST_FORMAT_LEFT, - int width=-1) -> long - - - - - - - - - SetItemCount(long count) - - - - - - ScrollList(int dx, int dy) -> bool - - - - - - - SetItemTextColour(long item, Colour col) - - - - - - - GetItemTextColour(long item) -> Colour - - - - - - SetItemBackgroundColour(long item, Colour col) - - - - - - - GetItemBackgroundColour(long item) -> Colour - - - - - - SortItems(PyObject func) -> bool - - - - - - GetMainWindow() -> Window - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=LC_REPORT, - Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListView - - - - - - - - - - - - PreListView() -> ListView - - - Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=LC_REPORT, - Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool - - - - - - - - - - - - Select(long n, bool on=True) - - - - - - - Focus(long index) - - - - - - GetFocusedItem() -> long - - - GetNextSelected(long item) -> long - - - - - - GetFirstSelected() -> long - - - IsSelected(long index) -> bool - - - - - - SetColumnImage(int col, int image) - - - - - - - ClearColumnImage(int col) - - - - - - -#--------------------------------------------------------------------------- - - -#--------------------------------------------------------------------------- - - - - __init__() -> TreeItemId - - - __del__() - - - IsOk() -> bool - - - __eq__(TreeItemId other) -> bool - - - - - - __ne__(TreeItemId other) -> bool - - - - - - - - - __init__(PyObject obj=None) -> TreeItemData - - - - - - GetData() -> PyObject - - - SetData(PyObject obj) - - - - - - GetId() -> TreeItemId - - - SetId(TreeItemId id) - - - - - - Destroy() - - - -#--------------------------------------------------------------------------- - - - -EVT_TREE_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_DRAG , 1) -EVT_TREE_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_RDRAG , 1) -EVT_TREE_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT , 1) -EVT_TREE_END_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_LABEL_EDIT , 1) -EVT_TREE_DELETE_ITEM = wx.PyEventBinder(wxEVT_COMMAND_TREE_DELETE_ITEM , 1) -EVT_TREE_GET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_GET_INFO , 1) -EVT_TREE_SET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_SET_INFO , 1) -EVT_TREE_ITEM_EXPANDED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDED , 1) -EVT_TREE_ITEM_EXPANDING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDING , 1) -EVT_TREE_ITEM_COLLAPSED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSED , 1) -EVT_TREE_ITEM_COLLAPSING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSING , 1) -EVT_TREE_SEL_CHANGED = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGED , 1) -EVT_TREE_SEL_CHANGING = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGING , 1) -EVT_TREE_KEY_DOWN = wx.PyEventBinder(wxEVT_COMMAND_TREE_KEY_DOWN , 1) -EVT_TREE_ITEM_ACTIVATED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_ACTIVATED , 1) -EVT_TREE_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK , 1) -EVT_TREE_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 1) -EVT_TREE_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_DRAG , 1) -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 - - - - - - - GetItem() -> TreeItemId - - - SetItem(TreeItemId item) - - - - - - GetOldItem() -> TreeItemId - - - SetOldItem(TreeItemId item) - - - - - - GetPoint() -> Point - - - SetPoint(Point pt) - - - - - - GetKeyEvent() -> KeyEvent - - - GetKeyCode() -> int - - - SetKeyEvent(KeyEvent evt) - - - - - - GetLabel() -> String - - - SetLabel(String label) - - - - - - IsEditCancelled() -> bool - - - SetEditCanceled(bool editCancelled) - - - - - - SetToolTip(String toolTip) - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=TR_DEFAULT_STYLE, - Validator validator=DefaultValidator, - String name=TreeCtrlNameStr) -> TreeCtrl - - - - - - - - - - - - PreTreeCtrl() -> TreeCtrl - - - Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=TR_DEFAULT_STYLE, - Validator validator=DefaultValidator, - String name=TreeCtrlNameStr) -> bool - - - - - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - GetCount() -> size_t - - - GetIndent() -> unsigned int - - - SetIndent(unsigned int indent) - - - - - - GetSpacing() -> unsigned int - - - SetSpacing(unsigned int spacing) - - - - - - GetImageList() -> ImageList - - - GetStateImageList() -> ImageList - - - SetImageList(ImageList imageList) - - - - - - SetStateImageList(ImageList imageList) - - - - - - AssignImageList(ImageList imageList) - - - - - - AssignStateImageList(ImageList imageList) - - - - - - GetItemText(TreeItemId item) -> String - - - - - - GetItemImage(TreeItemId item, int which=TreeItemIcon_Normal) -> int - - - - - - - GetItemData(TreeItemId item) -> TreeItemData - - - - - - GetItemPyData(TreeItemId item) -> PyObject - - - - - - GetItemTextColour(TreeItemId item) -> Colour - - - - - - GetItemBackgroundColour(TreeItemId item) -> Colour - - - - - - GetItemFont(TreeItemId item) -> Font - - - - - - SetItemText(TreeItemId item, String text) - - - - - - - SetItemImage(TreeItemId item, int image, int which=TreeItemIcon_Normal) - - - - - - - - SetItemData(TreeItemId item, TreeItemData data) - - - - - - - SetItemPyData(TreeItemId item, PyObject obj) - - - - - - - SetItemHasChildren(TreeItemId item, bool has=True) - - - - - - - SetItemBold(TreeItemId item, bool bold=True) - - - - - - - SetItemTextColour(TreeItemId item, Colour col) - - - - - - - SetItemBackgroundColour(TreeItemId item, Colour col) - - - - - - - SetItemFont(TreeItemId item, Font font) - - - - - - - IsVisible(TreeItemId item) -> bool - - - - - - ItemHasChildren(TreeItemId item) -> bool - - - - - - IsExpanded(TreeItemId item) -> bool - - - - - - IsSelected(TreeItemId item) -> bool - - - - - - IsBold(TreeItemId item) -> bool - - - - - - GetChildrenCount(TreeItemId item, bool recursively=True) -> size_t - - - - - - - GetRootItem() -> TreeItemId - - - GetSelection() -> TreeItemId - - - GetSelections() -> PyObject - - - GetItemParent(TreeItemId item) -> TreeItemId - - - - - - GetFirstChild(TreeItemId item) -> PyObject - - - - - - GetNextChild(TreeItemId item, wxTreeItemIdValue cookie) -> PyObject - - - - - - - GetLastChild(TreeItemId item) -> TreeItemId - - - - - - GetNextSibling(TreeItemId item) -> TreeItemId - - - - - - GetPrevSibling(TreeItemId item) -> TreeItemId - - - - - - GetFirstVisibleItem() -> TreeItemId - - - GetNextVisible(TreeItemId item) -> TreeItemId - - - - - - GetPrevVisible(TreeItemId item) -> TreeItemId - - - - - - AddRoot(String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId - - - - - - - - - PrependItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1, - TreeItemData data=None) -> TreeItemId - - - - - - - - - - InsertItem(TreeItemId parent, TreeItemId idPrevious, String text, - int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId - - - - - - - - - - - InsertItemBefore(TreeItemId parent, size_t index, String text, int image=-1, - int selectedImage=-1, TreeItemData data=None) -> TreeItemId - - - - - - - - - - - AppendItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1, - TreeItemData data=None) -> TreeItemId - - - - - - - - - - Delete(TreeItemId item) - - - - - - DeleteChildren(TreeItemId item) - - - - - - DeleteAllItems() - - - Expand(TreeItemId item) - - - - - - Collapse(TreeItemId item) - - - - - - CollapseAndReset(TreeItemId item) - - - - - - Toggle(TreeItemId item) - - - - - - Unselect() - - - UnselectAll() - - - SelectItem(TreeItemId item) - - - - - - EnsureVisible(TreeItemId item) - - - - - - ScrollTo(TreeItemId item) - - - - - - EditLabel(TreeItemId item) - - - - - - GetEditControl() -> TextCtrl - - - SortChildren(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. - - - - - - - - GetBoundingRect(TreeItemId item, bool textOnly=False) -> PyObject - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id=-1, String dir=DirDialogDefaultFolderStr, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER, - String filter=EmptyString, - int defaultFilter=0, String name=TreeCtrlNameStr) -> GenericDirCtrl - - - - - - - - - - - - - - PreGenericDirCtrl() -> GenericDirCtrl - - - Create(Window parent, int id=-1, String dir=DirDialogDefaultFolderStr, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER, - String filter=EmptyString, - int defaultFilter=0, String name=TreeCtrlNameStr) -> bool - - - - - - - - - - - - - - ExpandPath(String path) -> bool - - - - - - GetDefaultPath() -> String - - - SetDefaultPath(String path) - - - - - - GetPath() -> String - - - GetFilePath() -> String - - - SetPath(String path) - - - - - - ShowHidden(bool show) - - - - - - GetShowHidden() -> bool - - - GetFilter() -> String - - - SetFilter(String filter) - - - - - - GetFilterIndex() -> int - - - SetFilterIndex(int n) - - - - - - GetRootId() -> TreeItemId - - - GetTreeCtrl() -> TreeCtrl - - - GetFilterListCtrl() -> 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 - - - - - - - - - DoResize() - - - ReCreateTree() - - - - - - __init__(GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0) -> DirFilterListCtrl - - - - - - - - - - PreDirFilterListCtrl() -> DirFilterListCtrl - - - Create(GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0) -> bool - - - - - - - - - - FillFilterList(String filter, int defaultFilter) - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, Validator validator=DefaultValidator, - String name=ControlNameStr) -> PyControl - - - - - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_DoMoveWindow(int x, int y, int width, int height) - - - - - - - - - base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) - - - - - - - - - - base_DoSetClientSize(int width, int height) - - - - - - - base_DoSetVirtualSize(int x, int y) - - - - - - - base_DoGetSize() -> (width, height) - - - - - - - base_DoGetClientSize() -> (width, height) - - - - - - - base_DoGetPosition() -> (x,y) - - - - - - - base_DoGetVirtualSize() -> Size - - - base_DoGetBestSize() -> Size - - - base_InitDialog() - - - base_TransferDataToWindow() -> bool - - - base_TransferDataFromWindow() -> bool - - - base_Validate() -> bool - - - base_AcceptsFocus() -> bool - - - base_AcceptsFocusFromKeyboard() -> bool - - - base_GetMaxSize() -> Size - - - base_AddChild(Window child) - - - - - - base_RemoveChild(Window child) - - - - - - -#--------------------------------------------------------------------------- - - -EVT_HELP = wx.PyEventBinder( wxEVT_HELP, 1) -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) - - - - - __init__(wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> HelpEvent - - - - - - - - GetPosition() -> Point - - - SetPosition(Point pos) - - - - - - GetLink() -> String - - - SetLink(String link) - - - - - - GetTarget() -> String - - - SetTarget(String target) - - - - - - - - - __init__(Window window=None, bool doNow=True) -> ContextHelp - - - - - - - __del__() - - - BeginContextHelp(Window window=None) -> bool - - - - - - EndContextHelp() -> bool - - - - - - __init__(Window parent, int id=ID_CONTEXT_HELP, Point pos=DefaultPosition, - Size size=DefaultSize, long style=BU_AUTODRAW) -> ContextHelpButton - - - - - - - - - - - - HelpProvider.Set(HelpProvider helpProvider) -> HelpProvider - - - - - - HelpProvider.Get() -> HelpProvider - - - GetHelp(Window window) -> String - - - - - - ShowHelp(Window window) -> bool - - - - - - AddHelp(Window window, String text) - - - - - - - AddHelpById(int id, String text) - - - - - - - Destroy() - - - - - - __init__() -> SimpleHelpProvider - - - -#--------------------------------------------------------------------------- - - - - - __init__(Bitmap image, Cursor cursor=wxNullCursor) -> DragImage - - - - - - - DragIcon(Icon image, Cursor cursor=wxNullCursor) -> DragImage - - - - - - - DragString(String str, Cursor cursor=wxNullCursor) -> DragImage - - - - - - - DragTreeItem(TreeCtrl treeCtrl, TreeItemId id) -> DragImage - - - - - - - DragListItem(ListCtrl listCtrl, long id) -> DragImage - - - - - - - __del__() - - - SetBackingBitmap(Bitmap bitmap) - - - - - - BeginDrag(Point hotspot, Window window, bool fullScreen=False, - Rect rect=None) -> bool - - - - - - - - - BeginDragBounded(Point hotspot, Window window, Window boundingWindow) -> bool - - - - - - - - EndDrag() -> bool - - - Move(Point pt) -> bool - - - - - - Show() -> bool - - - Hide() -> bool - - - GetImageRect(Point pos) -> Rect - - - - - - DoDrawImage(DC dc, Point pos) -> bool - - - - - - - UpdateBackingFromWindow(DC windowDC, MemoryDC destDC, Rect sourceRect, Rect destRect) -> bool - - - - - - - - - RedrawImage(Point oldPos, Point newPos, bool eraseOld, bool drawNew) -> bool - - - - - - - - - - - wx = core - -#--------------------------------------------------------------------------- - - - - SystemSettings.GetColour(int index) -> Colour - - - - - - SystemSettings.GetFont(int index) -> Font - - - - - - SystemSettings.GetMetric(int index) -> int - - - - - - SystemSettings.HasFeature(int index) -> bool - - - - - - SystemSettings.GetScreenType() -> int - - - SystemSettings.SetScreenType(int screen) - - - - - - -# backwards compatibility aliasses -SystemSettings_GetSystemColour = SystemSettings_GetColour -SystemSettings_GetSystemFont = SystemSettings_GetFont -SystemSettings_GetSystemMetric = SystemSettings_GetMetric - - - - - __init__() -> SystemOptions - - - SystemOptions.SetOption(String name, String value) - - - - - - - SystemOptions.SetOptionInt(String name, int value) - - - - - - - SystemOptions.GetOption(String name) -> String - - - - - - SystemOptions.GetOptionInt(String name) -> int - - - - - - SystemOptions.HasOption(String name) -> bool - - - - - - -#--------------------------------------------------------------------------- - - - NewId() -> long - - - RegisterId(long id) - - - - - - GetCurrentId() -> long - - - Bell() - - - EndBusyCursor() - - - GetElapsedTime(bool resetTimer=True) -> long - - - - - - GetMousePosition() -> (x,y) - - - - - - - IsBusy() -> bool - - - Now() -> String - - - Shell(String command=EmptyString) -> bool - - - - - - StartTimer() - - - GetOsVersion() -> (platform, major, minor) - - - - - - - GetOsDescription() -> String - - - GetFreeMemory() -> long - - - Shutdown(int wFlags) -> bool - - - - - - Sleep(int secs) - - - - - - Usleep(unsigned long milliseconds) - - - - - - EnableTopLevelWindows(bool enable) - - - - - - StripMenuCodes(String in) -> String - - - - - - GetEmailAddress() -> String - - - GetHostName() -> String - - - GetFullHostName() -> String - - - GetUserId() -> String - - - GetUserName() -> String - - - GetHomeDir() -> String - - - GetUserHome(String user=EmptyString) -> String - - - - - - GetProcessId() -> unsigned long - - - Trap() - - - FileSelector(String message=FileSelectorPromptStr, String default_path=EmptyString, - String default_filename=EmptyString, - String default_extension=EmptyString, - String wildcard=FileSelectorDefaultWildcardStr, - int flags=0, Window parent=None, int x=-1, - int y=-1) -> String - - - - - - - - - - - - - - LoadFileSelector(String what, String extension, String default_name=EmptyString, - Window parent=None) -> String - - - - - - - - - SaveFileSelector(String what, String extension, String default_name=EmptyString, - Window parent=None) -> String - - - - - - - - - DirSelector(String message=DirSelectorPromptStr, String defaultPath=EmptyString, - long style=DD_DEFAULT_STYLE, - Point pos=DefaultPosition, Window parent=None) -> String - - - - - - - - - - GetTextFromUser(String message, String caption=EmptyString, String default_value=EmptyString, - Window parent=None, - int x=-1, int y=-1, bool centre=True) -> String - - - - - - - - - - - - GetPasswordFromUser(String message, String caption=EmptyString, String default_value=EmptyString, - Window parent=None) -> String - - - - - - - - - GetSingleChoice(String message, String caption, int choices, String choices_array, - Window parent=None, int x=-1, - int y=-1, bool centre=True, int width=150, int height=200) -> String - - - - - - - - - - - - - - - GetSingleChoiceIndex(String message, String caption, int choices, String choices_array, - Window parent=None, int x=-1, - int y=-1, bool centre=True, int width=150, int height=200) -> int - - - - - - - - - - - - - - - MessageBox(String message, String caption=EmptyString, int style=wxOK|wxCENTRE, - Window parent=None, int x=-1, - int y=-1) -> int - - - - - - - - - - - GetNumberFromUser(String message, String prompt, String caption, long value, - long min=0, long max=100, Window parent=None, - Point pos=DefaultPosition) -> long - - - - - - - - - - - - - ColourDisplay() -> bool - - - DisplayDepth() -> int - - - GetDisplayDepth() -> int - - - DisplaySize() -> (width, height) - - - - - - - GetDisplaySize() -> Size - - - DisplaySizeMM() -> (width, height) - - - - - - - GetDisplaySizeMM() -> Size - - - ClientDisplayRect() -> (x, y, width, height) - - - - - - - - - GetClientDisplayRect() -> Rect - - - SetCursor(Cursor cursor) - - - - - - BeginBusyCursor(Cursor cursor=wxHOURGLASS_CURSOR) - - - - - - GetActiveWindow() -> Window - - - GenericFindWindowAtPoint(Point pt) -> Window - - - - - - FindWindowAtPoint(Point pt) -> Window - - - - - - GetTopLevelParent(Window win) -> Window - - - - - - GetKeyState(int key) -> bool - - - - - - WakeUpMainThread() - - - MutexGuiEnter() - - - MutexGuiLeave() - - - - __init__() -> MutexGuiLocker - - - __del__() - - - - Thread_IsMain() -> bool - - -#--------------------------------------------------------------------------- - - - - - __init__(String tip) -> ToolTip - - - - - - SetTip(String tip) - - - - - - GetTip() -> String - - - GetWindow() -> Window - - - ToolTip.Enable(bool flag) - - - - - - ToolTip.SetDelay(long milliseconds) - - - - - - - - __init__(Window window, Size size) -> Caret - - - - - - - __del__() - - - IsOk() -> bool - - - IsVisible() -> bool - - - GetPosition() -> Point - - - GetPositionTuple() -> (x,y) - - - - - - - GetSize() -> Size - - - GetSizeTuple() -> (width, height) - - - - - - - GetWindow() -> Window - - - MoveXY(int x, int y) - - - - - - - Move(Point pt) - - - - - - SetSizeWH(int width, int height) - - - - - - - SetSize(Size size) - - - - - - Show(int show=True) - - - - - - Hide() - - - - Caret_GetBlinkTime() -> int - - - Caret_SetBlinkTime(int milliseconds) - - - - - - - __init__(Cursor cursor=wxHOURGLASS_CURSOR) -> BusyCursor - - - - - - __del__() - - - - - __init__(Window winToSkip=None) -> WindowDisabler - - - - - - __del__() - - - - - - __init__(String message) -> BusyInfo - - - - - - __del__() - - - - - __init__() -> StopWatch - - - Start(long t0=0) - - - - - - Pause() - - - Resume() - - - Time() -> long - - - - - - __init__(int maxFiles=9) -> FileHistory - - - - - - __del__() - - - AddFileToHistory(String file) - - - - - - RemoveFileFromHistory(int i) - - - - - - GetMaxFiles() -> int - - - UseMenu(Menu menu) - - - - - - RemoveMenu(Menu menu) - - - - - - Load(ConfigBase config) - - - - - - Save(ConfigBase config) - - - - - - AddFilesToMenu() - - - AddFilesToThisMenu(Menu menu) - - - - - - GetHistoryFile(int i) -> String - - - - - - GetCount() -> int - - - - - __init__(String name, String path=EmptyString) -> SingleInstanceChecker - - - - - - - PreSingleInstanceChecker() -> SingleInstanceChecker - - - __del__() - - - Create(String name, String path=EmptyString) -> bool - - - - - - - IsAnotherRunning() -> bool - - - - DrawWindowOnDC(Window window, DC dc, int method) - - - - - - - -#--------------------------------------------------------------------------- - - - - __del__() - - - GetTip() -> String - - - GetCurrentTip() -> size_t - - - PreprocessTip(String tip) -> String - - - - - - - - - __init__(size_t currentTip) -> PyTipProvider - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - - ShowTip(Window parent, TipProvider tipProvider, bool showAtStartup=True) -> bool - - - - - - - - CreateFileTipProvider(String filename, size_t currentTip) -> TipProvider - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(EvtHandler owner=None, int id=-1) -> Timer - - - - - - - __del__() - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - SetOwner(EvtHandler owner, int id=-1) - - - - - - - Start(int milliseconds=-1, bool oneShot=False) -> bool - - - - - - - Stop() - - - IsRunning() -> bool - - - GetInterval() -> int - - - IsOneShot() -> bool - - - GetId() -> int - - - -# For backwards compatibility with 2.4 -class PyTimer(Timer): - def __init__(self, notify): - Timer.__init__(self) - self.notify = notify - - def Notify(self): - if self.notify: - self.notify() - - -EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 ) - - - - - - __init__(int timerid=0, int interval=0) -> TimerEvent - - - - - - - GetInterval() -> int - - - - - - - - - - __init__(wxTimer timer) -> TimerRunner -__init__(wxTimer timer, int milli, bool oneShot=False) -> TimerRunner - - - - - - - - __del__() - - - Start(int milli, bool oneShot=False) - - - - - - - -#--------------------------------------------------------------------------- - - - - __init__() -> Log - - - Log.IsEnabled() -> bool - - - Log.EnableLogging(bool doIt=True) -> bool - - - - - - Log.OnLog(wxLogLevel level, wxChar szString, time_t t) - - - - - - - - Flush() - - - Log.FlushActive() - - - Log.GetActiveTarget() -> Log - - - Log.SetActiveTarget(Log pLogger) -> Log - - - - - - Log.Suspend() - - - Log.Resume() - - - Log.SetVerbose(bool bVerbose=True) - - - - - - Log.SetLogLevel(wxLogLevel logLevel) - - - - - - Log.DontCreateOnDemand() - - - Log.SetTraceMask(wxTraceMask ulMask) - - - - - - Log.AddTraceMask(String str) - - - - - - Log.RemoveTraceMask(String str) - - - - - - Log.ClearTraceMasks() - - - Log.GetTraceMasks() -> wxArrayString - - - Log.SetTimestamp(wxChar ts) - - - - - - Log.GetVerbose() -> bool - - - Log.GetTraceMask() -> wxTraceMask - - - Log.IsAllowedTraceMask(wxChar mask) -> bool - - - - - - Log.GetLogLevel() -> wxLogLevel - - - Log.GetTimestamp() -> wxChar - - - Log.TimeStamp() -> String - - - Destroy() - - - - - - __init__() -> LogStderr - - - - - - __init__(wxTextCtrl pTextCtrl) -> LogTextCtrl - - - - - - - - - __init__() -> LogGui - - - - - - __init__(wxFrame pParent, String szTitle, bool bShow=True, bool bPassToOld=True) -> LogWindow - - - - - - - - - Show(bool bShow=True) - - - - - - GetFrame() -> wxFrame - - - GetOldLog() -> Log - - - IsPassingMessages() -> bool - - - PassMessages(bool bDoPass) - - - - - - - - - __init__(Log logger) -> LogChain - - - - - - SetLog(Log logger) - - - - - - PassMessages(bool bDoPass) - - - - - - IsPassingMessages() -> bool - - - GetOldLog() -> Log - - - - SysErrorCode() -> unsigned long - - - SysErrorMsg(unsigned long nErrCode=0) -> String - - - - - - LogFatalError(String msg) - - - - - - LogError(String msg) - - - - - - LogWarning(String msg) - - - - - - LogMessage(String msg) - - - - - - LogInfo(String msg) - - - - - - LogDebug(String msg) - - - - - - LogVerbose(String msg) - - - - - - LogStatus(String msg) - - - - - - LogStatusFrame(wxFrame pFrame, String msg) - - - - - - - LogSysError(String msg) - - - - - - - - - - - - LogTrace(unsigned long mask, String msg) -LogTrace(String mask, String msg) - - - - - - - LogGeneric(unsigned long level, String msg) - - - - - - - SafeShowMessage(String title, String text) - - - - - - - - __init__() -> LogNull - - - __del__() - - - - - - __init__() -> PyLog - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(EvtHandler parent=None, int id=-1) -> Process - - - - - - - Process.Kill(int pid, int sig=SIGTERM) -> int - - - - - - - Process.Exists(int pid) -> bool - - - - - - Process.Open(String cmd, int flags=EXEC_ASYNC) -> Process - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_OnTerminate(int pid, int status) - - - - - - - Redirect() - - - IsRedirected() -> bool - - - Detach() - - - GetInputStream() -> InputStream - - - GetErrorStream() -> InputStream - - - GetOutputStream() -> OutputStream - - - CloseOutput() - - - IsInputOpened() -> bool - - - IsInputAvailable() -> bool - - - IsErrorAvailable() -> bool - - - - - - __init__(int id=0, int pid=0, int exitcode=0) -> ProcessEvent - - - - - - - - GetPid() -> int - - - GetExitCode() -> int - - - - - -EVT_END_PROCESS = wx.PyEventBinder( wxEVT_END_PROCESS, 1 ) - - - Execute(String command, int flags=EXEC_ASYNC, Process process=None) -> long - - - - - - - -#--------------------------------------------------------------------------- - - - - __init__(int joystick=JOYSTICK1) -> Joystick - - - - - - __del__() - - - GetPosition() -> Point - - - GetZPosition() -> int - - - GetButtonState() -> int - - - GetPOVPosition() -> int - - - GetPOVCTSPosition() -> int - - - GetRudderPosition() -> int - - - GetUPosition() -> int - - - GetVPosition() -> int - - - GetMovementThreshold() -> int - - - SetMovementThreshold(int threshold) - - - - - - IsOk() -> bool - - - GetNumberJoysticks() -> int - - - GetManufacturerId() -> int - - - GetProductId() -> int - - - GetProductName() -> String - - - GetXMin() -> int - - - GetYMin() -> int - - - GetZMin() -> int - - - GetXMax() -> int - - - GetYMax() -> int - - - GetZMax() -> int - - - GetNumberButtons() -> int - - - GetNumberAxes() -> int - - - GetMaxButtons() -> int - - - GetMaxAxes() -> int - - - GetPollingMin() -> int - - - GetPollingMax() -> int - - - GetRudderMin() -> int - - - GetRudderMax() -> int - - - GetUMin() -> int - - - GetUMax() -> int - - - GetVMin() -> int - - - GetVMax() -> int - - - HasRudder() -> bool - - - HasZ() -> bool - - - HasU() -> bool - - - HasV() -> bool - - - HasPOV() -> bool - - - HasPOV4Dir() -> bool - - - HasPOVCTS() -> bool - - - SetCapture(Window win, int pollingFreq=0) -> bool - - - - - - - ReleaseCapture() -> bool - - - - - - __init__(wxEventType type=wxEVT_NULL, int state=0, int joystick=JOYSTICK1, - int change=0) -> JoystickEvent - - - - - - - - - - - - - - GetPosition() -> Point - - - GetZPosition() -> int - - - GetButtonState() -> int - - - GetButtonChange() -> int - - - GetJoystick() -> int - - - SetJoystick(int stick) - - - - - - SetButtonState(int state) - - - - - - SetButtonChange(int change) - - - - - - SetPosition(Point pos) - - - - - - SetZPosition(int zPos) - - - - - - IsButton() -> bool - - - IsMove() -> bool - - - IsZMove() -> bool - - - ButtonDown(int but=JOY_BUTTON_ANY) -> bool - - - - - - ButtonUp(int but=JOY_BUTTON_ANY) -> bool - - - - - - ButtonIsDown(int but=JOY_BUTTON_ANY) -> bool - - - - - - -EVT_JOY_BUTTON_DOWN = wx.PyEventBinder( wxEVT_JOY_BUTTON_DOWN ) -EVT_JOY_BUTTON_UP = wx.PyEventBinder( wxEVT_JOY_BUTTON_UP ) -EVT_JOY_MOVE = wx.PyEventBinder( wxEVT_JOY_MOVE ) -EVT_JOY_ZMOVE = wx.PyEventBinder( wxEVT_JOY_ZMOVE ) - -EVT_JOYSTICK_EVENTS = wx.PyEventBinder([ wxEVT_JOY_BUTTON_DOWN, - wxEVT_JOY_BUTTON_UP, - wxEVT_JOY_MOVE, - wxEVT_JOY_ZMOVE, - ]) - - - -#--------------------------------------------------------------------------- - - - - __init__(String fileName, bool isResource=False) -> Wave - - - - - - - WaveData(String data) -> Wave - - - - - - __del__() - - - IsOk() -> bool - - - Play(bool async=True, bool looped=False) -> bool - - - - - - - -#--------------------------------------------------------------------------- - - - - __init__(String mimeType, String openCmd, String printCmd, String desc) -> FileTypeInfo - - - - - - - - - FileTypeInfoSequence(wxArrayString sArray) -> FileTypeInfo - - - - - - NullFileTypeInfo() -> FileTypeInfo - - - IsValid() -> bool - - - SetIcon(String iconFile, int iconIndex=0) - - - - - - - SetShortDesc(String shortDesc) - - - - - - GetMimeType() -> String - - - GetOpenCommand() -> String - - - GetPrintCommand() -> String - - - GetShortDesc() -> String - - - GetDescription() -> String - - - GetExtensions() -> wxArrayString - - - GetExtensionsCount() -> int - - - GetIconFile() -> String - - - GetIconIndex() -> int - - - - - __init__(FileTypeInfo ftInfo) -> FileType - - - - - - __del__() - - - GetMimeType() -> PyObject - - - GetMimeTypes() -> PyObject - - - GetExtensions() -> PyObject - - - GetIcon() -> Icon - - - GetIconInfo() -> PyObject - - - GetDescription() -> PyObject - - - GetOpenCommand(String filename, String mimetype=EmptyString) -> PyObject - - - - - - - GetPrintCommand(String filename, String mimetype=EmptyString) -> PyObject - - - - - - - GetAllCommands(String filename, String mimetype=EmptyString) -> PyObject - - - - - - - SetCommand(String cmd, String verb, bool overwriteprompt=True) -> bool - - - - - - - - SetDefaultIcon(String cmd=EmptyString, int index=0) -> bool - - - - - - - Unassociate() -> bool - - - FileType.ExpandCommand(String command, String filename, String mimetype=EmptyString) -> String - - - - - - - - - - __init__() -> MimeTypesManager - - - __del__() - - - MimeTypesManager.IsOfType(String mimeType, String wildcard) -> bool - - - - - - - Initialize(int mailcapStyle=MAILCAP_ALL, String extraDir=EmptyString) - - - - - - - ClearData() - - - GetFileTypeFromExtension(String ext) -> FileType - - - - - - GetFileTypeFromMimeType(String mimeType) -> FileType - - - - - - ReadMailcap(String filename, bool fallback=False) -> bool - - - - - - - ReadMimeTypes(String filename) -> bool - - - - - - EnumAllFileTypes() -> PyObject - - - AddFallback(FileTypeInfo ft) - - - - - - Associate(FileTypeInfo ftInfo) -> FileType - - - - - - Unassociate(FileType ft) -> bool - - - - - - -#--------------------------------------------------------------------------- - - - - __init__() -> ArtProvider - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - ArtProvider.PushProvider(ArtProvider provider) - Add new provider to the top of providers stack. - - - - - - ArtProvider.PopProvider() -> bool - Remove latest added provider and delete it. - - - ArtProvider.RemoveProvider(ArtProvider provider) -> bool - Remove provider. The provider must have been added previously! -The provider is _not_ deleted. - - - - - - ArtProvider.GetBitmap(String id, String client=ART_OTHER, Size size=DefaultSize) -> Bitmap - Query the providers for bitmap with given ID and return it. Return -wx.NullBitmap if no provider provides it. - - - - - - - - ArtProvider.GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -> Icon - Query the providers for icon with given ID and return it. Return -wx.NullIcon if no provider provides it. - - - - - - - - Destroy() - - - -#--------------------------------------------------------------------------- - - - - __del__() - - - ConfigBase.Set(ConfigBase pConfig) -> ConfigBase - - - - - - ConfigBase.Get(bool createOnDemand=True) -> ConfigBase - - - - - - ConfigBase.Create() -> ConfigBase - - - ConfigBase.DontCreateOnDemand() - - - SetPath(String strPath) - - - - - - GetPath() -> String - - - GetFirstGroup() -> PyObject - - - GetNextGroup(long index) -> PyObject - - - - - - GetFirstEntry() -> PyObject - - - GetNextEntry(long index) -> PyObject - - - - - - GetNumberOfEntries(bool bRecursive=False) -> size_t - - - - - - GetNumberOfGroups(bool bRecursive=False) -> size_t - - - - - - HasGroup(String strName) -> bool - - - - - - HasEntry(String strName) -> bool - - - - - - Exists(String strName) -> bool - - - - - - GetEntryType(String name) -> int - - - - - - Read(String key, String defaultVal=EmptyString) -> String - - - - - - - ReadInt(String key, long defaultVal=0) -> long - - - - - - - ReadFloat(String key, double defaultVal=0.0) -> double - - - - - - - ReadBool(String key, bool defaultVal=False) -> bool - - - - - - - Write(String key, String value) -> bool - - - - - - - WriteInt(String key, long value) -> bool - - - - - - - WriteFloat(String key, double value) -> bool - - - - - - - WriteBool(String key, bool value) -> bool - - - - - - - Flush(bool bCurrentOnly=False) -> bool - - - - - - RenameEntry(String oldName, String newName) -> bool - - - - - - - RenameGroup(String oldName, String newName) -> bool - - - - - - - DeleteEntry(String key, bool bDeleteGroupIfEmpty=True) -> bool - - - - - - - DeleteGroup(String key) -> bool - - - - - - DeleteAll() -> bool - - - IsExpandingEnvVars() -> bool - - - SetExpandEnvVars(bool bDoIt=True) - - - - - - SetRecordDefaults(bool bDoIt=True) - - - - - - IsRecordingDefaults() -> bool - - - ExpandEnvVars(String str) -> String - - - - - - GetAppName() -> String - - - GetVendorName() -> String - - - SetAppName(String appName) - - - - - - SetVendorName(String vendorName) - - - - - - SetStyle(long style) - - - - - - GetStyle() -> long - - - - - __init__(ConfigBase pContainer, String strEntry) -> ConfigPathChanger - - - - - - - __del__() - - - Name() -> String - - - - - - __init__(String appName=EmptyString, String vendorName=EmptyString, - String localFilename=EmptyString, String globalFilename=EmptyString, - long style=0) -> Config - - - - - - - - - - __del__() - - - - - - __init__(String appName=EmptyString, String vendorName=EmptyString, - String localFilename=EmptyString, String globalFilename=EmptyString, - long style=0) -> FileConfig - - - - - - - - - - __del__() - - - - ExpandEnvVars(String sz) -> String - - - - - -#--------------------------------------------------------------------------- - - - - __init__() -> DateTime - - - DateTimeFromTimeT(time_t timet) -> DateTime - - - - - - DateTimeFromJDN(double jdn) -> DateTime - - - - - - DateTimeFromHMS(int hour, int minute=0, int second=0, int millisec=0) -> DateTime - - - - - - - - - DateTimeFromDMY(int day, int month=Inv_Month, int year=Inv_Year, int hour=0, - int minute=0, int second=0, int millisec=0) -> DateTime - - - - - - - - - - - - __del__() - - - DateTime.SetCountry(int country) - - - - - - DateTime.GetCountry() -> int - - - DateTime.IsWestEuropeanCountry(int country=Country_Default) -> bool - - - - - - DateTime.GetCurrentYear(int cal=Gregorian) -> int - - - - - - DateTime.ConvertYearToBC(int year) -> int - - - - - - DateTime.GetCurrentMonth(int cal=Gregorian) -> int - - - - - - DateTime.IsLeapYear(int year=Inv_Year, int cal=Gregorian) -> bool - - - - - - - DateTime.GetCentury(int year=Inv_Year) -> int - - - - - - DateTime.GetNumberOfDaysinYear(int year, int cal=Gregorian) -> int - - - - - - - DateTime.GetNumberOfDaysInMonth(int month, int year=Inv_Year, int cal=Gregorian) -> int - - - - - - - - DateTime.GetMonthName(int month, int flags=Name_Full) -> String - - - - - - - DateTime.GetWeekDayName(int weekday, int flags=Name_Full) -> String - - - - - - - GetAmPmStrings() -> (am, pm) - Get the AM and PM strings in the current locale (may be empty) - - - - - - - DateTime.IsDSTApplicable(int year=Inv_Year, int country=Country_Default) -> bool - - - - - - - DateTime.GetBeginDST(int year=Inv_Year, int country=Country_Default) -> DateTime - - - - - - - DateTime.GetEndDST(int year=Inv_Year, int country=Country_Default) -> DateTime - - - - - - - DateTime.Now() -> DateTime - - - DateTime.UNow() -> DateTime - - - DateTime.Today() -> DateTime - - - SetToCurrent() -> DateTime - - - SetTimeT(time_t timet) -> DateTime - - - - - - SetJDN(double jdn) -> DateTime - - - - - - SetHMS(int hour, int minute=0, int second=0, int millisec=0) -> DateTime - - - - - - - - - Set(int day, int month=Inv_Month, int year=Inv_Year, int hour=0, - int minute=0, int second=0, int millisec=0) -> DateTime - - - - - - - - - - - - ResetTime() -> DateTime - - - SetYear(int year) -> DateTime - - - - - - SetMonth(int month) -> DateTime - - - - - - SetDay(int day) -> DateTime - - - - - - SetHour(int hour) -> DateTime - - - - - - SetMinute(int minute) -> DateTime - - - - - - SetSecond(int second) -> DateTime - - - - - - SetMillisecond(int millisecond) -> DateTime - - - - - - SetToWeekDayInSameWeek(int weekday, int flags=Monday_First) -> DateTime - - - - - - - GetWeekDayInSameWeek(int weekday, int flags=Monday_First) -> DateTime - - - - - - - SetToNextWeekDay(int weekday) -> DateTime - - - - - - GetNextWeekDay(int weekday) -> DateTime - - - - - - SetToPrevWeekDay(int weekday) -> DateTime - - - - - - GetPrevWeekDay(int weekday) -> DateTime - - - - - - SetToWeekDay(int weekday, int n=1, int month=Inv_Month, int year=Inv_Year) -> bool - - - - - - - - - SetToLastWeekDay(int weekday, int month=Inv_Month, int year=Inv_Year) -> bool - - - - - - - - GetLastWeekDay(int weekday, int month=Inv_Month, int year=Inv_Year) -> DateTime - - - - - - - - SetToTheWeek(int numWeek, int weekday=Mon, int flags=Monday_First) -> bool - - - - - - - - GetWeek(int numWeek, int weekday=Mon, int flags=Monday_First) -> DateTime - - - - - - - - SetToLastMonthDay(int month=Inv_Month, int year=Inv_Year) -> DateTime - - - - - - - GetLastMonthDay(int month=Inv_Month, int year=Inv_Year) -> DateTime - - - - - - - SetToYearDay(int yday) -> DateTime - - - - - - GetYearDay(int yday) -> DateTime - - - - - - GetJulianDayNumber() -> double - - - GetJDN() -> double - - - GetModifiedJulianDayNumber() -> double - - - GetMJD() -> double - - - GetRataDie() -> double - - - ToTimezone(wxDateTime::TimeZone tz, bool noDST=False) -> DateTime - - - - - - - MakeTimezone(wxDateTime::TimeZone tz, bool noDST=False) -> DateTime - - - - - - - ToGMT(bool noDST=False) -> DateTime - - - - - - MakeGMT(bool noDST=False) -> DateTime - - - - - - IsDST(int country=Country_Default) -> int - - - - - - IsValid() -> bool - - - GetTicks() -> time_t - - - GetYear(wxDateTime::TimeZone tz=LOCAL_TZ) -> int - - - - - - GetMonth(wxDateTime::TimeZone tz=LOCAL_TZ) -> int - - - - - - GetDay(wxDateTime::TimeZone tz=LOCAL_TZ) -> int - - - - - - GetWeekDay(wxDateTime::TimeZone tz=LOCAL_TZ) -> int - - - - - - GetHour(wxDateTime::TimeZone tz=LOCAL_TZ) -> int - - - - - - GetMinute(wxDateTime::TimeZone tz=LOCAL_TZ) -> int - - - - - - GetSecond(wxDateTime::TimeZone tz=LOCAL_TZ) -> int - - - - - - GetMillisecond(wxDateTime::TimeZone tz=LOCAL_TZ) -> int - - - - - - GetDayOfYear(wxDateTime::TimeZone tz=LOCAL_TZ) -> int - - - - - - GetWeekOfYear(int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - - - - - - - GetWeekOfMonth(int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int - - - - - - - IsWorkDay(int country=Country_Default) -> bool - - - - - - IsEqualTo(DateTime datetime) -> bool - - - - - - IsEarlierThan(DateTime datetime) -> bool - - - - - - IsLaterThan(DateTime datetime) -> bool - - - - - - IsStrictlyBetween(DateTime t1, DateTime t2) -> bool - - - - - - - IsBetween(DateTime t1, DateTime t2) -> bool - - - - - - - IsSameDate(DateTime dt) -> bool - - - - - - IsSameTime(DateTime dt) -> bool - - - - - - IsEqualUpTo(DateTime dt, TimeSpan ts) -> bool - - - - - - - AddTS(TimeSpan diff) -> DateTime - - - - - - AddDS(DateSpan diff) -> DateTime - - - - - - SubtractTS(TimeSpan diff) -> DateTime - - - - - - SubtractDS(DateSpan diff) -> DateTime - - - - - - Subtract(DateTime dt) -> TimeSpan - - - - - - - - - - - __iadd__(TimeSpan diff) -> DateTime -__iadd__(DateSpan diff) -> DateTime - - - - - - - - - - - __isub__(TimeSpan diff) -> DateTime -__isub__(DateSpan diff) -> DateTime - - - - - - - - - - - __add__(TimeSpan other) -> DateTime -__add__(DateSpan other) -> DateTime - - - - - - - - - - - - - - - - __sub__(DateTime other) -> TimeSpan -__sub__(TimeSpan other) -> DateTime -__sub__(DateSpan other) -> DateTime - - - - - - __lt__(DateTime other) -> bool - - - - - - __le__(DateTime other) -> bool - - - - - - __gt__(DateTime other) -> bool - - - - - - __ge__(DateTime other) -> bool - - - - - - __eq__(DateTime other) -> bool - - - - - - __ne__(DateTime other) -> bool - - - - - - ParseRfc822Date(String date) -> int - - - - - - ParseFormat(String date, String format=DateFormatStr, DateTime dateDef=wxDefaultDateTime) -> int - - - - - - - - ParseDateTime(String datetime) -> int - - - - - - ParseDate(String date) -> int - - - - - - ParseTime(String time) -> int - - - - - - Format(String format=DateFormatStr, wxDateTime::TimeZone tz=LOCAL_TZ) -> String - - - - - - - FormatDate() -> String - - - FormatTime() -> String - - - FormatISODate() -> String - - - FormatISOTime() -> String - - - - - __init__(long hours=0, long minutes=0, long seconds=0, long milliseconds=0) -> TimeSpan - - - - - - - - - __del__() - - - TimeSpan.Seconds(long sec) -> TimeSpan - - - - - - TimeSpan.Second() -> TimeSpan - - - TimeSpan.Minutes(long min) -> TimeSpan - - - - - - TimeSpan.Minute() -> TimeSpan - - - TimeSpan.Hours(long hours) -> TimeSpan - - - - - - TimeSpan.Hour() -> TimeSpan - - - TimeSpan.Days(long days) -> TimeSpan - - - - - - TimeSpan.Day() -> TimeSpan - - - TimeSpan.Weeks(long days) -> TimeSpan - - - - - - TimeSpan.Week() -> TimeSpan - - - Add(TimeSpan diff) -> TimeSpan - - - - - - Subtract(TimeSpan diff) -> TimeSpan - - - - - - Multiply(int n) -> TimeSpan - - - - - - Neg() -> TimeSpan - - - Abs() -> TimeSpan - - - __iadd__(TimeSpan diff) -> TimeSpan - - - - - - __isub__(TimeSpan diff) -> TimeSpan - - - - - - __imul__(int n) -> TimeSpan - - - - - - __neg__() -> TimeSpan - - - __add__(TimeSpan other) -> TimeSpan - - - - - - __sub__(TimeSpan other) -> TimeSpan - - - - - - __mul__(int n) -> TimeSpan - - - - - - __rmul__(int n) -> TimeSpan - - - - - - __lt__(TimeSpan other) -> bool - - - - - - __le__(TimeSpan other) -> bool - - - - - - __gt__(TimeSpan other) -> bool - - - - - - __ge__(TimeSpan other) -> bool - - - - - - __eq__(TimeSpan other) -> bool - - - - - - __ne__(TimeSpan other) -> bool - - - - - - IsNull() -> bool - - - IsPositive() -> bool - - - IsNegative() -> bool - - - IsEqualTo(TimeSpan ts) -> bool - - - - - - IsLongerThan(TimeSpan ts) -> bool - - - - - - IsShorterThan(TimeSpan t) -> bool - - - - - - GetWeeks() -> int - - - GetDays() -> int - - - GetHours() -> int - - - GetMinutes() -> int - - - GetSeconds() -> wxLongLong - - - GetMilliseconds() -> wxLongLong - - - Format(String format=TimeSpanFormatStr) -> String - - - - - - - - __init__(int years=0, int months=0, int weeks=0, int days=0) -> DateSpan - - - - - - - - - __del__() - - - DateSpan.Days(int days) -> DateSpan - - - - - - DateSpan.Day() -> DateSpan - - - DateSpan.Weeks(int weeks) -> DateSpan - - - - - - DateSpan.Week() -> DateSpan - - - DateSpan.Months(int mon) -> DateSpan - - - - - - DateSpan.Month() -> DateSpan - - - DateSpan.Years(int years) -> DateSpan - - - - - - DateSpan.Year() -> DateSpan - - - SetYears(int n) -> DateSpan - - - - - - SetMonths(int n) -> DateSpan - - - - - - SetWeeks(int n) -> DateSpan - - - - - - SetDays(int n) -> DateSpan - - - - - - GetYears() -> int - - - GetMonths() -> int - - - GetWeeks() -> int - - - GetDays() -> int - - - GetTotalDays() -> int - - - Add(DateSpan other) -> DateSpan - - - - - - Subtract(DateSpan other) -> DateSpan - - - - - - Neg() -> DateSpan - - - Multiply(int factor) -> DateSpan - - - - - - __iadd__(DateSpan other) -> DateSpan - - - - - - __isub__(DateSpan other) -> DateSpan - - - - - - __neg__() -> DateSpan - - - __imul__(int factor) -> DateSpan - - - - - - __add__(DateSpan other) -> DateSpan - - - - - - __sub__(DateSpan other) -> DateSpan - - - - - - __mul__(int n) -> DateSpan - - - - - - __rmul__(int n) -> DateSpan - - - - - - __eq__(DateSpan other) -> bool - - - - - - __ne__(DateSpan other) -> bool - - - - - - - GetLocalTime() -> long - - - GetUTCTime() -> long - - - GetCurrentTime() -> long - - - GetLocalTimeMillis() -> wxLongLong - - -#--------------------------------------------------------------------------- - - - - __init__(int type) -> DataFormat - - - - - - CustomDataFormat(String format) -> DataFormat - - - - - - __del__() - - - - - - - - - - - - - __eq__(int format) -> bool -__eq__(DataFormat format) -> bool - - - - - - __ne__(int format) -> bool -__ne__(DataFormat format) -> bool - - - - - - SetType(int format) - - - - - - GetType() -> int - - - GetId() -> String - - - SetId(String format) - - - - - - - - __del__() - - - GetPreferredFormat(int dir=Get) -> DataFormat - - - - - - GetFormatCount(int dir=Get) -> size_t - - - - - - IsSupported(DataFormat format, int dir=Get) -> bool - - - - - - - GetDataSize(DataFormat format) -> size_t - - - - - - GetAllFormats(DataFormat formats, int dir=Get) - - - - - - - GetDataHere(DataFormat format, void buf) -> bool - - - - - - - SetData(DataFormat format, size_t len, void buf) -> bool - - - - - - - - - - - __init__(DataFormat format=FormatInvalid) -> DataObjectSimple - - - - - - GetFormat() -> DataFormat - - - SetFormat(DataFormat format) - - - - - - - - - __init__(DataFormat format=FormatInvalid) -> PyDataObjectSimple - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - - - - __init__() -> DataObjectComposite - - - Add(DataObjectSimple dataObject, int preferred=False) - - - - - - - - - - __init__(String text=EmptyString) -> TextDataObject - - - - - - GetTextLength() -> size_t - - - GetText() -> String - - - SetText(String text) - - - - - - - - - __init__(String text=EmptyString) -> PyTextDataObject - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - - - - __init__(Bitmap bitmap=wxNullBitmap) -> BitmapDataObject - - - - - - GetBitmap() -> Bitmap - - - SetBitmap(Bitmap bitmap) - - - - - - - - - __init__(Bitmap bitmap=wxNullBitmap) -> PyBitmapDataObject - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - - - - __init__() -> FileDataObject - - - GetFilenames() -> wxArrayString - - - - - - __init__(DataFormat format=FormatInvalid) -> CustomDataObject - - - - - - TakeData(PyObject data) - - - - - - SetData(PyObject data) -> bool - - - - - - GetSize() -> size_t - - - GetData() -> PyObject - - - - - - __init__() -> URLDataObject - - - GetURL() -> String - - - SetURL(String url) - - - - - - - - - __init__() -> MetafileDataObject - - - -#--------------------------------------------------------------------------- - - - IsDragResultOk(int res) -> bool - - - - - - - __init__(Window win=None, Icon copy=wxNullIcon, Icon move=wxNullIcon, - Icon none=wxNullIcon) -> DropSource - - - - - - - - - __del__() - - - _setCallbackInfo(PyObject self, PyObject _class, int incref) - - - - - - - - SetData(DataObject data) - - - - - - GetDataObject() -> DataObject - - - SetCursor(int res, Cursor cursor) - - - - - - - DoDragDrop(int flags=Drag_CopyOnly) -> int - - - - - - base_GiveFeedback(int effect) -> bool - - - - - - - - PyDropTarget(DataObject dataObject=None) -> DropTarget - - - - - - __del__() - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - GetDataObject() -> DataObject - - - SetDataObject(DataObject dataObject) - - - - - - base_OnEnter(int x, int y, int def) -> int - - - - - - - - base_OnDragOver(int x, int y, int def) -> int - - - - - - - - base_OnLeave() - - - base_OnDrop(int x, int y) -> bool - - - - - - - GetData() -> bool - - - PyDropTarget = DropTarget - - - - __init__() -> TextDropTarget - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_OnEnter(int x, int y, int def) -> int - - - - - - - - base_OnDragOver(int x, int y, int def) -> int - - - - - - - - base_OnLeave() - - - base_OnDrop(int x, int y) -> bool - - - - - - - base_OnData(int x, int y, int def) -> int - - - - - - - - - - - __init__() -> FileDropTarget - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_OnEnter(int x, int y, int def) -> int - - - - - - - - base_OnDragOver(int x, int y, int def) -> int - - - - - - - - base_OnLeave() - - - base_OnDrop(int x, int y) -> bool - - - - - - - base_OnData(int x, int y, int def) -> int - - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__() -> Clipboard - - - __del__() - - - Open() -> bool - - - Close() - - - IsOpened() -> bool - - - AddData(DataObject data) -> bool - - - - - - SetData(DataObject data) -> bool - - - - - - IsSupported(DataFormat format) -> bool - - - - - - GetData(DataObject data) -> bool - - - - - - Clear() - - - Flush() -> bool - - - UsePrimarySelection(bool primary=False) - - - - - - - - __init__(Clipboard clipboard=None) -> ClipboardLocker - - - - - - __del__() - - - __nonzero__() -> bool - - - - - wx = core - - - __init__(Colour colText, Colour colBack=wxNullColour, Colour colBorder=wxNullColour, - Font font=wxNullFont, - int border=CAL_BORDER_NONE) -> CalendarDateAttr - - - - - - - - - - CalendarDateAttrBorder(int border, Colour colBorder=wxNullColour) -> CalendarDateAttr - - - - - - - SetTextColour(Colour colText) - - - - - - SetBackgroundColour(Colour colBack) - - - - - - SetBorderColour(Colour col) - - - - - - SetFont(Font font) - - - - - - SetBorder(int border) - - - - - - SetHoliday(bool holiday) - - - - - - HasTextColour() -> bool - - - HasBackgroundColour() -> bool - - - HasBorderColour() -> bool - - - HasFont() -> bool - - - HasBorder() -> bool - - - IsHoliday() -> bool - - - GetTextColour() -> Colour - - - GetBackgroundColour() -> Colour - - - GetBorderColour() -> Colour - - - GetFont() -> Font - - - GetBorder() -> int - - - - - - __init__(CalendarCtrl cal, wxEventType type) -> CalendarEvent - - - - - - - GetDate() -> DateTime - - - SetDate(DateTime date) - - - - - - SetWeekDay(int wd) - - - - - - GetWeekDay() -> int - - - -EVT_CALENDAR = wx.PyEventBinder( wxEVT_CALENDAR_DOUBLECLICKED, 1) -EVT_CALENDAR_SEL_CHANGED = wx.PyEventBinder( wxEVT_CALENDAR_SEL_CHANGED, 1) -EVT_CALENDAR_DAY = wx.PyEventBinder( wxEVT_CALENDAR_DAY_CHANGED, 1) -EVT_CALENDAR_MONTH = wx.PyEventBinder( wxEVT_CALENDAR_MONTH_CHANGED, 1) -EVT_CALENDAR_YEAR = wx.PyEventBinder( wxEVT_CALENDAR_YEAR_CHANGED, 1) -EVT_CALENDAR_WEEKDAY_CLICKED = wx.PyEventBinder( wxEVT_CALENDAR_WEEKDAY_CLICKED, 1) - - - - - __init__(Window parent, int id, DateTime date=wxDefaultDateTime, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS, - String name=CalendarNameStr) -> CalendarCtrl - - - - - - - - - - - - PreCalendarCtrl() -> CalendarCtrl - - - Create(Window parent, int id, DateTime date=wxDefaultDateTime, - Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS, - String name=CalendarNameStr) -> bool - - - - - - - - - - - - SetDate(DateTime date) - - - - - - GetDate() -> DateTime - - - SetLowerDateLimit(DateTime date=wxDefaultDateTime) -> bool - - - - - - GetLowerDateLimit() -> DateTime - - - SetUpperDateLimit(DateTime date=wxDefaultDateTime) -> bool - - - - - - GetUpperDateLimit() -> DateTime - - - SetDateRange(DateTime lowerdate=wxDefaultDateTime, DateTime upperdate=wxDefaultDateTime) -> bool - - - - - - - EnableYearChange(bool enable=True) - - - - - - EnableMonthChange(bool enable=True) - - - - - - EnableHolidayDisplay(bool display=True) - - - - - - SetHeaderColours(Colour colFg, Colour colBg) - - - - - - - GetHeaderColourFg() -> Colour - - - GetHeaderColourBg() -> Colour - - - SetHighlightColours(Colour colFg, Colour colBg) - - - - - - - GetHighlightColourFg() -> Colour - - - GetHighlightColourBg() -> Colour - - - SetHolidayColours(Colour colFg, Colour colBg) - - - - - - - GetHolidayColourFg() -> Colour - - - GetHolidayColourBg() -> Colour - - - GetAttr(size_t day) -> CalendarDateAttr - - - - - - SetAttr(size_t day, CalendarDateAttr attr) - - - - - - - SetHoliday(size_t day) - - - - - - ResetAttr(size_t day) - - - - - - HitTest(Point pos, DateTime date=None, int wd=None) -> int - - - - - - - - Enable(bool enable=True) -> bool - - - - - - Show(bool show=True) -> bool - - - - - - GetMonthControl() -> Control - - - GetYearControl() -> Control - - - - - wx = core - - - _setOORInfo(PyObject _self) - - - - - - SetParameters(String params) - - - - - - IncRef() - - - DecRef() - - - Draw(Grid grid, GridCellAttr attr, DC dc, Rect rect, int row, - int col, bool isSelected) - - - - - - - - - - - - GetBestSize(Grid grid, GridCellAttr attr, DC dc, int row, int col) -> Size - - - - - - - - - - Clone() -> GridCellRenderer - - - - - - __init__() -> PyGridCellRenderer - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_SetParameters(String params) - - - - - - - - - __init__() -> GridCellStringRenderer - - - - - - __init__() -> GridCellNumberRenderer - - - - - - __init__(int width=-1, int precision=-1) -> GridCellFloatRenderer - - - - - - - GetWidth() -> int - - - SetWidth(int width) - - - - - - GetPrecision() -> int - - - SetPrecision(int precision) - - - - - - - - - __init__() -> GridCellBoolRenderer - - - - - - __init__(String outformat=DateTimeFormatStr, String informat=DateTimeFormatStr) -> GridCellDateTimeRenderer - - - - - - - - - - __init__(String choices=EmptyString) -> GridCellEnumRenderer - - - - - - - - - __init__() -> GridCellAutoWrapStringRenderer - - - - - _setOORInfo(PyObject _self) - - - - - - IsCreated() -> bool - - - GetControl() -> Control - - - SetControl(Control control) - - - - - - GetCellAttr() -> GridCellAttr - - - SetCellAttr(GridCellAttr attr) - - - - - - SetParameters(String params) - - - - - - IncRef() - - - DecRef() - - - Create(Window parent, int id, EvtHandler evtHandler) - - - - - - - - BeginEdit(int row, int col, Grid grid) - - - - - - - - EndEdit(int row, int col, Grid grid) -> bool - - - - - - - - Reset() - - - Clone() -> GridCellEditor - - - SetSize(Rect rect) - - - - - - Show(bool show, GridCellAttr attr=None) - - - - - - - PaintBackground(Rect rectCell, GridCellAttr attr) - - - - - - - IsAcceptedKey(KeyEvent event) -> bool - - - - - - StartingKey(KeyEvent event) - - - - - - StartingClick() - - - HandleReturn(KeyEvent event) - - - - - - Destroy() - - - - - - __init__() -> PyGridCellEditor - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_SetSize(Rect rect) - - - - - - base_Show(bool show, GridCellAttr attr=None) - - - - - - - base_PaintBackground(Rect rectCell, GridCellAttr attr) - - - - - - - base_IsAcceptedKey(KeyEvent event) -> bool - - - - - - base_StartingKey(KeyEvent event) - - - - - - base_StartingClick() - - - base_HandleReturn(KeyEvent event) - - - - - - base_Destroy() - - - base_SetParameters(String params) - - - - - - - - - __init__() -> GridCellTextEditor - - - GetValue() -> String - - - - - - __init__(int min=-1, int max=-1) -> GridCellNumberEditor - - - - - - - GetValue() -> String - - - - - - __init__() -> GridCellFloatEditor - - - GetValue() -> String - - - - - - __init__() -> GridCellBoolEditor - - - GetValue() -> String - - - - - - __init__(int choices=0, String choices_array=None, bool allowOthers=False) -> GridCellChoiceEditor - - - - - - - - GetValue() -> String - - - - - - __init__(String choices=EmptyString) -> GridCellEnumEditor - - - - - - GetValue() -> String - - - - - - __init__() -> GridCellAutoWrapStringEditor - - - GetValue() -> String - - - - - __init__(GridCellAttr attrDefault=None) -> GridCellAttr - - - - - - _setOORInfo(PyObject _self) - - - - - - Clone() -> GridCellAttr - - - MergeWith(GridCellAttr mergefrom) - - - - - - IncRef() - - - DecRef() - - - SetTextColour(Colour colText) - - - - - - SetBackgroundColour(Colour colBack) - - - - - - SetFont(Font font) - - - - - - SetAlignment(int hAlign, int vAlign) - - - - - - - SetSize(int num_rows, int num_cols) - - - - - - - SetOverflow(bool allow=True) - - - - - - SetReadOnly(bool isReadOnly=True) - - - - - - SetRenderer(GridCellRenderer renderer) - - - - - - SetEditor(GridCellEditor editor) - - - - - - SetKind(int kind) - - - - - - HasTextColour() -> bool - - - HasBackgroundColour() -> bool - - - HasFont() -> bool - - - HasAlignment() -> bool - - - HasRenderer() -> bool - - - HasEditor() -> bool - - - HasReadWriteMode() -> bool - - - HasOverflowMode() -> bool - - - GetTextColour() -> Colour - - - GetBackgroundColour() -> Colour - - - GetFont() -> Font - - - GetAlignment() -> (hAlign, vAlign) - - - - - - - GetSize() -> (num_rows, num_cols) - - - - - - - GetOverflow() -> bool - - - GetRenderer(Grid grid, int row, int col) -> GridCellRenderer - - - - - - - - GetEditor(Grid grid, int row, int col) -> GridCellEditor - - - - - - - - IsReadOnly() -> bool - - - SetDefAttr(GridCellAttr defAttr) - - - - - - - - __init__() -> GridCellAttrProvider - - - _setOORInfo(PyObject _self) - - - - - - GetAttr(int row, int col, int kind) -> GridCellAttr - - - - - - - - SetAttr(GridCellAttr attr, int row, int col) - - - - - - - - SetRowAttr(GridCellAttr attr, int row) - - - - - - - SetColAttr(GridCellAttr attr, int col) - - - - - - - UpdateAttrRows(size_t pos, int numRows) - - - - - - - UpdateAttrCols(size_t pos, int numCols) - - - - - - - - - - __init__() -> PyGridCellAttrProvider - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_GetAttr(int row, int col, int kind) -> GridCellAttr - - - - - - - - base_SetAttr(GridCellAttr attr, int row, int col) - - - - - - - - base_SetRowAttr(GridCellAttr attr, int row) - - - - - - - base_SetColAttr(GridCellAttr attr, int col) - - - - - - - - - - _setOORInfo(PyObject _self) - - - - - - SetAttrProvider(GridCellAttrProvider attrProvider) - - - - - - GetAttrProvider() -> GridCellAttrProvider - - - SetView(Grid grid) - - - - - - GetView() -> Grid - - - GetNumberRows() -> int - - - GetNumberCols() -> int - - - IsEmptyCell(int row, int col) -> bool - - - - - - - GetValue(int row, int col) -> String - - - - - - - SetValue(int row, int col, String value) - - - - - - - - GetTypeName(int row, int col) -> String - - - - - - - CanGetValueAs(int row, int col, String typeName) -> bool - - - - - - - - CanSetValueAs(int row, int col, String typeName) -> bool - - - - - - - - GetValueAsLong(int row, int col) -> long - - - - - - - GetValueAsDouble(int row, int col) -> double - - - - - - - GetValueAsBool(int row, int col) -> bool - - - - - - - SetValueAsLong(int row, int col, long value) - - - - - - - - SetValueAsDouble(int row, int col, double value) - - - - - - - - SetValueAsBool(int row, int col, bool value) - - - - - - - - Clear() - - - InsertRows(size_t pos=0, size_t numRows=1) -> bool - - - - - - - AppendRows(size_t numRows=1) -> bool - - - - - - DeleteRows(size_t pos=0, size_t numRows=1) -> bool - - - - - - - InsertCols(size_t pos=0, size_t numCols=1) -> bool - - - - - - - AppendCols(size_t numCols=1) -> bool - - - - - - DeleteCols(size_t pos=0, size_t numCols=1) -> bool - - - - - - - GetRowLabelValue(int row) -> String - - - - - - GetColLabelValue(int col) -> String - - - - - - SetRowLabelValue(int row, String value) - - - - - - - SetColLabelValue(int col, String value) - - - - - - - CanHaveAttributes() -> bool - - - GetAttr(int row, int col, int kind) -> GridCellAttr - - - - - - - - SetAttr(GridCellAttr attr, int row, int col) - - - - - - - - SetRowAttr(GridCellAttr attr, int row) - - - - - - - SetColAttr(GridCellAttr attr, int col) - - - - - - - - - - __init__() -> PyGridTableBase - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - Destroy() - Deletes the C++ object this Python object is a proxy for. - - - base_GetTypeName(int row, int col) -> String - - - - - - - base_CanGetValueAs(int row, int col, String typeName) -> bool - - - - - - - - base_CanSetValueAs(int row, int col, String typeName) -> bool - - - - - - - - base_Clear() - - - base_InsertRows(size_t pos=0, size_t numRows=1) -> bool - - - - - - - base_AppendRows(size_t numRows=1) -> bool - - - - - - base_DeleteRows(size_t pos=0, size_t numRows=1) -> bool - - - - - - - base_InsertCols(size_t pos=0, size_t numCols=1) -> bool - - - - - - - base_AppendCols(size_t numCols=1) -> bool - - - - - - base_DeleteCols(size_t pos=0, size_t numCols=1) -> bool - - - - - - - base_GetRowLabelValue(int row) -> String - - - - - - base_GetColLabelValue(int col) -> String - - - - - - base_SetRowLabelValue(int row, String value) - - - - - - - base_SetColLabelValue(int col, String value) - - - - - - - base_CanHaveAttributes() -> bool - - - base_GetAttr(int row, int col, int kind) -> GridCellAttr - - - - - - - - base_SetAttr(GridCellAttr attr, int row, int col) - - - - - - - - base_SetRowAttr(GridCellAttr attr, int row) - - - - - - - base_SetColAttr(GridCellAttr attr, int col) - - - - - - - - - - __init__(int numRows=0, int numCols=0) -> GridStringTable - - - - - - - - - __init__(GridTableBase table, int id, int comInt1=-1, int comInt2=-1) -> GridTableMessage - - - - - - - - - __del__() - - - SetTableObject(GridTableBase table) - - - - - - GetTableObject() -> GridTableBase - - - SetId(int id) - - - - - - GetId() -> int - - - SetCommandInt(int comInt1) - - - - - - GetCommandInt() -> int - - - SetCommandInt2(int comInt2) - - - - - - GetCommandInt2() -> int - - - - - __init__(int r=-1, int c=-1) -> GridCellCoords - - - - - - - __del__() - - - GetRow() -> int - - - SetRow(int n) - - - - - - GetCol() -> int - - - SetCol(int n) - - - - - - Set(int row, int col) - - - - - - - __eq__(GridCellCoords other) -> bool - - - - - - __ne__(GridCellCoords other) -> bool - - - - - - asTuple() -> PyObject - - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=WANTS_CHARS, - String name=PanelNameStr) -> Grid - - - - - - - - - - - CreateGrid(int numRows, int numCols, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool - - - - - - - - SetSelectionMode(WXGRIDSELECTIONMODES selmode) - - - - - - GetSelectionMode() -> WXGRIDSELECTIONMODES - - - GetNumberRows() -> int - - - GetNumberCols() -> int - - - ProcessTableMessage(GridTableMessage ??) -> bool - - - - - - GetTable() -> GridTableBase - - - SetTable(GridTableBase table, bool takeOwnership=False, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool - - - - - - - - ClearGrid() - - - InsertRows(int pos=0, int numRows=1, bool updateLabels=True) -> bool - - - - - - - - AppendRows(int numRows=1, bool updateLabels=True) -> bool - - - - - - - DeleteRows(int pos=0, int numRows=1, bool updateLabels=True) -> bool - - - - - - - - InsertCols(int pos=0, int numCols=1, bool updateLabels=True) -> bool - - - - - - - - AppendCols(int numCols=1, bool updateLabels=True) -> bool - - - - - - - DeleteCols(int pos=0, int numCols=1, bool updateLabels=True) -> bool - - - - - - - - DrawCellHighlight(DC dc, GridCellAttr attr) - - - - - - - DrawTextRectangle(DC dc, String ??, Rect ??, int horizontalAlignment=LEFT, - int verticalAlignment=TOP, int textOrientation=HORIZONTAL) - - - - - - - - - - - GetTextBoxSize(DC dc, list lines) -> (width, height) - - - - - - - - - BeginBatch() - - - EndBatch() - - - GetBatchCount() -> int - - - ForceRefresh() - - - Refresh(bool eraseb=True, Rect rect=None) - - - - - - - IsEditable() -> bool - - - EnableEditing(bool edit) - - - - - - EnableCellEditControl(bool enable=True) - - - - - - DisableCellEditControl() - - - CanEnableCellControl() -> bool - - - IsCellEditControlEnabled() -> bool - - - IsCellEditControlShown() -> bool - - - IsCurrentCellReadOnly() -> bool - - - ShowCellEditControl() - - - HideCellEditControl() - - - SaveEditControlValue() - - - XYToCell(int x, int y) -> GridCellCoords - - - - - - - YToRow(int y) -> int - - - - - - XToCol(int x) -> int - - - - - - YToEdgeOfRow(int y) -> int - - - - - - XToEdgeOfCol(int x) -> int - - - - - - CellToRect(int row, int col) -> Rect - - - - - - - GetGridCursorRow() -> int - - - GetGridCursorCol() -> int - - - IsVisible(int row, int col, bool wholeCellVisible=True) -> bool - - - - - - - - MakeCellVisible(int row, int col) - - - - - - - SetGridCursor(int row, int col) - - - - - - - MoveCursorUp(bool expandSelection) -> bool - - - - - - MoveCursorDown(bool expandSelection) -> bool - - - - - - MoveCursorLeft(bool expandSelection) -> bool - - - - - - MoveCursorRight(bool expandSelection) -> bool - - - - - - MovePageDown() -> bool - - - MovePageUp() -> bool - - - MoveCursorUpBlock(bool expandSelection) -> bool - - - - - - MoveCursorDownBlock(bool expandSelection) -> bool - - - - - - MoveCursorLeftBlock(bool expandSelection) -> bool - - - - - - MoveCursorRightBlock(bool expandSelection) -> bool - - - - - - GetDefaultRowLabelSize() -> int - - - GetRowLabelSize() -> int - - - GetDefaultColLabelSize() -> int - - - GetColLabelSize() -> int - - - GetLabelBackgroundColour() -> Colour - - - GetLabelTextColour() -> Colour - - - GetLabelFont() -> Font - - - GetRowLabelAlignment() -> (horiz, vert) - - - - - - - GetColLabelAlignment() -> (horiz, vert) - - - - - - - GetColLabelTextOrientation() -> int - - - GetRowLabelValue(int row) -> String - - - - - - GetColLabelValue(int col) -> String - - - - - - GetGridLineColour() -> Colour - - - GetCellHighlightColour() -> Colour - - - GetCellHighlightPenWidth() -> int - - - GetCellHighlightROPenWidth() -> int - - - SetRowLabelSize(int width) - - - - - - SetColLabelSize(int height) - - - - - - SetLabelBackgroundColour(Colour ??) - - - - - - SetLabelTextColour(Colour ??) - - - - - - SetLabelFont(Font ??) - - - - - - SetRowLabelAlignment(int horiz, int vert) - - - - - - - SetColLabelAlignment(int horiz, int vert) - - - - - - - SetColLabelTextOrientation(int textOrientation) - - - - - - SetRowLabelValue(int row, String ??) - - - - - - - SetColLabelValue(int col, String ??) - - - - - - - SetGridLineColour(Colour ??) - - - - - - SetCellHighlightColour(Colour ??) - - - - - - SetCellHighlightPenWidth(int width) - - - - - - SetCellHighlightROPenWidth(int width) - - - - - - EnableDragRowSize(bool enable=True) - - - - - - DisableDragRowSize() - - - CanDragRowSize() -> bool - - - EnableDragColSize(bool enable=True) - - - - - - DisableDragColSize() - - - CanDragColSize() -> bool - - - EnableDragGridSize(bool enable=True) - - - - - - DisableDragGridSize() - - - CanDragGridSize() -> bool - - - SetAttr(int row, int col, GridCellAttr attr) - - - - - - - - SetRowAttr(int row, GridCellAttr attr) - - - - - - - SetColAttr(int col, GridCellAttr attr) - - - - - - - SetColFormatBool(int col) - - - - - - SetColFormatNumber(int col) - - - - - - SetColFormatFloat(int col, int width=-1, int precision=-1) - - - - - - - - SetColFormatCustom(int col, String typeName) - - - - - - - EnableGridLines(bool enable=True) - - - - - - GridLinesEnabled() -> bool - - - GetDefaultRowSize() -> int - - - GetRowSize(int row) -> int - - - - - - GetDefaultColSize() -> int - - - GetColSize(int col) -> int - - - - - - GetDefaultCellBackgroundColour() -> Colour - - - GetCellBackgroundColour(int row, int col) -> Colour - - - - - - - GetDefaultCellTextColour() -> Colour - - - GetCellTextColour(int row, int col) -> Colour - - - - - - - GetDefaultCellFont() -> Font - - - GetCellFont(int row, int col) -> Font - - - - - - - GetDefaultCellAlignment() -> (horiz, vert) - - - - - - - GetCellAlignment() -> (horiz, vert) - - - - - - - - - GetDefaultCellOverflow() -> bool - - - GetCellOverflow(int row, int col) -> bool - - - - - - - GetCellSize(int row, int col) -> (num_rows, num_cols) - - - - - - - - - SetDefaultRowSize(int height, bool resizeExistingRows=False) - - - - - - - SetRowSize(int row, int height) - - - - - - - SetDefaultColSize(int width, bool resizeExistingCols=False) - - - - - - - SetColSize(int col, int width) - - - - - - - AutoSizeColumn(int col, bool setAsMin=True) - - - - - - - AutoSizeRow(int row, bool setAsMin=True) - - - - - - - AutoSizeColumns(bool setAsMin=True) - - - - - - AutoSizeRows(bool setAsMin=True) - - - - - - AutoSize() - - - AutoSizeRowLabelSize(int row) - - - - - - AutoSizeColLabelSize(int col) - - - - - - SetColMinimalWidth(int col, int width) - - - - - - - SetRowMinimalHeight(int row, int width) - - - - - - - SetColMinimalAcceptableWidth(int width) - - - - - - SetRowMinimalAcceptableHeight(int width) - - - - - - GetColMinimalAcceptableWidth() -> int - - - GetRowMinimalAcceptableHeight() -> int - - - SetDefaultCellBackgroundColour(Colour ??) - - - - - - SetCellBackgroundColour(int row, int col, Colour ??) - - - - - - - - SetDefaultCellTextColour(Colour ??) - - - - - - SetCellTextColour(int row, int col, Colour ??) - - - - - - - - SetDefaultCellFont(Font ??) - - - - - - SetCellFont(int row, int col, Font ??) - - - - - - - - SetDefaultCellAlignment(int horiz, int vert) - - - - - - - SetCellAlignment(int row, int col, int horiz, int vert) - - - - - - - - - SetDefaultCellOverflow(bool allow) - - - - - - SetCellOverflow(int row, int col, bool allow) - - - - - - - - SetCellSize(int row, int col, int num_rows, int num_cols) - - - - - - - - - SetDefaultRenderer(GridCellRenderer renderer) - - - - - - SetCellRenderer(int row, int col, GridCellRenderer renderer) - - - - - - - - GetDefaultRenderer() -> GridCellRenderer - - - GetCellRenderer(int row, int col) -> GridCellRenderer - - - - - - - SetDefaultEditor(GridCellEditor editor) - - - - - - SetCellEditor(int row, int col, GridCellEditor editor) - - - - - - - - GetDefaultEditor() -> GridCellEditor - - - GetCellEditor(int row, int col) -> GridCellEditor - - - - - - - GetCellValue(int row, int col) -> String - - - - - - - SetCellValue(int row, int col, String s) - - - - - - - - IsReadOnly(int row, int col) -> bool - - - - - - - SetReadOnly(int row, int col, bool isReadOnly=True) - - - - - - - - SelectRow(int row, bool addToSelected=False) - - - - - - - SelectCol(int col, bool addToSelected=False) - - - - - - - SelectBlock(int topRow, int leftCol, int bottomRow, int rightCol, - bool addToSelected=False) - - - - - - - - - - SelectAll() - - - IsSelection() -> bool - - - ClearSelection() - - - IsInSelection(int row, int col) -> bool - - - - - - - GetSelectedCells() -> wxGridCellCoordsArray - - - GetSelectionBlockTopLeft() -> wxGridCellCoordsArray - - - GetSelectionBlockBottomRight() -> wxGridCellCoordsArray - - - GetSelectedRows() -> wxArrayInt - - - GetSelectedCols() -> wxArrayInt - - - DeselectRow(int row) - - - - - - DeselectCol(int col) - - - - - - DeselectCell(int row, int col) - - - - - - - BlockToDeviceRect(GridCellCoords topLeft, GridCellCoords bottomRight) -> Rect - - - - - - - GetSelectionBackground() -> Colour - - - GetSelectionForeground() -> Colour - - - SetSelectionBackground(Colour c) - - - - - - SetSelectionForeground(Colour c) - - - - - - RegisterDataType(String typeName, GridCellRenderer renderer, GridCellEditor editor) - - - - - - - - GetDefaultEditorForCell(int row, int col) -> GridCellEditor - - - - - - - GetDefaultRendererForCell(int row, int col) -> GridCellRenderer - - - - - - - GetDefaultEditorForType(String typeName) -> GridCellEditor - - - - - - GetDefaultRendererForType(String typeName) -> GridCellRenderer - - - - - - SetMargins(int extraWidth, int extraHeight) - - - - - - - GetGridWindow() -> Window - - - GetGridRowLabelWindow() -> Window - - - GetGridColLabelWindow() -> Window - - - GetGridCornerLabelWindow() -> Window - - - - - - __init__(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 - - - - - - - - - - - - - - - - - GetRow() -> int - - - GetCol() -> int - - - GetPosition() -> Point - - - Selecting() -> bool - - - ControlDown() -> bool - - - MetaDown() -> bool - - - ShiftDown() -> bool - - - AltDown() -> bool - - - - - - __init__(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 - - - - - - - - - - - - - - - GetRowOrCol() -> int - - - GetPosition() -> Point - - - ControlDown() -> bool - - - MetaDown() -> bool - - - ShiftDown() -> bool - - - AltDown() -> bool - - - - - - __init__(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 - - - - - - - - - - - - - - - GetTopLeftCoords() -> GridCellCoords - - - GetBottomRightCoords() -> GridCellCoords - - - GetTopRow() -> int - - - GetBottomRow() -> int - - - GetLeftCol() -> int - - - GetRightCol() -> int - - - Selecting() -> bool - - - ControlDown() -> bool - - - MetaDown() -> bool - - - ShiftDown() -> bool - - - AltDown() -> bool - - - - - - __init__(int id, wxEventType type, Object obj, int row, int col, - Control ctrl) -> GridEditorCreatedEvent - - - - - - - - - - - GetRow() -> int - - - GetCol() -> int - - - GetControl() -> Control - - - SetRow(int row) - - - - - - SetCol(int col) - - - - - - SetControl(Control ctrl) - - - - - - -EVT_GRID_CELL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_CLICK ) -EVT_GRID_CELL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_CLICK ) -EVT_GRID_CELL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_DCLICK ) -EVT_GRID_CELL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_DCLICK ) -EVT_GRID_LABEL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_CLICK ) -EVT_GRID_LABEL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_CLICK ) -EVT_GRID_LABEL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_DCLICK ) -EVT_GRID_LABEL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_DCLICK ) -EVT_GRID_ROW_SIZE = wx.PyEventBinder( wxEVT_GRID_ROW_SIZE ) -EVT_GRID_COL_SIZE = wx.PyEventBinder( wxEVT_GRID_COL_SIZE ) -EVT_GRID_RANGE_SELECT = wx.PyEventBinder( wxEVT_GRID_RANGE_SELECT ) -EVT_GRID_CELL_CHANGE = wx.PyEventBinder( wxEVT_GRID_CELL_CHANGE ) -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 ) - - - - wx = core - -#--------------------------------------------------------------------------- - - - - - __init__(String href, String target=EmptyString) -> HtmlLinkInfo - - - - - - - GetHref() -> String - - - GetTarget() -> String - - - GetEvent() -> MouseEvent - - - GetHtmlCell() -> HtmlCell - - - SetEvent(MouseEvent e) - - - - - - SetHtmlCell(HtmlCell e) - - - - - - - - - GetName() -> String - - - HasParam(String par) -> bool - - - - - - GetParam(String par, int with_commas=False) -> String - - - - - - - GetAllParams() -> String - - - HasEnding() -> bool - - - GetBeginPos() -> int - - - GetEndPos1() -> int - - - GetEndPos2() -> int - - - - - - SetFS(FileSystem fs) - - - - - - GetFS() -> FileSystem - - - Parse(String source) -> Object - - - - - - InitParser(String source) - - - - - - DoneParser() - - - DoParsing(int begin_pos, int end_pos) - - - - - - - StopParsing() - - - AddTagHandler(HtmlTagHandler handler) - - - - - - GetSource() -> String - - - PushTagHandler(HtmlTagHandler handler, String tags) - - - - - - - PopTagHandler() - - - - - - __init__(HtmlWindow wnd=None) -> HtmlWinParser - - - - - - SetDC(DC dc) - - - - - - GetDC() -> DC - - - GetCharHeight() -> int - - - GetCharWidth() -> int - - - GetWindow() -> HtmlWindow - - - SetFonts(String normal_face, String fixed_face, PyObject sizes=None) - - - - - - - - GetContainer() -> HtmlContainerCell - - - OpenContainer() -> HtmlContainerCell - - - SetContainer(HtmlContainerCell c) -> HtmlContainerCell - - - - - - CloseContainer() -> HtmlContainerCell - - - GetFontSize() -> int - - - SetFontSize(int s) - - - - - - GetFontBold() -> int - - - SetFontBold(int x) - - - - - - GetFontItalic() -> int - - - SetFontItalic(int x) - - - - - - GetFontUnderlined() -> int - - - SetFontUnderlined(int x) - - - - - - GetFontFixed() -> int - - - SetFontFixed(int x) - - - - - - GetAlign() -> int - - - SetAlign(int a) - - - - - - GetLinkColor() -> Colour - - - SetLinkColor(Colour clr) - - - - - - GetActualColor() -> Colour - - - SetActualColor(Colour clr) - - - - - - SetLink(String link) - - - - - - CreateCurrentFont() -> Font - - - GetLink() -> HtmlLinkInfo - - - - - - __init__() -> HtmlTagHandler - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - SetParser(HtmlParser parser) - - - - - - GetParser() -> HtmlParser - - - ParseInner(HtmlTag tag) - - - - - - - - - __init__() -> HtmlWinTagHandler - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - SetParser(HtmlParser parser) - - - - - - GetParser() -> HtmlWinParser - - - ParseInner(HtmlTag tag) - - - - - - - HtmlWinParser_AddTagHandler(PyObject tagHandlerClass) - - - - - -#--------------------------------------------------------------------------- - - - - __init__() -> HtmlSelection - - - __del__() - - - Set(Point fromPos, HtmlCell fromCell, Point toPos, HtmlCell toCell) - - - - - - - - - SetCells(HtmlCell fromCell, HtmlCell toCell) - - - - - - - GetFromCell() -> HtmlCell - - - GetToCell() -> HtmlCell - - - GetFromPos() -> Point - - - GetToPos() -> Point - - - GetFromPrivPos() -> Point - - - GetToPrivPos() -> Point - - - SetFromPrivPos(Point pos) - - - - - - SetToPrivPos(Point pos) - - - - - - ClearPrivPos() - - - IsEmpty() -> bool - - - - - __init__() -> HtmlRenderingState - - - __del__() - - - SetSelectionState(int s) - - - - - - GetSelectionState() -> int - - - SetFgColour(Colour c) - - - - - - GetFgColour() -> Colour - - - SetBgColour(Colour c) - - - - - - GetBgColour() -> Colour - - - - - GetSelectedTextColour(Colour clr) -> Colour - - - - - - GetSelectedTextBgColour(Colour clr) -> Colour - - - - - - - - - GetSelectedTextColour(Colour clr) -> Colour - - - - - - GetSelectedTextBgColour(Colour clr) -> Colour - - - - - - - - __init__() -> HtmlRenderingInfo - - - __del__() - - - SetSelection(HtmlSelection s) - - - - - - GetSelection() -> HtmlSelection - - - SetStyle(HtmlRenderingStyle style) - - - - - - GetStyle() -> HtmlRenderingStyle - - - GetState() -> HtmlRenderingState - - - -#--------------------------------------------------------------------------- - - - - - __init__() -> HtmlCell - - - GetPosX() -> int - - - GetPosY() -> int - - - GetWidth() -> int - - - GetHeight() -> int - - - GetDescent() -> int - - - GetId() -> String - - - SetId(String id) - - - - - - GetLink(int x=0, int y=0) -> HtmlLinkInfo - - - - - - - GetNext() -> HtmlCell - - - GetParent() -> HtmlContainerCell - - - GetFirstChild() -> HtmlCell - - - GetCursor() -> Cursor - - - IsFormattingCell() -> bool - - - SetLink(HtmlLinkInfo link) - - - - - - SetNext(HtmlCell cell) - - - - - - SetParent(HtmlContainerCell p) - - - - - - SetPos(int x, int y) - - - - - - - Layout(int w) - - - - - - Draw(DC dc, int x, int y, int view_y1, int view_y2, HtmlRenderingInfo info) - - - - - - - - - - - DrawInvisible(DC dc, int x, int y, HtmlRenderingInfo info) - - - - - - - - - Find(int condition, void param) -> HtmlCell - - - - - - - AdjustPagebreak(int INOUT) -> bool - - - - - - SetCanLiveOnPagebreak(bool can) - - - - - - IsLinebreakAllowed() -> bool - - - IsTerminalCell() -> bool - - - FindCellByPos(int x, int y, unsigned int flags=HTML_FIND_EXACT) -> HtmlCell - - - - - - - - GetAbsPos() -> Point - - - GetFirstTerminal() -> HtmlCell - - - GetLastTerminal() -> HtmlCell - - - GetDepth() -> unsigned int - - - IsBefore(HtmlCell cell) -> bool - - - - - - ConvertToText(HtmlSelection sel) -> String - - - - - - - - - __init__(String word, DC dc) -> HtmlWordCell - - - - - - - - - - __init__(HtmlContainerCell parent) -> HtmlContainerCell - - - - - - InsertCell(HtmlCell cell) - - - - - - SetAlignHor(int al) - - - - - - GetAlignHor() -> int - - - SetAlignVer(int al) - - - - - - GetAlignVer() -> int - - - SetIndent(int i, int what, int units=HTML_UNITS_PIXELS) - - - - - - - - GetIndent(int ind) -> int - - - - - - GetIndentUnits(int ind) -> int - - - - - - SetAlign(HtmlTag tag) - - - - - - SetWidthFloat(int w, int units) - - - - - - - SetWidthFloatFromTag(HtmlTag tag) - - - - - - SetMinHeight(int h, int align=HTML_ALIGN_TOP) - - - - - - - SetBackgroundColour(Colour clr) - - - - - - GetBackgroundColour() -> Colour - - - SetBorder(Colour clr1, Colour clr2) - - - - - - - GetFirstChild() -> HtmlCell - - - - - - __init__(Colour clr, int flags=HTML_CLR_FOREGROUND) -> HtmlColourCell - - - - - - - - - - __init__(Font font) -> HtmlFontCell - - - - - - - - - __init__(Window wnd, int w=0) -> HtmlWidgetCell - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__() -> HtmlFilter - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, int style=HW_DEFAULT_STYLE, - String name=HtmlWindowNameStr) -> HtmlWindow - - - - - - - - - - - PreHtmlWindow() -> HtmlWindow - - - Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, int style=HW_SCROLLBAR_AUTO, - String name=HtmlWindowNameStr) -> bool - - - - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - SetPage(String source) -> bool - - - - - - LoadPage(String location) -> bool - - - - - - LoadFile(String filename) -> bool - - - - - - AppendToPage(String source) -> bool - - - - - - GetOpenedPage() -> String - - - GetOpenedAnchor() -> String - - - GetOpenedPageTitle() -> String - - - SetRelatedFrame(Frame frame, String format) - - - - - - - GetRelatedFrame() -> Frame - - - SetRelatedStatusBar(int bar) - - - - - - SetFonts(String normal_face, String fixed_face, PyObject sizes=None) - - - - - - - - SetTitle(String title) - - - - - - SetBorders(int b) - - - - - - ReadCustomization(ConfigBase cfg, String path=EmptyString) - - - - - - - WriteCustomization(ConfigBase cfg, String path=EmptyString) - - - - - - - HistoryBack() -> bool - - - HistoryForward() -> bool - - - HistoryCanBack() -> bool - - - HistoryCanForward() -> bool - - - HistoryClear() - - - GetInternalRepresentation() -> HtmlContainerCell - - - GetParser() -> HtmlWinParser - - - ScrollToAnchor(String anchor) -> bool - - - - - - HasAnchor(String anchor) -> bool - - - - - - HtmlWindow.AddFilter(HtmlFilter filter) - - - - - - base_OnLinkClicked(HtmlLinkInfo link) - - - - - - base_OnSetTitle(String title) - - - - - - base_OnCellMouseHover(HtmlCell cell, int x, int y) - - - - - - - - base_OnCellClicked(HtmlCell cell, int x, int y, MouseEvent event) - - - - - - - - - -#--------------------------------------------------------------------------- - - - - - __init__() -> HtmlDCRenderer - - - __del__() - - - SetDC(DC dc, int maxwidth) - - - - - - - SetSize(int width, int height) - - - - - - - SetHtmlText(String html, String basepath=EmptyString, bool isdir=True) - - - - - - - - SetFonts(String normal_face, String fixed_face, PyObject sizes=None) - - - - - - - - Render(int x, int y, int from=0, int dont_render=False, int to=INT_MAX, - int choices=None, int LCOUNT=0) -> int - - - - - - - - - - - - GetTotalHeight() -> int - - - - - - __init__(String title=HtmlPrintoutTitleStr) -> HtmlPrintout - - - - - - SetHtmlText(String html, String basepath=EmptyString, bool isdir=True) - - - - - - - - SetHtmlFile(String htmlfile) - - - - - - SetHeader(String header, int pg=PAGE_ALL) - - - - - - - SetFooter(String footer, int pg=PAGE_ALL) - - - - - - - SetFonts(String normal_face, String fixed_face, PyObject sizes=None) - - - - - - - - SetMargins(float top=25.2, float bottom=25.2, float left=25.2, - float right=25.2, float spaces=5) - - - - - - - - - - HtmlPrintout.AddFilter(wxHtmlFilter filter) - - - - - - HtmlPrintout.CleanUpStatics() - - - - - - __init__(String name=HtmlPrintingTitleStr, Window parentWindow=None) -> HtmlEasyPrinting - - - - - - - __del__() - - - PreviewFile(String htmlfile) - - - - - - PreviewText(String htmltext, String basepath=EmptyString) - - - - - - - PrintFile(String htmlfile) - - - - - - PrintText(String htmltext, String basepath=EmptyString) - - - - - - - PrinterSetup() - - - PageSetup() - - - SetHeader(String header, int pg=PAGE_ALL) - - - - - - - SetFooter(String footer, int pg=PAGE_ALL) - - - - - - - SetFonts(String normal_face, String fixed_face, PyObject sizes=None) - - - - - - - - GetPrintData() -> PrintData - - - GetPageSetupData() -> PageSetupDialogData - - - -#--------------------------------------------------------------------------- - - - - __init__(String bookfile, String basepath, String title, String start) -> HtmlBookRecord - - - - - - - - - GetBookFile() -> String - - - GetTitle() -> String - - - GetStart() -> String - - - GetBasePath() -> String - - - SetContentsRange(int start, int end) - - - - - - - GetContentsStart() -> int - - - GetContentsEnd() -> int - - - SetTitle(String title) - - - - - - SetBasePath(String path) - - - - - - SetStart(String start) - - - - - - GetFullPath(String page) -> String - - - - - - - - GetLevel() -> int - - - GetID() -> int - - - GetName() -> String - - - GetPage() -> String - - - GetBook() -> HtmlBookRecord - - - - - Search() -> bool - - - IsActive() -> bool - - - GetCurIndex() -> int - - - GetMaxIndex() -> int - - - GetName() -> String - - - GetContentsItem() -> HtmlContentsItem - - - - - __init__() -> HtmlHelpData - - - __del__() - - - SetTempDir(String path) - - - - - - AddBook(String book) -> bool - - - - - - FindPageByName(String page) -> String - - - - - - FindPageById(int id) -> String - - - - - - GetBookRecArray() -> wxHtmlBookRecArray - - - GetContents() -> HtmlContentsItem - - - GetContentsCnt() -> int - - - GetIndex() -> HtmlContentsItem - - - GetIndexCnt() -> int - - - - - - __init__(Window parent, int ??, String title=EmptyString, int style=HF_DEFAULTSTYLE, - HtmlHelpData data=None) -> HtmlHelpFrame - - - - - - - - - - GetData() -> HtmlHelpData - - - SetTitleFormat(String format) - - - - - - Display(String x) - - - - - - DisplayID(int id) - - - - - - DisplayContents() - - - DisplayIndex() - - - KeywordSearch(String keyword) -> bool - - - - - - UseConfig(ConfigBase config, String rootpath=EmptyString) - - - - - - - ReadCustomization(ConfigBase cfg, String path=EmptyString) - - - - - - - WriteCustomization(ConfigBase cfg, String path=EmptyString) - - - - - - - - - - __init__(int style=HF_DEFAULTSTYLE) -> HtmlHelpController - - - - - - __del__() - - - SetTitleFormat(String format) - - - - - - SetTempDir(String path) - - - - - - AddBook(String book, int show_wait_msg=False) -> bool - - - - - - - Display(String x) - - - - - - DisplayID(int id) - - - - - - DisplayContents() - - - DisplayIndex() - - - KeywordSearch(String keyword) -> bool - - - - - - UseConfig(ConfigBase config, String rootpath=EmptyString) - - - - - - - ReadCustomization(ConfigBase cfg, String path=EmptyString) - - - - - - - WriteCustomization(ConfigBase cfg, String path=EmptyString) - - - - - - - GetFrame() -> HtmlHelpFrame - - - - - wx = core - -EVT_WIZARD_PAGE_CHANGED = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGED, 1) -EVT_WIZARD_PAGE_CHANGING = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGING, 1) -EVT_WIZARD_CANCEL = wx.PyEventBinder( wxEVT_WIZARD_CANCEL, 1) -EVT_WIZARD_HELP = wx.PyEventBinder( wxEVT_WIZARD_HELP, 1) -EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) - - - - - __init__(wxEventType type=wxEVT_NULL, int id=-1, bool direction=True, - WizardPage page=None) -> WizardEvent - - - - - - - - - GetDirection() -> bool - - - GetPage() -> WizardPage - - - - - - Create(Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool - - - - - - - - GetPrev() -> WizardPage - - - GetNext() -> WizardPage - - - GetBitmap() -> Bitmap - - - - - - __init__(Wizard parent, Bitmap bitmap=&wxNullBitmap, String resource=&wxPyEmptyString) -> PyWizardPage - - - - - - - - PrePyWizardPage() -> PyWizardPage - - - Create(Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_DoMoveWindow(int x, int y, int width, int height) - - - - - - - - - base_DoSetSize(int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) - - - - - - - - - - base_DoSetClientSize(int width, int height) - - - - - - - base_DoSetVirtualSize(int x, int y) - - - - - - - base_DoGetSize() -> (width, height) - - - - - - - base_DoGetClientSize() -> (width, height) - - - - - - - base_DoGetPosition() -> (x,y) - - - - - - - base_DoGetVirtualSize() -> Size - - - base_DoGetBestSize() -> Size - - - base_InitDialog() - - - base_TransferDataToWindow() -> bool - - - base_TransferDataFromWindow() -> bool - - - base_Validate() -> bool - - - base_AcceptsFocus() -> bool - - - base_AcceptsFocusFromKeyboard() -> bool - - - base_GetMaxSize() -> Size - - - base_AddChild(Window child) - - - - - - base_RemoveChild(Window child) - - - - - - - - - __init__(Wizard parent, WizardPage prev=None, WizardPage next=None, - Bitmap bitmap=wxNullBitmap, wxChar resource=None) -> WizardPageSimple - - - - - - - - - - PreWizardPageSimple() -> WizardPageSimple - - - Create(Wizard parent=None, WizardPage prev=None, WizardPage next=None, - Bitmap bitmap=wxNullBitmap, wxChar resource=None) -> bool - - - - - - - - - - SetPrev(WizardPage prev) - - - - - - SetNext(WizardPage next) - - - - - - WizardPageSimple.Chain(WizardPageSimple first, WizardPageSimple second) - - - - - - - - - - __init__(Window parent, int id=-1, String title=EmptyString, - Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition, - long style=DEFAULT_DIALOG_STYLE) -> Wizard - - - - - - - - - - - PreWizard() -> Wizard - - - Create(Window parent, int id=-1, String title=EmptyString, - Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition) -> bool - - - - - - - - - - Init() - - - RunWizard(WizardPage firstPage) -> bool - - - - - - GetCurrentPage() -> WizardPage - - - SetPageSize(Size size) - - - - - - GetPageSize() -> Size - - - FitToPage(WizardPage firstPage) - - - - - - GetPageAreaSizer() -> Sizer - - - SetBorder(int border) - - - - - - IsRunning() -> bool - - - ShowPage(WizardPage page, bool goingForward=True) -> bool - - - - - - - HasNextPage(WizardPage page) -> bool - - - - - - HasPrevPage(WizardPage page) -> bool - - - - - - - - wx = core - - - - __init__(bool isRGB, GLCanvas win, wxPalette palette=wxNullPalette, - GLContext other=None) -> GLContext - - - - - - - - - __del__() - - - SetCurrent() - - - SetColour(String colour) - - - - - - SwapBuffers() - - - SetupPixelFormat() - - - SetupPalette(wxPalette palette) - - - - - - CreateDefaultPalette() -> wxPalette - - - GetPalette() -> wxPalette - - - GetWindow() -> Window - - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0, String name=GLCanvasNameStr, - int attribList=None, wxPalette palette=wxNullPalette) -> GLCanvas - - - - - - - - - - - - - wxGLCanvasWithContext(Window parent, GLContext shared=None, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, - long style=0, String name=GLCanvasNameStr, - int attribList=None, wxPalette palette=wxNullPalette) -> GLCanvas - - - - - - - - - - - - - - SetCurrent() - - - SetColour(String colour) - - - - - - SwapBuffers() - - - GetContext() -> GLContext - - - - - wx = core - -#--------------------------------------------------------------------------- - - - - - __init__() -> ShapeRegion - - - SetText(String s) - - - - - - SetFont(Font f) - - - - - - SetMinSize(double w, double h) - - - - - - - SetSize(double w, double h) - - - - - - - SetPosition(double x, double y) - - - - - - - SetProportions(double x, double y) - - - - - - - SetFormatMode(int mode) - - - - - - SetName(String s) - - - - - - SetColour(String col) - - - - - - GetText() -> String - - - GetFont() -> Font - - - GetMinSize(double OUTPUT, double OUTPUT) - - - - - - - GetProportion(double OUTPUT, double OUTPUT) - - - - - - - GetSize(double OUTPUT, double OUTPUT) - - - - - - - GetPosition(double OUTPUT, double OUTPUT) - - - - - - - GetFormatMode() -> int - - - GetName() -> String - - - GetColour() -> String - - - GetActualColourObject() -> Colour - - - GetFormattedText() -> wxList - - - GetPenColour() -> String - - - GetPenStyle() -> int - - - SetPenStyle(int style) - - - - - - SetPenColour(String col) - - - - - - GetActualPen() -> wxPen - - - GetWidth() -> double - - - GetHeight() -> double - - - ClearText() - - - - - - __init__(PyShapeEvtHandler prev=None, PyShape shape=None) -> PyShapeEvtHandler - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - _setOORInfo(PyObject _self) - - - - - - SetShape(PyShape sh) - - - - - - GetShape() -> PyShape - - - SetPreviousHandler(PyShapeEvtHandler handler) - - - - - - GetPreviousHandler() -> PyShapeEvtHandler - - - CreateNewCopy() -> PyShapeEvtHandler - - - base_OnDelete() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=False) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__(PyShapeCanvas can=None) -> PyShape - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - GetBoundingBoxMax(double OUTPUT, double OUTPUT) - - - - - - - GetBoundingBoxMin(double OUTPUT, double OUTPUT) - - - - - - - GetPerimeterPoint(double x1, double y1, double x2, double y2, double OUTPUT, - double OUTPUT) -> bool - - - - - - - - - - - GetCanvas() -> PyShapeCanvas - - - SetCanvas(PyShapeCanvas the_canvas) - - - - - - AddToCanvas(PyShapeCanvas the_canvas, PyShape addAfter=None) - - - - - - - InsertInCanvas(PyShapeCanvas the_canvas) - - - - - - RemoveFromCanvas(PyShapeCanvas the_canvas) - - - - - - GetX() -> double - - - GetY() -> double - - - SetX(double x) - - - - - - SetY(double y) - - - - - - GetParent() -> PyShape - - - SetParent(PyShape p) - - - - - - GetTopAncestor() -> PyShape - - - GetChildren() -> PyObject - - - Unlink() - - - SetDrawHandles(bool drawH) - - - - - - GetDrawHandles() -> bool - - - MakeControlPoints() - - - DeleteControlPoints(DC dc=None) - - - - - - ResetControlPoints() - - - GetEventHandler() -> PyShapeEvtHandler - - - SetEventHandler(PyShapeEvtHandler handler) - - - - - - MakeMandatoryControlPoints() - - - ResetMandatoryControlPoints() - - - Recompute() -> bool - - - CalculateSize() - - - Select(bool select=True, DC dc=None) - - - - - - - SetHighlight(bool hi=True, bool recurse=False) - - - - - - - IsHighlighted() -> bool - - - Selected() -> bool - - - AncestorSelected() -> bool - - - SetSensitivityFilter(int sens=OP_ALL, bool recursive=False) - - - - - - - GetSensitivityFilter() -> int - - - SetDraggable(bool drag, bool recursive=False) - - - - - - - SetFixedSize(bool x, bool y) - - - - - - - GetFixedSize(bool OUTPUT, bool OUTPUT) - - - - - - - GetFixedWidth() -> bool - - - GetFixedHeight() -> bool - - - SetSpaceAttachments(bool sp) - - - - - - GetSpaceAttachments() -> bool - - - SetShadowMode(int mode, bool redraw=False) - - - - - - - GetShadowMode() -> int - - - HitTest(double x, double y, int OUTPUT, double OUTPUT) -> bool - - - - - - - - - SetCentreResize(bool cr) - - - - - - GetCentreResize() -> bool - - - SetMaintainAspectRatio(bool ar) - - - - - - GetMaintainAspectRatio() -> bool - - - GetLines() -> PyObject - - - SetDisableLabel(bool flag) - - - - - - GetDisableLabel() -> bool - - - SetAttachmentMode(int mode) - - - - - - GetAttachmentMode() -> int - - - SetId(long i) - - - - - - GetId() -> long - - - SetPen(wxPen pen) - - - - - - SetBrush(wxBrush brush) - - - - - - Show(bool show) - - - - - - IsShown() -> bool - - - Move(DC dc, double x1, double y1, bool display=True) - - - - - - - - - Erase(DC dc) - - - - - - EraseContents(DC dc) - - - - - - Draw(DC dc) - - - - - - Flash() - - - MoveLinks(DC dc) - - - - - - DrawContents(DC dc) - - - - - - SetSize(double x, double y, bool recursive=True) - - - - - - - - SetAttachmentSize(double x, double y) - - - - - - - Attach(PyShapeCanvas can) - - - - - - Detach() - - - Constrain() -> bool - - - AddLine(PyLineShape line, PyShape other, int attachFrom=0, - int attachTo=0, int positionFrom=-1, int positionTo=-1) - - - - - - - - - - - GetLinePosition(PyLineShape line) -> int - - - - - - AddText(String string) - - - - - - GetPen() -> wxPen - - - GetBrush() -> wxBrush - - - SetDefaultRegionSize() - - - FormatText(DC dc, String s, int regionId=0) - - - - - - - - SetFormatMode(int mode, int regionId=0) - - - - - - - GetFormatMode(int regionId=0) -> int - - - - - - SetFont(Font font, int regionId=0) - - - - - - - GetFont(int regionId=0) -> Font - - - - - - SetTextColour(String colour, int regionId=0) - - - - - - - GetTextColour(int regionId=0) -> String - - - - - - GetNumberOfTextRegions() -> int - - - SetRegionName(String name, int regionId=0) - - - - - - - GetRegionName(int regionId) -> String - - - - - - GetRegionId(String name) -> int - - - - - - NameRegions(String parentName=EmptyString) - - - - - - GetRegions() -> PyObject - - - AddRegion(ShapeRegion region) - - - - - - ClearRegions() - - - AssignNewIds() - - - FindRegion(String regionName, int OUTPUT) -> PyShape - - - - - - - FindRegionNames(wxStringList list) - - - - - - ClearText(int regionId=0) - - - - - - RemoveLine(PyLineShape line) - - - - - - GetAttachmentPosition(int attachment, double OUTPUT, double OUTPUT, int nth=0, - int no_arcs=1, PyLineShape line=None) -> bool - - - - - - - - - - - GetNumberOfAttachments() -> int - - - AttachmentIsValid(int attachment) -> bool - - - - - - GetAttachmentPositionEdge(int attachment, double OUTPUT, double OUTPUT, int nth=0, - int no_arcs=1, PyLineShape line=None) -> bool - - - - - - - - - - - CalcSimpleAttachment(RealPoint pt1, RealPoint pt2, int nth, int noArcs, - PyLineShape line) -> RealPoint - - - - - - - - - - AttachmentSortTest(int attachmentPoint, RealPoint pt1, RealPoint pt2) -> bool - - - - - - - - EraseLinks(DC dc, int attachment=-1, bool recurse=False) - - - - - - - - DrawLinks(DC dc, int attachment=-1, bool recurse=False) - - - - - - - - MoveLineToNewAttachment(DC dc, PyLineShape to_move, double x, double y) -> bool - - - - - - - - - ApplyAttachmentOrdering(PyObject linesToSort) - - - - - - GetBranchingAttachmentRoot(int attachment) -> RealPoint - - - - - - GetBranchingAttachmentInfo(int attachment, RealPoint root, RealPoint neck, RealPoint shoulder1, - RealPoint shoulder2) -> bool - - - - - - - - - - GetBranchingAttachmentPoint(int attachment, int n, RealPoint attachmentPoint, RealPoint stemPoint) -> bool - - - - - - - - - GetAttachmentLineCount(int attachment) -> int - - - - - - SetBranchNeckLength(int len) - - - - - - GetBranchNeckLength() -> int - - - SetBranchStemLength(int len) - - - - - - GetBranchStemLength() -> int - - - SetBranchSpacing(int len) - - - - - - GetBranchSpacing() -> int - - - SetBranchStyle(long style) - - - - - - GetBranchStyle() -> long - - - PhysicalToLogicalAttachment(int physicalAttachment) -> int - - - - - - LogicalToPhysicalAttachment(int logicalAttachment) -> int - - - - - - Draggable() -> bool - - - HasDescendant(PyShape image) -> bool - - - - - - CreateNewCopy(bool resetMapping=True, bool recompute=True) -> PyShape - - - - - - - Copy(PyShape copy) - - - - - - CopyWithHandler(PyShape copy) - - - - - - Rotate(double x, double y, double theta) - - - - - - - - GetRotation() -> double - - - ClearAttachments() - - - Recentre(DC dc) - - - - - - ClearPointList(wxList list) - - - - - - GetBackgroundPen() -> wxPen - - - GetBackgroundBrush() -> wxBrush - - - base_OnDelete() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=False) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__() -> PseudoMetaFile - - - __del__() - - - Draw(DC dc, double xoffset, double yoffset) - - - - - - - - Clear() - - - Copy(PseudoMetaFile copy) - - - - - - Scale(double sx, double sy) - - - - - - - ScaleTo(double w, double h) - - - - - - - Translate(double x, double y) - - - - - - - Rotate(double x, double y, double theta) - - - - - - - - LoadFromMetaFile(String filename, double width, double height) -> bool - - - - - - - - GetBounds(double minX, double minY, double maxX, double maxY) - - - - - - - - - CalculateSize(PyDrawnShape shape) - - - - - - SetRotateable(bool rot) - - - - - - GetRotateable() -> bool - - - SetSize(double w, double h) - - - - - - - SetFillBrush(wxBrush brush) - - - - - - GetFillBrush() -> wxBrush - - - SetOutlinePen(wxPen pen) - - - - - - GetOutlinePen() -> wxPen - - - SetOutlineOp(int op) - - - - - - GetOutlineOp() -> int - - - IsValid() -> bool - - - DrawLine(Point pt1, Point pt2) - - - - - - - DrawRectangle(Rect rect) - - - - - - DrawRoundedRectangle(Rect rect, double radius) - - - - - - - DrawArc(Point centrePt, Point startPt, Point endPt) - - - - - - - - DrawEllipticArc(Rect rect, double startAngle, double endAngle) - - - - - - - - DrawEllipse(Rect rect) - - - - - - DrawPoint(Point pt) - - - - - - DrawText(String text, Point pt) - - - - - - - DrawLines(int PCOUNT, Point points) - - - - - - - DrawPolygon(int PCOUNT, Point points, int flags=0) - - - - - - - - DrawSpline(int PCOUNT, Point points) - - - - - - - SetClippingRect(Rect rect) - - - - - - DestroyClippingRect() - - - SetPen(wxPen pen, bool isOutline=FALSE) - - - - - - - SetBrush(wxBrush brush, bool isFill=FALSE) - - - - - - - SetFont(Font font) - - - - - - SetTextColour(Colour colour) - - - - - - SetBackgroundColour(Colour colour) - - - - - - SetBackgroundMode(int mode) - - - - - - - - - __init__(double width=0.0, double height=0.0) -> PyRectangleShape - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - SetCornerRadius(double radius) - - - - - - base_OnDelete() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__(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 - - - - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - SetCornerRadius(double radius) - - - - - - base_OnDelete() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__() -> PyBitmapShape - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - GetBitmap() -> Bitmap - - - GetFilename() -> String - - - SetBitmap(Bitmap bitmap) - - - - - - SetFilename(String filename) - - - - - - base_OnDelete() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__() -> PyDrawnShape - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - CalculateSize() - - - DestroyClippingRect() - - - DrawArc(Point centrePoint, Point startPoint, Point endPoint) - - - - - - - - DrawAtAngle(int angle) - - - - - - DrawEllipticArc(Rect rect, double startAngle, double endAngle) - - - - - - - - DrawLine(Point point1, Point point2) - - - - - - - DrawLines(int PCOUNT, Point points) - - - - - - - DrawPoint(Point point) - - - - - - DrawPolygon(int PCOUNT, Point points, int flags=0) - - - - - - - - DrawRectangle(Rect rect) - - - - - - DrawRoundedRectangle(Rect rect, double radius) - - - - - - - DrawSpline(int PCOUNT, Point points) - - - - - - - DrawText(String text, Point point) - - - - - - - GetAngle() -> int - - - GetMetaFile() -> PseudoMetaFile - - - GetRotation() -> double - - - LoadFromMetaFile(String filename) -> bool - - - - - - Rotate(double x, double y, double theta) - - - - - - - - SetClippingRect(Rect rect) - - - - - - SetDrawnBackgroundColour(Colour colour) - - - - - - SetDrawnBackgroundMode(int mode) - - - - - - SetDrawnBrush(wxBrush pen, bool isOutline=FALSE) - - - - - - - SetDrawnFont(Font font) - - - - - - SetDrawnPen(wxPen pen, bool isOutline=FALSE) - - - - - - - SetDrawnTextColour(Colour colour) - - - - - - Scale(double sx, double sy) - - - - - - - SetSaveToFile(bool save) - - - - - - Translate(double x, double y) - - - - - - - base_OnDelete() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__(int type, PyShape constraining, PyObject constrained) -> OGLConstraint - - - - - - - - Evaluate() -> bool - - - SetSpacing(double x, double y) - - - - - - - Equals(double a, double b) -> bool - - - - - - - - - - __init__() -> PyCompositeShape - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - AddChild(PyShape child, PyShape addAfter=None) - - - - - - - AddConstraint(OGLConstraint constraint) -> OGLConstraint - - - - - - AddConstrainedShapes(int type, PyShape constraining, PyObject constrained) -> OGLConstraint - - - - - - - - AddSimpleConstraint(int type, PyShape constraining, PyShape constrained) -> OGLConstraint - - - - - - - - CalculateSize() - - - ContainsDivision(PyDivisionShape division) -> bool - - - - - - DeleteConstraint(OGLConstraint constraint) - - - - - - DeleteConstraintsInvolvingChild(PyShape child) - - - - - - FindContainerImage() -> PyShape - - - GetConstraints() -> PyObject - - - GetDivisions() -> PyObject - - - MakeContainer() - - - Recompute() -> bool - - - RemoveChild(PyShape child) - - - - - - base_OnDelete() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__(double width=0.0, double height=0.0) -> PyDividedShape - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - EditRegions() - - - SetRegionSizes() - - - base_OnDelete() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__() -> PyDivisionShape - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - AdjustBottom(double bottom, bool test) - - - - - - - AdjustLeft(double left, bool test) - - - - - - - AdjustRight(double right, bool test) - - - - - - - AdjustTop(double top, bool test) - - - - - - - Divide(int direction) - - - - - - EditEdge(int side) - - - - - - GetBottomSide() -> PyDivisionShape - - - GetHandleSide() -> int - - - GetLeftSide() -> PyDivisionShape - - - GetLeftSideColour() -> String - - - GetLeftSidePen() -> wxPen - - - GetRightSide() -> PyDivisionShape - - - GetTopSide() -> PyDivisionShape - - - GetTopSidePen() -> wxPen - - - ResizeAdjoining(int side, double newPos, bool test) - - - - - - - - PopupMenu(double x, double y) - - - - - - - SetBottomSide(PyDivisionShape shape) - - - - - - SetHandleSide(int side) - - - - - - SetLeftSide(PyDivisionShape shape) - - - - - - SetLeftSideColour(String colour) - - - - - - SetLeftSidePen(wxPen pen) - - - - - - SetRightSide(PyDivisionShape shape) - - - - - - SetTopSide(PyDivisionShape shape) - - - - - - SetTopSideColour(String colour) - - - - - - SetTopSidePen(wxPen pen) - - - - - - base_OnDelete() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__(double width=0.0, double height=0.0) -> PyEllipseShape - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__(double width=0.0) -> PyCircleShape - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__(int type=0, int end=0, double size=0.0, double dist=0.0, - String name=EmptyString, PseudoMetaFile mf=None, - long arrowId=-1) -> ArrowHead - - - - - - - - - - - - __del__() - - - _GetType() -> int - - - GetPosition() -> int - - - SetPosition(int pos) - - - - - - GetXOffset() -> double - - - GetYOffset() -> double - - - GetSpacing() -> double - - - GetSize() -> double - - - GetName() -> String - - - SetXOffset(double x) - - - - - - SetYOffset(double y) - - - - - - GetMetaFile() -> PseudoMetaFile - - - GetId() -> long - - - GetArrowEnd() -> int - - - GetArrowSize() -> double - - - SetSize(double size) - - - - - - SetSpacing(double sp) - - - - - - - - - __init__() -> PyLineShape - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - AddArrow(int type, int end=ARROW_POSITION_END, double arrowSize=10.0, - double xOffset=0.0, String name=EmptyString, - PseudoMetaFile mf=None, long arrowId=-1) - - - - - - - - - - - - AddArrowOrdered(ArrowHead arrow, PyObject referenceList, int end) - - - - - - - - ClearArrow(String name) -> bool - - - - - - ClearArrowsAtPosition(int position=-1) - - - - - - DrawArrow(DC dc, ArrowHead arrow, double xOffset, bool proportionalOffset) - - - - - - - - - DeleteArrowHeadId(long arrowId) -> bool - - - - - - DeleteArrowHead(int position, String name) -> bool - - - - - - - DeleteLineControlPoint() -> bool - - - DrawArrows(DC dc) - - - - - - DrawRegion(DC dc, ShapeRegion region, double x, double y) - - - - - - - - - EraseRegion(DC dc, ShapeRegion region, double x, double y) - - - - - - - - - FindArrowHeadId(long arrowId) -> ArrowHead - - - - - - FindArrowHead(int position, String name) -> ArrowHead - - - - - - - FindLineEndPoints(double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT) - - - - - - - - - FindLinePosition(double x, double y) -> int - - - - - - - FindMinimumWidth() -> double - - - FindNth(PyShape image, int OUTPUT, int OUTPUT, bool incoming) - - - - - - - - - GetAttachmentFrom() -> int - - - GetAttachmentTo() -> int - - - GetEnds(double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT) - - - - - - - - - GetFrom() -> PyShape - - - GetLabelPosition(int position, double OUTPUT, double OUTPUT) - - - - - - - - GetNextControlPoint(PyShape shape) -> RealPoint - - - - - - GetTo() -> PyShape - - - Initialise() - - - InsertLineControlPoint(DC dc) - - - - - - IsEnd(PyShape shape) -> bool - - - - - - IsSpline() -> bool - - - MakeLineControlPoints(int n) - - - - - - GetLineControlPoints() -> PyObject - - - SetAttachmentFrom(int fromAttach) - - - - - - SetAttachments(int fromAttach, int toAttach) - - - - - - - SetAttachmentTo(int toAttach) - - - - - - SetEnds(double x1, double y1, double x2, double y2) - - - - - - - - - SetFrom(PyShape object) - - - - - - SetIgnoreOffsets(bool ignore) - - - - - - SetSpline(bool spline) - - - - - - SetTo(PyShape object) - - - - - - Straighten(DC dc=None) - - - - - - Unlink() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__() -> PyPolygonShape - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - Create(PyObject points) -> PyObject - - - - - - AddPolygonPoint(int pos=0) - - - - - - CalculatePolygonCentre() - - - DeletePolygonPoint(int pos=0) - - - - - - GetPoints() -> PyObject - - - UpdateOriginalPoints() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__(double width=0.0, double height=0.0) -> PyTextShape - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - base_OnDelete() - - - base_OnDraw(DC dc) - - - - - - base_OnDrawContents(DC dc) - - - - - - base_OnDrawBranches(DC dc, bool erase=FALSE) - - - - - - - base_OnMoveLinks(DC dc) - - - - - - base_OnErase(DC dc) - - - - - - base_OnEraseContents(DC dc) - - - - - - base_OnHighlight(DC dc) - - - - - - base_OnLeftClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnLeftDoubleClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnRightClick(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnSize(double x, double y) - - - - - - - base_OnMovePre(DC dc, double x, double y, double old_x, double old_y, - bool display=True) -> bool - - - - - - - - - - - base_OnMovePost(DC dc, double x, double y, double old_x, double old_y, - bool display=True) - - - - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0, int attachment=0) - - - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0, int attachment=0) - - - - - - - - - base_OnDrawOutline(DC dc, double x, double y, double w, double h) - - - - - - - - - - base_OnDrawControlPoints(DC dc) - - - - - - base_OnEraseControlPoints(DC dc) - - - - - - base_OnMoveLink(DC dc, bool moveControlPoints=True) - - - - - - - base_OnSizingDragLeft(PyControlPoint pt, bool draw, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - - base_OnSizingBeginDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnSizingEndDragLeft(PyControlPoint pt, double x, double y, int keys=0, - int attachment=0) - - - - - - - - - - base_OnBeginSize(double w, double h) - - - - - - - base_OnEndSize(double w, double h) - - - - - - - - - - __init__() -> Diagram - - - AddShape(PyShape shape, PyShape addAfter=None) - - - - - - - Clear(DC dc) - - - - - - DeleteAllShapes() - - - DrawOutline(DC dc, double x1, double y1, double x2, double y2) - - - - - - - - - - FindShape(long id) -> PyShape - - - - - - GetCanvas() -> PyShapeCanvas - - - GetCount() -> int - - - GetGridSpacing() -> double - - - GetMouseTolerance() -> int - - - GetShapeList() -> PyObject - - - GetQuickEditMode() -> bool - - - GetSnapToGrid() -> bool - - - InsertShape(PyShape shape) - - - - - - RecentreAll(DC dc) - - - - - - Redraw(DC dc) - - - - - - RemoveAllShapes() - - - RemoveShape(PyShape shape) - - - - - - SetCanvas(PyShapeCanvas canvas) - - - - - - SetGridSpacing(double spacing) - - - - - - SetMouseTolerance(int tolerance) - - - - - - SetQuickEditMode(bool mode) - - - - - - SetSnapToGrid(bool snap) - - - - - - ShowAll(bool show) - - - - - - Snap(double INOUT, double INOUT) - - - - - - - - - - __init__(Window parent=None, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=BORDER, - String name=wxPyShapeCanvasNameStr) -> PyShapeCanvas - - - - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - AddShape(PyShape shape, PyShape addAfter=None) - - - - - - - FindShape(double x1, double y, int OUTPUT, wxClassInfo info=None, - PyShape notImage=None) -> PyShape - - - - - - - - - - FindFirstSensitiveShape(double x1, double y, int OUTPUT, int op) -> PyShape - - - - - - - - - GetDiagram() -> Diagram - - - GetQuickEditMode() -> bool - - - InsertShape(PyShape shape) - - - - - - base_OnBeginDragLeft(double x, double y, int keys=0) - - - - - - - - base_OnBeginDragRight(double x, double y, int keys=0) - - - - - - - - base_OnEndDragLeft(double x, double y, int keys=0) - - - - - - - - base_OnEndDragRight(double x, double y, int keys=0) - - - - - - - - base_OnDragLeft(bool draw, double x, double y, int keys=0) - - - - - - - - - base_OnDragRight(bool draw, double x, double y, int keys=0) - - - - - - - - - base_OnLeftClick(double x, double y, int keys=0) - - - - - - - - base_OnRightClick(double x, double y, int keys=0) - - - - - - - - Redraw(DC dc) - - - - - - RemoveShape(PyShape shape) - - - - - - SetDiagram(Diagram diagram) - - - - - - Snap(double INOUT, double INOUT) - - - - - - - -# Aliases -ShapeCanvas = PyShapeCanvas -ShapeEvtHandler = PyShapeEvtHandler -Shape = PyShape -RectangleShape = PyRectangleShape -BitmapShape = PyBitmapShape -DrawnShape = PyDrawnShape -CompositeShape = PyCompositeShape -DividedShape = PyDividedShape -DivisionShape = PyDivisionShape -EllipseShape = PyEllipseShape -CircleShape = PyCircleShape -LineShape = PyLineShape -PolygonShape = PyPolygonShape -TextShape = PyTextShape -ControlPoint = PyControlPoint - - - OGLInitialize() - - - OGLCleanUp() - - - - wx = core - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=STCNameStr) -> StyledTextCtrl - - - - - - - - - - - PreStyledTextCtrl() -> StyledTextCtrl - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=0, String name=wxSTCNameStr) - - - - - - - - - - - AddText(String text) - - - - - - AddStyledText(wxMemoryBuffer data) - - - - - - InsertText(int pos, String text) - - - - - - - ClearAll() - - - ClearDocumentStyle() - - - GetLength() -> int - - - GetCharAt(int pos) -> int - - - - - - GetCurrentPos() -> int - - - GetAnchor() -> int - - - GetStyleAt(int pos) -> int - - - - - - Redo() - - - SetUndoCollection(bool collectUndo) - - - - - - SelectAll() - - - SetSavePoint() - - - GetStyledText(int startPos, int endPos) -> wxMemoryBuffer - - - - - - - CanRedo() -> bool - - - MarkerLineFromHandle(int handle) -> int - - - - - - MarkerDeleteHandle(int handle) - - - - - - GetUndoCollection() -> bool - - - GetViewWhiteSpace() -> int - - - SetViewWhiteSpace(int viewWS) - - - - - - PositionFromPoint(Point pt) -> int - - - - - - PositionFromPointClose(int x, int y) -> int - - - - - - - GotoLine(int line) - - - - - - GotoPos(int pos) - - - - - - SetAnchor(int posAnchor) - - - - - - GetCurLine(int OUTPUT) -> String - - - - - - GetEndStyled() -> int - - - ConvertEOLs(int eolMode) - - - - - - GetEOLMode() -> int - - - SetEOLMode(int eolMode) - - - - - - StartStyling(int pos, int mask) - - - - - - - SetStyling(int length, int style) - - - - - - - GetBufferedDraw() -> bool - - - SetBufferedDraw(bool buffered) - - - - - - SetTabWidth(int tabWidth) - - - - - - GetTabWidth() -> int - - - SetCodePage(int codePage) - - - - - - MarkerDefine(int markerNumber, int markerSymbol, Colour foreground=wxNullColour, - Colour background=wxNullColour) - - - - - - - - - MarkerSetForeground(int markerNumber, Colour fore) - - - - - - - MarkerSetBackground(int markerNumber, Colour back) - - - - - - - MarkerAdd(int line, int markerNumber) -> int - - - - - - - MarkerDelete(int line, int markerNumber) - - - - - - - MarkerDeleteAll(int markerNumber) - - - - - - MarkerGet(int line) -> int - - - - - - MarkerNext(int lineStart, int markerMask) -> int - - - - - - - MarkerPrevious(int lineStart, int markerMask) -> int - - - - - - - MarkerDefineBitmap(int markerNumber, Bitmap bmp) - - - - - - - SetMarginType(int margin, int marginType) - - - - - - - GetMarginType(int margin) -> int - - - - - - SetMarginWidth(int margin, int pixelWidth) - - - - - - - GetMarginWidth(int margin) -> int - - - - - - SetMarginMask(int margin, int mask) - - - - - - - GetMarginMask(int margin) -> int - - - - - - SetMarginSensitive(int margin, bool sensitive) - - - - - - - GetMarginSensitive(int margin) -> bool - - - - - - StyleClearAll() - - - StyleSetForeground(int style, Colour fore) - - - - - - - StyleSetBackground(int style, Colour back) - - - - - - - StyleSetBold(int style, bool bold) - - - - - - - StyleSetItalic(int style, bool italic) - - - - - - - StyleSetSize(int style, int sizePoints) - - - - - - - StyleSetFaceName(int style, String fontName) - - - - - - - StyleSetEOLFilled(int style, bool filled) - - - - - - - StyleResetDefault() - - - StyleSetUnderline(int style, bool underline) - - - - - - - StyleSetCase(int style, int caseForce) - - - - - - - StyleSetCharacterSet(int style, int characterSet) - - - - - - - StyleSetHotSpot(int style, bool hotspot) - - - - - - - SetSelForeground(bool useSetting, Colour fore) - - - - - - - SetSelBackground(bool useSetting, Colour back) - - - - - - - SetCaretForeground(Colour fore) - - - - - - CmdKeyAssign(int key, int modifiers, int cmd) - - - - - - - - CmdKeyClear(int key, int modifiers) - - - - - - - CmdKeyClearAll() - - - SetStyleBytes(int length, char styleBytes) - - - - - - - StyleSetVisible(int style, bool visible) - - - - - - - GetCaretPeriod() -> int - - - SetCaretPeriod(int periodMilliseconds) - - - - - - SetWordChars(String characters) - - - - - - BeginUndoAction() - - - EndUndoAction() - - - IndicatorSetStyle(int indic, int style) - - - - - - - IndicatorGetStyle(int indic) -> int - - - - - - IndicatorSetForeground(int indic, Colour fore) - - - - - - - IndicatorGetForeground(int indic) -> Colour - - - - - - SetWhitespaceForeground(bool useSetting, Colour fore) - - - - - - - SetWhitespaceBackground(bool useSetting, Colour back) - - - - - - - SetStyleBits(int bits) - - - - - - GetStyleBits() -> int - - - SetLineState(int line, int state) - - - - - - - GetLineState(int line) -> int - - - - - - GetMaxLineState() -> int - - - GetCaretLineVisible() -> bool - - - SetCaretLineVisible(bool show) - - - - - - GetCaretLineBack() -> Colour - - - SetCaretLineBack(Colour back) - - - - - - StyleSetChangeable(int style, bool changeable) - - - - - - - AutoCompShow(int lenEntered, String itemList) - - - - - - - AutoCompCancel() - - - AutoCompActive() -> bool - - - AutoCompPosStart() -> int - - - AutoCompComplete() - - - AutoCompStops(String characterSet) - - - - - - AutoCompSetSeparator(int separatorCharacter) - - - - - - AutoCompGetSeparator() -> int - - - AutoCompSelect(String text) - - - - - - AutoCompSetCancelAtStart(bool cancel) - - - - - - AutoCompGetCancelAtStart() -> bool - - - AutoCompSetFillUps(String characterSet) - - - - - - AutoCompSetChooseSingle(bool chooseSingle) - - - - - - AutoCompGetChooseSingle() -> bool - - - AutoCompSetIgnoreCase(bool ignoreCase) - - - - - - AutoCompGetIgnoreCase() -> bool - - - UserListShow(int listType, String itemList) - - - - - - - AutoCompSetAutoHide(bool autoHide) - - - - - - AutoCompGetAutoHide() -> bool - - - AutoCompSetDropRestOfWord(bool dropRestOfWord) - - - - - - AutoCompGetDropRestOfWord() -> bool - - - RegisterImage(int type, Bitmap bmp) - - - - - - - ClearRegisteredImages() - - - AutoCompGetTypeSeparator() -> int - - - AutoCompSetTypeSeparator(int separatorCharacter) - - - - - - SetIndent(int indentSize) - - - - - - GetIndent() -> int - - - SetUseTabs(bool useTabs) - - - - - - GetUseTabs() -> bool - - - SetLineIndentation(int line, int indentSize) - - - - - - - GetLineIndentation(int line) -> int - - - - - - GetLineIndentPosition(int line) -> int - - - - - - GetColumn(int pos) -> int - - - - - - SetUseHorizontalScrollBar(bool show) - - - - - - GetUseHorizontalScrollBar() -> bool - - - SetIndentationGuides(bool show) - - - - - - GetIndentationGuides() -> bool - - - SetHighlightGuide(int column) - - - - - - GetHighlightGuide() -> int - - - GetLineEndPosition(int line) -> int - - - - - - GetCodePage() -> int - - - GetCaretForeground() -> Colour - - - GetReadOnly() -> bool - - - SetCurrentPos(int pos) - - - - - - SetSelectionStart(int pos) - - - - - - GetSelectionStart() -> int - - - SetSelectionEnd(int pos) - - - - - - GetSelectionEnd() -> int - - - SetPrintMagnification(int magnification) - - - - - - GetPrintMagnification() -> int - - - SetPrintColourMode(int mode) - - - - - - GetPrintColourMode() -> int - - - FindText(int minPos, int maxPos, String text, int flags=0) -> int - - - - - - - - - FormatRange(bool doDraw, int startPos, int endPos, DC draw, DC target, - Rect renderRect, Rect pageRect) -> int - - - - - - - - - - - - GetFirstVisibleLine() -> int - - - GetLine(int line) -> String - - - - - - GetLineCount() -> int - - - SetMarginLeft(int pixelWidth) - - - - - - GetMarginLeft() -> int - - - SetMarginRight(int pixelWidth) - - - - - - GetMarginRight() -> int - - - GetModify() -> bool - - - SetSelection(int start, int end) - - - - - - - GetSelectedText() -> String - - - GetTextRange(int startPos, int endPos) -> String - - - - - - - HideSelection(bool normal) - - - - - - LineFromPosition(int pos) -> int - - - - - - PositionFromLine(int line) -> int - - - - - - LineScroll(int columns, int lines) - - - - - - - EnsureCaretVisible() - - - ReplaceSelection(String text) - - - - - - SetReadOnly(bool readOnly) - - - - - - CanPaste() -> bool - - - CanUndo() -> bool - - - EmptyUndoBuffer() - - - Undo() - - - Cut() - - - Copy() - - - Paste() - - - Clear() - - - SetText(String text) - - - - - - GetText() -> String - - - GetTextLength() -> int - - - SetOvertype(bool overtype) - - - - - - GetOvertype() -> bool - - - SetCaretWidth(int pixelWidth) - - - - - - GetCaretWidth() -> int - - - SetTargetStart(int pos) - - - - - - GetTargetStart() -> int - - - SetTargetEnd(int pos) - - - - - - GetTargetEnd() -> int - - - ReplaceTarget(String text) -> int - - - - - - ReplaceTargetRE(String text) -> int - - - - - - SearchInTarget(String text) -> int - - - - - - SetSearchFlags(int flags) - - - - - - GetSearchFlags() -> int - - - CallTipShow(int pos, String definition) - - - - - - - CallTipCancel() - - - CallTipActive() -> bool - - - CallTipPosAtStart() -> int - - - CallTipSetHighlight(int start, int end) - - - - - - - CallTipSetBackground(Colour back) - - - - - - CallTipSetForeground(Colour fore) - - - - - - CallTipSetForegroundHighlight(Colour fore) - - - - - - VisibleFromDocLine(int line) -> int - - - - - - DocLineFromVisible(int lineDisplay) -> int - - - - - - SetFoldLevel(int line, int level) - - - - - - - GetFoldLevel(int line) -> int - - - - - - GetLastChild(int line, int level) -> int - - - - - - - GetFoldParent(int line) -> int - - - - - - ShowLines(int lineStart, int lineEnd) - - - - - - - HideLines(int lineStart, int lineEnd) - - - - - - - GetLineVisible(int line) -> bool - - - - - - SetFoldExpanded(int line, bool expanded) - - - - - - - GetFoldExpanded(int line) -> bool - - - - - - ToggleFold(int line) - - - - - - EnsureVisible(int line) - - - - - - SetFoldFlags(int flags) - - - - - - EnsureVisibleEnforcePolicy(int line) - - - - - - SetTabIndents(bool tabIndents) - - - - - - GetTabIndents() -> bool - - - SetBackSpaceUnIndents(bool bsUnIndents) - - - - - - GetBackSpaceUnIndents() -> bool - - - SetMouseDwellTime(int periodMilliseconds) - - - - - - GetMouseDwellTime() -> int - - - WordStartPosition(int pos, bool onlyWordCharacters) -> int - - - - - - - WordEndPosition(int pos, bool onlyWordCharacters) -> int - - - - - - - SetWrapMode(int mode) - - - - - - GetWrapMode() -> int - - - SetLayoutCache(int mode) - - - - - - GetLayoutCache() -> int - - - SetScrollWidth(int pixelWidth) - - - - - - GetScrollWidth() -> int - - - TextWidth(int style, String text) -> int - - - - - - - SetEndAtLastLine(bool endAtLastLine) - - - - - - GetEndAtLastLine() -> int - - - TextHeight(int line) -> int - - - - - - SetUseVerticalScrollBar(bool show) - - - - - - GetUseVerticalScrollBar() -> bool - - - AppendText(int length, String text) - - - - - - - GetTwoPhaseDraw() -> bool - - - SetTwoPhaseDraw(bool twoPhase) - - - - - - TargetFromSelection() - - - LinesJoin() - - - LinesSplit(int pixelWidth) - - - - - - SetFoldMarginColour(bool useSetting, Colour back) - - - - - - - SetFoldMarginHiColour(bool useSetting, Colour fore) - - - - - - - LineDuplicate() - - - HomeDisplay() - - - HomeDisplayExtend() - - - LineEndDisplay() - - - LineEndDisplayExtend() - - - LineCopy() - - - MoveCaretInsideView() - - - LineLength(int line) -> int - - - - - - BraceHighlight(int pos1, int pos2) - - - - - - - BraceBadLight(int pos) - - - - - - BraceMatch(int pos) -> int - - - - - - GetViewEOL() -> bool - - - SetViewEOL(bool visible) - - - - - - GetDocPointer() -> void - - - SetDocPointer(void docPointer) - - - - - - SetModEventMask(int mask) - - - - - - GetEdgeColumn() -> int - - - SetEdgeColumn(int column) - - - - - - GetEdgeMode() -> int - - - SetEdgeMode(int mode) - - - - - - GetEdgeColour() -> Colour - - - SetEdgeColour(Colour edgeColour) - - - - - - SearchAnchor() - - - SearchNext(int flags, String text) -> int - - - - - - - SearchPrev(int flags, String text) -> int - - - - - - - LinesOnScreen() -> int - - - UsePopUp(bool allowPopUp) - - - - - - SelectionIsRectangle() -> bool - - - SetZoom(int zoom) - - - - - - GetZoom() -> int - - - CreateDocument() -> void - - - AddRefDocument(void docPointer) - - - - - - ReleaseDocument(void docPointer) - - - - - - GetModEventMask() -> int - - - SetSTCFocus(bool focus) - - - - - - GetSTCFocus() -> bool - - - SetStatus(int statusCode) - - - - - - GetStatus() -> int - - - SetMouseDownCaptures(bool captures) - - - - - - GetMouseDownCaptures() -> bool - - - SetSTCCursor(int cursorType) - - - - - - GetSTCCursor() -> int - - - SetControlCharSymbol(int symbol) - - - - - - GetControlCharSymbol() -> int - - - WordPartLeft() - - - WordPartLeftExtend() - - - WordPartRight() - - - WordPartRightExtend() - - - SetVisiblePolicy(int visiblePolicy, int visibleSlop) - - - - - - - DelLineLeft() - - - DelLineRight() - - - SetXOffset(int newOffset) - - - - - - GetXOffset() -> int - - - ChooseCaretX() - - - SetXCaretPolicy(int caretPolicy, int caretSlop) - - - - - - - SetYCaretPolicy(int caretPolicy, int caretSlop) - - - - - - - SetPrintWrapMode(int mode) - - - - - - GetPrintWrapMode() -> int - - - SetHotspotActiveForeground(bool useSetting, Colour fore) - - - - - - - SetHotspotActiveBackground(bool useSetting, Colour back) - - - - - - - SetHotspotActiveUnderline(bool underline) - - - - - - PositionBefore(int pos) -> int - - - - - - PositionAfter(int pos) -> int - - - - - - CopyRange(int start, int end) - - - - - - - CopyText(int length, String text) - - - - - - - StartRecord() - - - StopRecord() - - - SetLexer(int lexer) - - - - - - GetLexer() -> int - - - Colourise(int start, int end) - - - - - - - SetProperty(String key, String value) - - - - - - - SetKeyWords(int keywordSet, String keyWords) - - - - - - - SetLexerLanguage(String language) - - - - - - GetCurrentLine() -> int - - - StyleSetSpec(int styleNum, String spec) - - - - - - - StyleSetFont(int styleNum, Font font) - - - - - - - StyleSetFontAttr(int styleNum, int size, String faceName, bool bold, - bool italic, bool underline) - - - - - - - - - - - CmdKeyExecute(int cmd) - - - - - - SetMargins(int left, int right) - - - - - - - GetSelection(int OUTPUT, int OUTPUT) - - - - - - - PointFromPosition(int pos) -> Point - - - - - - ScrollToLine(int line) - - - - - - ScrollToColumn(int column) - - - - - - SendMsg(int msg, long wp=0, long lp=0) -> long - - - - - - - - SetVScrollBar(wxScrollBar bar) - - - - - - SetHScrollBar(wxScrollBar bar) - - - - - - GetLastKeydownProcessed() -> bool - - - SetLastKeydownProcessed(bool val) - - - - - - SaveFile(String filename) -> bool - - - - - - LoadFile(String filename) -> bool - - - - - - DoDragOver(int x, int y, wxDragResult def) -> wxDragResult - - - - - - - - DoDropText(long x, long y, String data) -> bool - - - - - - - - - - - __init__(wxEventType commandType=0, int id=0) -> StyledTextEvent - - - - - - - __del__() - - - SetPosition(int pos) - - - - - - SetKey(int k) - - - - - - SetModifiers(int m) - - - - - - SetModificationType(int t) - - - - - - SetText(String t) - - - - - - SetLength(int len) - - - - - - SetLinesAdded(int num) - - - - - - SetLine(int val) - - - - - - SetFoldLevelNow(int val) - - - - - - SetFoldLevelPrev(int val) - - - - - - SetMargin(int val) - - - - - - SetMessage(int val) - - - - - - SetWParam(int val) - - - - - - SetLParam(int val) - - - - - - SetListType(int val) - - - - - - SetX(int val) - - - - - - SetY(int val) - - - - - - SetDragText(String val) - - - - - - SetDragAllowMove(bool val) - - - - - - SetDragResult(wxDragResult val) - - - - - - GetPosition() -> int - - - GetKey() -> int - - - GetModifiers() -> int - - - GetModificationType() -> int - - - GetText() -> String - - - GetLength() -> int - - - GetLinesAdded() -> int - - - GetLine() -> int - - - GetFoldLevelNow() -> int - - - GetFoldLevelPrev() -> int - - - GetMargin() -> int - - - GetMessage() -> int - - - GetWParam() -> int - - - GetLParam() -> int - - - GetListType() -> int - - - GetX() -> int - - - GetY() -> int - - - GetDragText() -> String - - - GetDragAllowMove() -> bool - - - GetDragResult() -> wxDragResult - - - GetShift() -> bool - - - GetControl() -> bool - - - GetAlt() -> bool - - - Clone() -> Event - - - -EVT_STC_CHANGE = wx.PyEventBinder( wxEVT_STC_CHANGE, 1 ) -EVT_STC_STYLENEEDED = wx.PyEventBinder( wxEVT_STC_STYLENEEDED, 1 ) -EVT_STC_CHARADDED = wx.PyEventBinder( wxEVT_STC_CHARADDED, 1 ) -EVT_STC_SAVEPOINTREACHED = wx.PyEventBinder( wxEVT_STC_SAVEPOINTREACHED, 1 ) -EVT_STC_SAVEPOINTLEFT = wx.PyEventBinder( wxEVT_STC_SAVEPOINTLEFT, 1 ) -EVT_STC_ROMODIFYATTEMPT = wx.PyEventBinder( wxEVT_STC_ROMODIFYATTEMPT, 1 ) -EVT_STC_KEY = wx.PyEventBinder( wxEVT_STC_KEY, 1 ) -EVT_STC_DOUBLECLICK = wx.PyEventBinder( wxEVT_STC_DOUBLECLICK, 1 ) -EVT_STC_UPDATEUI = wx.PyEventBinder( wxEVT_STC_UPDATEUI, 1 ) -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 ) -EVT_STC_DWELLSTART = wx.PyEventBinder( wxEVT_STC_DWELLSTART, 1 ) -EVT_STC_DWELLEND = wx.PyEventBinder( wxEVT_STC_DWELLEND, 1 ) -EVT_STC_START_DRAG = wx.PyEventBinder( wxEVT_STC_START_DRAG, 1 ) -EVT_STC_DRAG_OVER = wx.PyEventBinder( wxEVT_STC_DRAG_OVER, 1 ) -EVT_STC_DO_DROP = wx.PyEventBinder( wxEVT_STC_DO_DROP, 1 ) -EVT_STC_ZOOM = wx.PyEventBinder( wxEVT_STC_ZOOM, 1 ) -EVT_STC_HOTSPOT_CLICK = wx.PyEventBinder( wxEVT_STC_HOTSPOT_CLICK, 1 ) -EVT_STC_HOTSPOT_DCLICK = wx.PyEventBinder( wxEVT_STC_HOTSPOT_DCLICK, 1 ) -EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) + + EVT_TOGGLEBUTTON = wx.PyEventBinder( wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, 1) - - - wx = core - + + + + __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 + + + + + + + + + + + + + PreToggleButton() -> ToggleButton + + + 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 + + + + + + + + + + + + + SetValue(self, bool value) + + + + + + GetValue(self) -> bool + + + 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. + + + + + + #--------------------------------------------------------------------------- - - - - __init__(String filemask, int flags=XRC_USE_LOCALE) -> XmlResource - - - - - - - EmptyXmlResource(int flags=XRC_USE_LOCALE) -> XmlResource - - - - - - __del__() - - - Load(String filemask) -> bool - - - - - - LoadFromString(String data) -> bool - - - - - - InitAllHandlers() - - - AddHandler(XmlResourceHandler handler) - - - - - - InsertHandler(XmlResourceHandler handler) - - - - - - ClearHandlers() - - - XmlResource.AddSubclassFactory(XmlSubclassFactory factory) - - - - - - LoadMenu(String name) -> Menu - - - - - - LoadMenuBar(String name) -> MenuBar - - - - - - LoadMenuBarOnFrame(Window parent, String name) -> MenuBar - - - - - - - LoadToolBar(Window parent, String name) -> wxToolBar - - - - - - - LoadDialog(Window parent, String name) -> wxDialog - - - - - - - LoadOnDialog(wxDialog dlg, Window parent, String name) -> bool - - - - - - - - LoadPanel(Window parent, String name) -> wxPanel - - - - - - - LoadOnPanel(wxPanel panel, Window parent, String name) -> bool - - - - - - - - LoadFrame(Window parent, String name) -> wxFrame - - - - - - - LoadOnFrame(wxFrame frame, Window parent, String name) -> bool - - - - - - - - LoadObject(Window parent, String name, String classname) -> Object - - - - - - - - LoadOnObject(Object instance, Window parent, String name, String classname) -> bool - - - - - - - - - LoadBitmap(String name) -> Bitmap - - - - - - LoadIcon(String name) -> Icon - - - - - - AttachUnknownControl(String name, Window control, Window parent=None) -> bool - - - - - - - - XmlResource.GetXRCID(String str_id) -> int - - - - - - GetVersion() -> long - - - CompareVersion(int major, int minor, int release, int revision) -> int - - - - - - - - - XmlResource.Get() -> XmlResource - - - XmlResource.Set(XmlResource res) -> XmlResource - - - - - - GetFlags() -> int - - - SetFlags(int flags) - - - - - - -def XRCID(str_id): - return XmlResource_GetXRCID(str_id) + + + + GetPageCount(self) -> size_t + + + GetPage(self, size_t n) -> Window + + + + + + GetSelection(self) -> int + + + SetPageText(self, size_t n, String strText) -> bool + + + + + + + GetPageText(self, size_t n) -> String + + + + + + SetImageList(self, ImageList imageList) + + + + + + AssignImageList(self, ImageList imageList) + + + + + + GetImageList(self) -> ImageList + + + GetPageImage(self, size_t n) -> int + + + + + + SetPageImage(self, size_t n, int imageId) -> bool + + + + + + + SetPageSize(self, Size size) + + + + + + CalcSizeFromPage(self, Size sizePage) -> Size + + + + + + DeletePage(self, size_t n) -> bool + + + + + + RemovePage(self, size_t n) -> bool + + + + + + DeleteAllPages(self) -> bool + + + AddPage(self, Window page, String text, bool select=False, int imageId=-1) -> bool + + + + + + + + + InsertPage(self, size_t n, Window page, String text, bool select=False, + int imageId=-1) -> bool + + + + + + + + + + SetSelection(self, size_t n) -> int + + + + + + 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__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, + int nOldSel=-1) -> BookCtrlEvent + + + + + + + + + GetSelection(self) -> int + + + SetSelection(self, int nSel) + + + + + + GetOldSelection(self) -> int + + + SetOldSelection(self, int nOldSel) + + + + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=NOTEBOOK_NAME) -> Notebook + + + + + + + + + + + PreNotebook() -> Notebook + + + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=NOTEBOOK_NAME) -> bool + + + + + + + + + + + GetRowCount(self) -> int + + + SetPadding(self, Size padding) + + + + + + SetTabSize(self, Size sz) + + + + + + HitTest(Point pt) -> (tab, where) + Returns the tab which is hit, and flags indicating where using +wx.NB_HITTEST flags. + + + + + + + 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__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, + int nOldSel=-1) -> NotebookEvent + + + + + + + + + + # wxNotebook events + EVT_NOTEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 1 ) + EVT_NOTEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 1 ) + + +#---------------------------------------------------------------------------- + +class NotebookPage(wx.Panel): + """ + There is an old (and apparently unsolvable) bug when placing a + window with a nonstandard background colour in a wxNotebook on + wxGTK, as the notbooks's background colour would always be used + when the window is refreshed. The solution is to place a panel in + the notbook and the coloured window on the panel, sized to cover + the panel. This simple class does that for you, just put an + instance of this in the notebook and make your regular window a + child of this one and it will handle the resize for you. + """ + def __init__(self, parent, id=-1, + pos=wx.DefaultPosition, size=wx.DefaultSize, + style=wx.TAB_TRAVERSAL, name="panel"): + wx.Panel.__init__(self, parent, id, pos, size, style, name) + self.child = None + EVT_SIZE(self, self.OnSize) + + def OnSize(self, evt): + if self.child is None: + children = self.GetChildren() + if len(children): + self.child = children[0] + if self.child: + self.child.SetPosition((0,0)) + self.child.SetSize(self.GetSize()) + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=EmptyString) -> Listbook + + + + + + + + + + + PreListbook() -> Listbook + + + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=EmptyString) -> bool + + + + + + + + + + + IsVertical(self) -> bool + + + + + + __init__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, + int nOldSel=-1) -> ListbookEvent + + + + + + + + + + EVT_LISTBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, 1 ) + EVT_LISTBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, 1 ) + + +#--------------------------------------------------------------------------- + + + + + __init__(self, BookCtrl nb) -> BookCtrlSizer + + + + + + 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(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(self) -> BookCtrl + + + + + + __init__(self, Notebook nb) -> NotebookSizer + + + + + + 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(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(self) -> Notebook + + + +#--------------------------------------------------------------------------- + + + + + GetId(self) -> int + + + GetControl(self) -> Control + + + GetToolBar(self) -> ToolBarBase + + + IsButton(self) -> int + + + IsControl(self) -> int + + + IsSeparator(self) -> int + + + GetStyle(self) -> int + + + GetKind(self) -> int + + + IsEnabled(self) -> bool + + + IsToggled(self) -> bool + + + CanBeToggled(self) -> bool + + + GetNormalBitmap(self) -> Bitmap + + + GetDisabledBitmap(self) -> Bitmap + + + GetBitmap(self) -> Bitmap + + + GetLabel(self) -> String + + + GetShortHelp(self) -> String + + + GetLongHelp(self) -> String + + + Enable(self, bool enable) -> bool + + + + + + Toggle(self) + + + SetToggle(self, bool toggle) -> bool + + + + + + SetShortHelp(self, String help) -> bool + + + + + + SetLongHelp(self, String help) -> bool + + + + + + SetNormalBitmap(self, Bitmap bmp) + + + + + + SetDisabledBitmap(self, Bitmap bmp) + + + + + + SetLabel(self, String label) + + + + + + Detach(self) + + + Attach(self, ToolBarBase tbar) + + + + + + GetClientData(self) -> PyObject + + + SetClientData(self, PyObject clientData) + + + + + + + + + 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 + + + + + + + + + + + + + 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 + + + + + + + + + + + + + + AddToolItem(self, ToolBarToolBase tool) -> ToolBarToolBase + + + + + + InsertToolItem(self, size_t pos, ToolBarToolBase tool) -> ToolBarToolBase + + + + + + + AddControl(self, Control control) -> ToolBarToolBase + + + + + + InsertControl(self, size_t pos, Control control) -> ToolBarToolBase + + + + + + + FindControl(self, int id) -> Control + + + + + + AddSeparator(self) -> ToolBarToolBase + + + InsertSeparator(self, size_t pos) -> ToolBarToolBase + + + + + + RemoveTool(self, int id) -> ToolBarToolBase + + + + + + DeleteToolByPos(self, size_t pos) -> bool + + + + + + DeleteTool(self, int id) -> bool + + + + + + ClearTools(self) + + + Realize(self) -> bool + + + EnableTool(self, int id, bool enable) + + + + + + + ToggleTool(self, int id, bool toggle) + + + + + + + SetToggle(self, int id, bool toggle) + + + + + + + GetToolClientData(self, int id) -> PyObject + + + + + + SetToolClientData(self, int id, PyObject clientData) + + + + + + + GetToolPos(self, int id) -> int + + + + + + GetToolState(self, int id) -> bool + + + + + + GetToolEnabled(self, int id) -> bool + + + + + + SetToolShortHelp(self, int id, String helpString) + + + + + + + GetToolShortHelp(self, int id) -> String + + + + + + SetToolLongHelp(self, int id, String helpString) + + + + + + + GetToolLongHelp(self, int id) -> String + + + + + + SetMarginsXY(self, int x, int y) + + + + + + + SetMargins(self, Size size) + + + + + + SetToolPacking(self, int packing) + + + + + + SetToolSeparation(self, int separation) + + + + + + GetToolMargins(self) -> Size + + + GetMargins(self) -> Size + + + GetToolPacking(self) -> int + + + GetToolSeparation(self) -> int + + + SetRows(self, int nRows) + + + + + + SetMaxRowsCols(self, int rows, int cols) + + + + + + + GetMaxRows(self) -> int + + + GetMaxCols(self) -> int + + + SetToolBitmapSize(self, Size size) + + + + + + GetToolBitmapSize(self) -> Size + + + GetToolSize(self) -> Size + + + FindToolForPosition(self, int x, int y) -> ToolBarToolBase + + + + + + + FindById(self, int toolid) -> ToolBarToolBase + + + + + + IsVertical(self) -> bool + + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL, + String name=wxPyToolBarNameStr) -> ToolBar + + + + + + + + + + + PreToolBar() -> ToolBar + + + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL, + String name=wxPyToolBarNameStr) -> bool + + + + + + + + + + + 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. + + + + + + +#--------------------------------------------------------------------------- + + +#--------------------------------------------------------------------------- + + + + __init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour, + Font font=wxNullFont) -> ListItemAttr + + + + + + + + SetTextColour(self, Colour colText) + + + + + + SetBackgroundColour(self, Colour colBack) + + + + + + SetFont(self, Font font) + + + + + + HasTextColour(self) -> bool + + + HasBackgroundColour(self) -> bool + + + HasFont(self) -> bool + + + GetTextColour(self) -> Colour + + + GetBackgroundColour(self) -> Colour + + + GetFont(self) -> Font + + + Destroy(self) + + + +#--------------------------------------------------------------------------- + + + + + __init__(self) -> ListItem + + + __del__(self) + + + Clear(self) + + + ClearAttributes(self) + + + SetMask(self, long mask) + + + + + + SetId(self, long id) + + + + + + SetColumn(self, int col) + + + + + + SetState(self, long state) + + + + + + SetStateMask(self, long stateMask) + + + + + + SetText(self, String text) + + + + + + SetImage(self, int image) + + + + + + SetData(self, long data) + + + + + + SetWidth(self, int width) + + + + + + SetAlign(self, int align) + + + + + + SetTextColour(self, Colour colText) + + + + + + SetBackgroundColour(self, Colour colBack) + + + + + + SetFont(self, Font font) + + + + + + GetMask(self) -> long + + + GetId(self) -> long + + + GetColumn(self) -> int + + + GetState(self) -> long + + + GetText(self) -> String + + + GetImage(self) -> int + + + GetData(self) -> long + + + GetWidth(self) -> int + + + GetAlign(self) -> int + + + GetAttributes(self) -> ListItemAttr + + + HasAttributes(self) -> bool + + + GetTextColour(self) -> Colour + + + GetBackgroundColour(self) -> Colour + + + GetFont(self) -> Font + + + + + + + + + + + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> ListEvent + + + + + + + + + + + + + GetKeyCode(self) -> int + + + GetIndex(self) -> long + + + GetColumn(self) -> int + + + GetPoint(self) -> Point + + + GetLabel(self) -> String + + + GetText(self) -> String + + + GetImage(self) -> int + + + GetData(self) -> long + + + GetMask(self) -> long + + + GetItem(self) -> ListItem + + + GetCacheFrom(self) -> long + + + GetCacheTo(self) -> long + + + IsEditCancelled(self) -> bool + + + SetEditCanceled(self, bool editCancelled) + + + + + + + +EVT_LIST_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_DRAG , 1) +EVT_LIST_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_RDRAG , 1) +EVT_LIST_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT , 1) +EVT_LIST_END_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_LIST_END_LABEL_EDIT , 1) +EVT_LIST_DELETE_ITEM = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ITEM , 1) +EVT_LIST_DELETE_ALL_ITEMS = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS , 1) +EVT_LIST_GET_INFO = wx.PyEventBinder(wxEVT_COMMAND_LIST_GET_INFO , 1) +EVT_LIST_SET_INFO = wx.PyEventBinder(wxEVT_COMMAND_LIST_SET_INFO , 1) +EVT_LIST_ITEM_SELECTED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_SELECTED , 1) +EVT_LIST_ITEM_DESELECTED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_DESELECTED , 1) +EVT_LIST_KEY_DOWN = wx.PyEventBinder(wxEVT_COMMAND_LIST_KEY_DOWN , 1) +EVT_LIST_INSERT_ITEM = wx.PyEventBinder(wxEVT_COMMAND_LIST_INSERT_ITEM , 1) +EVT_LIST_COL_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_CLICK , 1) +EVT_LIST_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK , 1) +EVT_LIST_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, 1) +EVT_LIST_ITEM_ACTIVATED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_ACTIVATED , 1) +EVT_LIST_CACHE_HINT = wx.PyEventBinder(wxEVT_COMMAND_LIST_CACHE_HINT , 1) +EVT_LIST_COL_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK , 1) +EVT_LIST_COL_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG , 1) +EVT_LIST_COL_DRAGGING = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_DRAGGING , 1) +EVT_LIST_COL_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_END_DRAG , 1) +EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED , 1) + + +#--------------------------------------------------------------------------- + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=LC_ICON, + Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListCtrl + + + + + + + + + + + + PreListCtrl() -> ListCtrl + + + 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. + + + + + + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + SetForegroundColour(self, Colour col) -> bool + + + + + + SetBackgroundColour(self, Colour col) -> bool + + + + + + GetColumn(self, int col) -> ListItem + + + + + + SetColumn(self, int col, ListItem item) -> bool + + + + + + + GetColumnWidth(self, int col) -> int + + + + + + SetColumnWidth(self, int col, int width) -> bool + + + + + + + GetCountPerPage(self) -> int + + + GetViewRect(self) -> Rect + + + GetItem(self, long itemId, int col=0) -> ListItem + + + + + + + SetItem(self, ListItem info) -> bool + + + + + + SetStringItem(self, long index, int col, String label, int imageId=-1) -> long + + + + + + + + + GetItemState(self, long item, long stateMask) -> int + + + + + + + SetItemState(self, long item, long state, long stateMask) -> bool + + + + + + + + SetItemImage(self, long item, int image, int selImage) -> bool + + + + + + + + GetItemText(self, long item) -> String + + + + + + SetItemText(self, long item, String str) + + + + + + + GetItemData(self, long item) -> long + + + + + + SetItemData(self, long item, long data) -> bool + + + + + + + GetItemPosition(self, long item) -> Point + + + + + + GetItemRect(self, long item, int code=LIST_RECT_BOUNDS) -> Rect + + + + + + + SetItemPosition(self, long item, Point pos) -> bool + + + + + + + GetItemCount(self) -> int + + + GetColumnCount(self) -> int + + + GetItemSpacing(self) -> Size + + + SetItemSpacing(self, int spacing, bool isSmall=False) + + + + + + + GetSelectedItemCount(self) -> int + + + GetTextColour(self) -> Colour + + + SetTextColour(self, Colour col) + + + + + + GetTopItem(self) -> long + + + SetSingleStyle(self, long style, bool add=True) + + + + + + + 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 need to be +called after changing the others for the change to take place +immediately. + + + + + + GetNextItem(self, long item, int geometry=LIST_NEXT_ALL, int state=LIST_STATE_DONTCARE) -> long + + + + + + + + GetImageList(self, int which) -> ImageList + + + + + + SetImageList(self, ImageList imageList, int which) + + + + + + + AssignImageList(self, ImageList imageList, int which) + + + + + + + InReportView(self) -> bool + + + IsVirtual(self) -> bool + + + RefreshItem(self, long item) + + + + + + RefreshItems(self, long itemFrom, long itemTo) + + + + + + + Arrange(self, int flag=LIST_ALIGN_DEFAULT) -> bool + + + + + + DeleteItem(self, long item) -> bool + + + + + + DeleteAllItems(self) -> bool + + + DeleteColumn(self, int col) -> bool + + + + + + DeleteAllColumns(self) -> bool + + + ClearAll(self) + + + EditLabel(self, long item) + + + + + + EnsureVisible(self, long item) -> bool + + + + + + FindItem(self, long start, String str, bool partial=False) -> long + + + + + + + + FindItemData(self, long start, long data) -> long + + + + + + + FindItemAtPos(self, long start, Point pt, int direction) -> long + + + + + + + + HitTest(Point point) -> (item, where) + Determines which item (if any) is at the specified point, giving + in the second return value (see wxLIST_HITTEST_... flags.) + + + + + + + InsertItem(self, ListItem info) -> long + + + + + + InsertStringItem(self, long index, String label) -> long + + + + + + + InsertImageItem(self, long index, int imageIndex) -> long + + + + + + + InsertImageStringItem(self, long index, String label, int imageIndex) -> long + + + + + + + + InsertColumnInfo(self, long col, ListItem info) -> long + + + + + + + InsertColumn(self, long col, String heading, int format=LIST_FORMAT_LEFT, + int width=-1) -> long + + + + + + + + + SetItemCount(self, long count) + + + + + + ScrollList(self, int dx, int dy) -> bool + + + + + + + SetItemTextColour(self, long item, Colour col) + + + + + + + GetItemTextColour(self, long item) -> Colour + + + + + + SetItemBackgroundColour(self, long item, Colour col) + + + + + + + GetItemBackgroundColour(self, long item) -> Colour + + + + + + SortItems(self, PyObject func) -> bool + + + + + + 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. -def XRCCTRL(window, str_id, *ignoreargs): - return window.FindWindowById(XRCID(str_id)) +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__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=LC_REPORT, + Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListView + + + + + + + + + + + + PreListView() -> ListView + + + 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. + + + + + + + + + + + + Select(self, long n, bool on=True) + + + + + + + Focus(self, long index) + + + + + + GetFocusedItem(self) -> long + + + GetNextSelected(self, long item) -> long + + + + + + GetFirstSelected(self) -> long + + + IsSelected(self, long index) -> bool + + + + + + SetColumnImage(self, int col, int image) + + + + + + + ClearColumnImage(self, int col) + + + + + + #--------------------------------------------------------------------------- - - - __init__() -> XmlSubclassFactory - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - + #--------------------------------------------------------------------------- - - - __init__(String name=EmptyString, String value=EmptyString, - XmlProperty next=None) -> XmlProperty - - - - - - - - GetName() -> String - - - GetValue() -> String - - - GetNext() -> XmlProperty - - - SetName(String name) - - - - - - SetValue(String value) - - - - - - SetNext(XmlProperty next) - - - - - - - - __init__(XmlNode parent=None, int type=0, String name=EmptyString, - String content=EmptyString, XmlProperty props=None, - XmlNode next=None) -> XmlNode - - - - - - - - - - - XmlNodeEasy(int type, String name, String content=EmptyString) -> XmlNode - - - - - - - - __del__() - - - AddChild(XmlNode child) - - - - - - InsertChild(XmlNode child, XmlNode before_node) - - - - - - - RemoveChild(XmlNode child) -> bool - - - - - - AddProperty(XmlProperty prop) - - - - - - AddPropertyName(String name, String value) - - - - - - - DeleteProperty(String name) -> bool - - - - - - GetType() -> int - - - GetName() -> String - - - GetContent() -> String - - - GetParent() -> XmlNode - - - GetNext() -> XmlNode - - - GetChildren() -> XmlNode - - - GetProperties() -> XmlProperty - - - GetPropVal(String propName, String defaultVal) -> String - - - - - - - HasProp(String propName) -> bool - - - - - - SetType(int type) - - - - - - SetName(String name) - - - - - - SetContent(String con) - - - - - - SetParent(XmlNode parent) - - - - - - SetNext(XmlNode next) - - - - - - SetChildren(XmlNode child) - - - - - - SetProperties(XmlProperty prop) - - - - - - - - - __init__(String filename, String encoding=UTF8String) -> XmlDocument - - - - - - - XmlDocumentFromStream(InputStream stream, String encoding=UTF8String) -> XmlDocument - - - - - - - EmptyXmlDocument() -> XmlDocument - - - __del__() - - - Load(String filename, String encoding=UTF8String) -> bool - - - - - - - LoadFromStream(InputStream stream, String encoding=UTF8String) -> bool - - - - - - - Save(String filename) -> bool - - - - - - SaveToStream(OutputStream stream) -> bool - - - - - - IsOk() -> bool - - - GetRoot() -> XmlNode - - - GetVersion() -> String - - - GetFileEncoding() -> String - - - SetRoot(XmlNode node) - - - - - - SetVersion(String version) - - - - - - SetFileEncoding(String encoding) - - - - - - + + + __init__(self) -> TreeItemId + + + __del__(self) + + + IsOk(self) -> bool + + + __eq__(self, TreeItemId other) -> bool + + + + + + __ne__(self, TreeItemId other) -> bool + + + + + + + + + __init__(self, PyObject obj=None) -> TreeItemData + + + + + + GetData(self) -> PyObject + + + SetData(self, PyObject obj) + + + + + + GetId(self) -> TreeItemId + + + SetId(self, TreeItemId id) + + + + + + Destroy(self) + + + #--------------------------------------------------------------------------- - - - - __init__() -> XmlResourceHandler - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - CreateResource(XmlNode node, Object parent, Object instance) -> Object - - - - - - - - SetParentResource(XmlResource res) - - - - - - GetResource() -> XmlResource - - - GetNode() -> XmlNode - - - GetClass() -> String - - - GetParent() -> Object - - - GetInstance() -> Object - - - GetParentAsWindow() -> Window - - - GetInstanceAsWindow() -> Window - - - IsOfClass(XmlNode node, String classname) -> bool - - - - - - - GetNodeContent(XmlNode node) -> String - - - - - - HasParam(String param) -> bool - - - - - - GetParamNode(String param) -> XmlNode - - - - - - GetParamValue(String param) -> String - - - - - - AddStyle(String name, int value) - - - - - - - AddWindowStyles() - - - GetStyle(String param=StyleString, int defaults=0) -> int - - - - - - - GetText(String param, bool translate=True) -> String - - - - - - - GetID() -> int - - - GetName() -> String - - - GetBool(String param, bool defaultv=False) -> bool - - - - - - - GetLong(String param, long defaultv=0) -> long - - - - - - - GetColour(String param) -> Colour - - - - - - GetSize(String param=SizeString) -> Size - - - - - - GetPosition(String param=PosString) -> Point - - - - - - GetDimension(String param, int defaultv=0) -> int - - - - - - - GetBitmap(String param=BitmapString, wxArtClient defaultArtClient=wxART_OTHER, - Size size=DefaultSize) -> Bitmap - - - - - - - - GetIcon(String param=IconString, wxArtClient defaultArtClient=wxART_OTHER, - Size size=DefaultSize) -> Icon - - - - - - - - GetFont(String param=FontString) -> Font - - - - - - SetupWindow(Window wnd) - - - - - - CreateChildren(Object parent, bool this_hnd_only=False) - - - - - - - CreateChildrenPrivately(Object parent, XmlNode rootnode=None) - - - - - - - CreateResFromNode(XmlNode node, Object parent, Object instance=None) -> Object - - - - - - - - GetCurFileSystem() -> FileSystem - - - #---------------------------------------------------------------------------- -# The global was removed in favor of static accessor functions. This is for -# backwards compatibility: + + +EVT_TREE_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_DRAG , 1) +EVT_TREE_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_RDRAG , 1) +EVT_TREE_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT , 1) +EVT_TREE_END_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_LABEL_EDIT , 1) +EVT_TREE_DELETE_ITEM = wx.PyEventBinder(wxEVT_COMMAND_TREE_DELETE_ITEM , 1) +EVT_TREE_GET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_GET_INFO , 1) +EVT_TREE_SET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_SET_INFO , 1) +EVT_TREE_ITEM_EXPANDED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDED , 1) +EVT_TREE_ITEM_EXPANDING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDING , 1) +EVT_TREE_ITEM_COLLAPSED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSED , 1) +EVT_TREE_ITEM_COLLAPSING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSING , 1) +EVT_TREE_SEL_CHANGED = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGED , 1) +EVT_TREE_SEL_CHANGING = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGING , 1) +EVT_TREE_KEY_DOWN = wx.PyEventBinder(wxEVT_COMMAND_TREE_KEY_DOWN , 1) +EVT_TREE_ITEM_ACTIVATED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_ACTIVATED , 1) +EVT_TREE_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK , 1) +EVT_TREE_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 1) +EVT_TREE_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_DRAG , 1) +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__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> TreeEvent + + + + + + + GetItem(self) -> TreeItemId + + + SetItem(self, TreeItemId item) + + + + + + GetOldItem(self) -> TreeItemId + + + SetOldItem(self, TreeItemId item) + + + + + + GetPoint(self) -> Point + + + SetPoint(self, Point pt) + + + + + + GetKeyEvent(self) -> KeyEvent + + + GetKeyCode(self) -> int + + + SetKeyEvent(self, KeyEvent evt) + + + + + + GetLabel(self) -> String + + + SetLabel(self, String label) + + + + + + IsEditCancelled(self) -> bool + + + SetEditCanceled(self, bool editCancelled) + + + + + + SetToolTip(self, String toolTip) + + + + + + +#--------------------------------------------------------------------------- + + + + + __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 + + + + + + + + + + + + PreTreeCtrl() -> TreeCtrl + + + 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 + Do the 2nd phase and create the GUI control. + + + + + + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + GetCount(self) -> size_t + + + GetIndent(self) -> unsigned int + + + SetIndent(self, unsigned int indent) + + + + + + GetSpacing(self) -> unsigned int + + + SetSpacing(self, unsigned int spacing) + + + + + + GetImageList(self) -> ImageList + + + GetStateImageList(self) -> ImageList + + + SetImageList(self, ImageList imageList) + + + + + + SetStateImageList(self, ImageList imageList) + + + + + + AssignImageList(self, ImageList imageList) + + + + + + AssignStateImageList(self, ImageList imageList) + + + + + + GetItemText(self, TreeItemId item) -> String + + + + + + GetItemImage(self, TreeItemId item, int which=TreeItemIcon_Normal) -> int + + + + + + + GetItemData(self, TreeItemId item) -> TreeItemData + + + + + + GetItemPyData(self, TreeItemId item) -> PyObject + + + + + + GetItemTextColour(self, TreeItemId item) -> Colour + + + + + + GetItemBackgroundColour(self, TreeItemId item) -> Colour + + + + + + GetItemFont(self, TreeItemId item) -> Font + + + + + + SetItemText(self, TreeItemId item, String text) + + + + + + + SetItemImage(self, TreeItemId item, int image, int which=TreeItemIcon_Normal) + + + + + + + + SetItemData(self, TreeItemId item, TreeItemData data) + + + + + + + SetItemPyData(self, TreeItemId item, PyObject obj) + + + + + + + SetItemHasChildren(self, TreeItemId item, bool has=True) + + + + + + + SetItemBold(self, TreeItemId item, bool bold=True) + + + + + + + SetItemTextColour(self, TreeItemId item, Colour col) + + + + + + + SetItemBackgroundColour(self, TreeItemId item, Colour col) + + + + + + + SetItemFont(self, TreeItemId item, Font font) + + + + + + + IsVisible(self, TreeItemId item) -> bool + + + + + + ItemHasChildren(self, TreeItemId item) -> bool + + + + + + IsExpanded(self, TreeItemId item) -> bool + + + + + + IsSelected(self, TreeItemId item) -> bool + + + + + + IsBold(self, TreeItemId item) -> bool + + + + + + GetChildrenCount(self, TreeItemId item, bool recursively=True) -> size_t + + + + + + + GetRootItem(self) -> TreeItemId + + + GetSelection(self) -> TreeItemId + + + GetSelections(self) -> PyObject + + + GetItemParent(self, TreeItemId item) -> TreeItemId + + + + + + GetFirstChild(self, TreeItemId item) -> PyObject + + + + + + GetNextChild(self, TreeItemId item, void cookie) -> PyObject + + + + + + + GetLastChild(self, TreeItemId item) -> TreeItemId + + + + + + GetNextSibling(self, TreeItemId item) -> TreeItemId + + + + + + GetPrevSibling(self, TreeItemId item) -> TreeItemId + + + + + + GetFirstVisibleItem(self) -> TreeItemId + + + GetNextVisible(self, TreeItemId item) -> TreeItemId + + + + + + GetPrevVisible(self, TreeItemId item) -> TreeItemId + + + + + + AddRoot(self, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId + + + + + + + + + PrependItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1, + TreeItemData data=None) -> TreeItemId + + + + + + + + + + InsertItem(self, TreeItemId parent, TreeItemId idPrevious, String text, + int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId + + + + + + + + + + + InsertItemBefore(self, TreeItemId parent, size_t index, String text, int image=-1, + int selectedImage=-1, TreeItemData data=None) -> TreeItemId + + + + + + + + + + + AppendItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1, + TreeItemData data=None) -> TreeItemId + + + + + + + + + + Delete(self, TreeItemId item) + + + + + + DeleteChildren(self, TreeItemId item) + + + + + + DeleteAllItems(self) + + + Expand(self, TreeItemId item) + + + + + + Collapse(self, TreeItemId item) + + + + + + CollapseAndReset(self, TreeItemId item) + + + + + + Toggle(self, TreeItemId item) + + + + + + Unselect(self) + + + UnselectItem(self, TreeItemId item) + + + + + + UnselectAll(self) + + + SelectItem(self, TreeItemId item, bool select=True) + + + + + + + ToggleItemSelection(self, TreeItemId item) + + + + + + EnsureVisible(self, TreeItemId item) + + + + + + ScrollTo(self, TreeItemId item) + + + + + + EditLabel(self, TreeItemId item) + + + + + + GetEditControl(self) -> TextCtrl + + + 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. + + + + + + + + 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. -TheXmlResource = XmlResource_Get() +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__(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, + int defaultFilter=0, String name=TreeCtrlNameStr) -> GenericDirCtrl + + + + + + + + + + + + + + PreGenericDirCtrl() -> GenericDirCtrl + + + 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, + int defaultFilter=0, String name=TreeCtrlNameStr) -> bool + + + + + + + + + + + + + + ExpandPath(self, String path) -> bool + + + + + + GetDefaultPath(self) -> String + + + SetDefaultPath(self, String path) + + + + + + GetPath(self) -> String + + + GetFilePath(self) -> String + + + SetPath(self, String path) + + + + + + ShowHidden(self, bool show) + + + + + + GetShowHidden(self) -> bool + + + GetFilter(self) -> String + + + SetFilter(self, String filter) + + + + + + GetFilterIndex(self) -> int + + + SetFilterIndex(self, int n) + + + + + + GetRootId(self) -> TreeItemId + + + GetTreeCtrl(self) -> TreeCtrl + + + 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. + + + + + + + + + DoResize(self) + + + ReCreateTree(self) + + + + + + __init__(self, GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0) -> DirFilterListCtrl + + + + + + + + + + PreDirFilterListCtrl() -> DirFilterListCtrl + + + Create(self, GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0) -> bool + + + + + + + + + + FillFilterList(self, String filter, int defaultFilter) + + + + + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, + String name=ControlNameStr) -> PyControl + + + + + + + + + + + + PrePyControl() -> PyControl + + + _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 + + + +#--------------------------------------------------------------------------- + + +EVT_HELP = wx.PyEventBinder( wxEVT_HELP, 1) +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. -#---------------------------------------------------------------------------- -# Create a factory for handling the subclass property of the object tag. +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__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> HelpEvent + + + + + + + + GetPosition(self) -> Point + Returns the left-click position of the mouse, in screen +coordinates. This allows the application to position the help +appropriately. + + + SetPosition(self, Point pos) + Sets the left-click position of the mouse, in screen coordinates. + + + + + + GetLink(self) -> String + Get an optional link to further help + + + SetLink(self, String link) + Set an optional link to further help + + + + + + GetTarget(self) -> String + Get an optional target to display help in. E.g. a window specification + + + 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. -def _my_import(name): - mod = __import__(name) - components = name.split('.') - for comp in components[1:]: - mod = getattr(mod, comp) - return mod +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. -class XmlSubclassFactory_Python(XmlSubclassFactory): - def __init__(self): - XmlSubclassFactory.__init__(self) + * 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). - def Create(self, className): - assert className.find('.') != -1, "Module name must be specified!" - mname = className[:className.rfind('.')] - cname = className[className.rfind('.')+1:] - module = _my_import(mname) - klass = getattr(module, cname) - inst = klass() - return inst +:see: `wx.ContextHelpButton` + + + + __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. + + + + + + + __del__(self) + + + 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. -XmlResource_AddSubclassFactory(XmlSubclassFactory_Python()) +Returns true if the application was successfully put into +context-sensitive help mode. This function only returns when the event +loop has finished. + + + + + + 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. -#---------------------------------------------------------------------------- +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__(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. + + + + + + + + + + + wx.HelpProvider is an abstract class used by a program +implementing context-sensitive help to show the help text for the +given window. + +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. + + + + + + Get() -> HelpProvider + Return the current application-wide help provider. + + + 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(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. + + + + + + AddHelp(self, Window window, String text) + Associates the text with the given window. + + + + + + + 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. + + + + + + + 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. + + + + + + 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. + + + __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. + + + +#--------------------------------------------------------------------------- - - - - wx = core - - - - __init__(Object target) -> DynamicSashSplitEvent - - - - - - - - - __init__(Object target) -> DynamicSashUnifyEvent - - - - - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER, - String name=DynamicSashNameStr) -> DynamicSashWindow - - - - - - - - - - - PreDynamicSashWindow() -> DynamicSashWindow - - - Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER, - String name=DynamicSashNameStr) -> bool - - - - - - - - - - - GetHScrollBar(Window child) -> ScrollBar - - - - - - GetVScrollBar(Window child) -> ScrollBar - - - - - - -EVT_DYNAMIC_SASH_SPLIT = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_SPLIT, 1 ) -EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) + + + + __init__(self, Bitmap image, Cursor cursor=wxNullCursor) -> DragImage + + + + + + + DragIcon(Icon image, Cursor cursor=wxNullCursor) -> DragImage + + + + + + + DragString(String str, Cursor cursor=wxNullCursor) -> DragImage + + + + + + + DragTreeItem(TreeCtrl treeCtrl, TreeItemId id) -> DragImage + + + + + + + DragListItem(ListCtrl listCtrl, long id) -> DragImage + + + + + + + __del__(self) + + + SetBackingBitmap(self, Bitmap bitmap) + + + + + + BeginDrag(self, Point hotspot, Window window, bool fullScreen=False, + Rect rect=None) -> bool + + + + + + + + + BeginDragBounded(self, Point hotspot, Window window, Window boundingWindow) -> bool + + + + + + + + EndDrag(self) -> bool + + + Move(self, Point pt) -> bool + + + + + + Show(self) -> bool + + + Hide(self) -> bool + + + GetImageRect(self, Point pos) -> Rect + + + + + + DoDrawImage(self, DC dc, Point pos) -> bool + + + + + + + UpdateBackingFromWindow(self, DC windowDC, MemoryDC destDC, Rect sourceRect, Rect destRect) -> bool + + + + + + + + + RedrawImage(self, Point oldPos, Point newPos, bool eraseOld, bool drawNew) -> bool + + + + + + + + + + + + wx = _core + +#--------------------------------------------------------------------------- - - - - __init__(Window parent, int id, String label, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE, - String name=EditableListBoxNameStr) -> EditableListBox - - - - - - - - - - - - SetStrings(wxArrayString strings) - - - - - - GetStrings() -> PyObject - - - GetListCtrl() -> wxListCtrl - - - GetDelButton() -> BitmapButton - - - GetNewButton() -> BitmapButton - - - GetUpButton() -> BitmapButton - - - GetDownButton() -> BitmapButton - - - GetEditButton() -> BitmapButton - - - - - - __init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, - long style=TR_HAS_BUTTONS) -> RemotelyScrolledTreeCtrl - - - - - - - - - - HideVScrollbar() - - - AdjustRemoteScrollbars() - - - GetScrolledWindow() -> ScrolledWindow - - - ScrollToLine(int posHoriz, int posVert) - - - - - - - SetCompanionWindow(Window companion) - - - - - - GetCompanionWindow() -> Window - - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0) -> TreeCompanionWindow - - - - - - - - - - _setCallbackInfo(PyObject self, PyObject _class) - - - - - - - GetTreeCtrl() -> RemotelyScrolledTreeCtrl - - - SetTreeCtrl(RemotelyScrolledTreeCtrl treeCtrl) - - - - - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxSP_3D|wxCLIP_CHILDREN) -> ThinSplitterWindow - - - - - - - - - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=0) -> SplitterScrolledWindow - - - - - - - - - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -> LEDNumberCtrl - - - - - - - - - - PreLEDNumberCtrl() -> LEDNumberCtrl - - - Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -> bool - - - - - - - - - - GetAlignment() -> int - - - GetDrawFaded() -> bool - - - GetValue() -> String - - - SetAlignment(int Alignment, bool Redraw=true) - - - - - - - SetDrawFaded(bool DrawFaded, bool Redraw=true) - - - - - - - SetValue(String Value, bool Redraw=true) - - - - + + + GetColour(int index) -> Colour + + + + + + GetFont(int index) -> Font + + + + + + GetMetric(int index) -> int + + + + + + HasFeature(int index) -> bool + + + + + + GetScreenType() -> int + + + SetScreenType(int screen) + + + + + + + + + __init__(self) -> SystemOptions + + + SetOption(String name, String value) + + + + + + + SetOptionInt(String name, int value) + + + + + + + GetOption(String name) -> String + + + + + + GetOptionInt(String name) -> int + + + + + + HasOption(String name) -> bool + + + + + + +#--------------------------------------------------------------------------- + + + NewId() -> long - - - - - __init__(String text=EmptyString, int image=-1, size_t width=100, - int alignment=TL_ALIGN_LEFT) -> TreeListColumnInfo + + RegisterId(long id) - - - - + - - - GetAlignment() -> int - - - GetText() -> String - - GetImage() -> int + + GetCurrentId() -> long - - GetSelectedImage() -> int + + Bell() - - GetWidth() -> size_t + + EndBusyCursor() - - SetAlignment(int alignment) + + GetElapsedTime(bool resetTimer=True) -> long - + - - SetText(String text) + + GetMousePosition() -> (x,y) - + + - - SetImage(int image) - - - + + IsBusy() -> bool - - SetSelectedImage(int image) - - - + + Now() -> String - - SetWidth(size_t with) + + Shell(String command=EmptyString) -> bool - + - - - - - __init__(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=TR_DEFAULT_STYLE, - Validator validator=DefaultValidator, - String name=TreeListCtrlNameStr) -> TreeListCtrl - - - - - - - - - - - - PreTreeListCtrl() -> TreeListCtrl - - - Create(Window parent, int id=-1, Point pos=DefaultPosition, - Size size=DefaultSize, long style=TR_DEFAULT_STYLE, - Validator validator=DefaultValidator, - String name=TreeListCtrlNameStr) -> bool - - - - - - - - - + + StartTimer() - - _setCallbackInfo(PyObject self, PyObject _class) + + GetOsVersion() -> (platform, major, minor) - - + + - - GetCount() -> size_t - - - GetIndent() -> unsigned int - - - SetIndent(unsigned int indent) - - - + + GetOsDescription() -> String - - GetSpacing() -> unsigned int + + GetFreeMemory() -> long - - SetSpacing(unsigned int spacing) + + Shutdown(int wFlags) -> bool - + - - GetLineSpacing() -> unsigned int - - - SetLineSpacing(unsigned int spacing) + + Sleep(int secs) - + - - GetImageList() -> ImageList - - - GetStateImageList() -> ImageList - - - GetButtonsImageList() -> ImageList - - - SetImageList(ImageList imageList) + + MilliSleep(unsigned long milliseconds) - + - - SetStateImageList(ImageList imageList) + + MicroSleep(unsigned long microseconds) - + - - SetButtonsImageList(ImageList imageList) + Usleep = MilliSleep + + EnableTopLevelWindows(bool enable) - + - - AssignImageList(ImageList imageList) + + StripMenuCodes(String in) -> String - + - - AssignStateImageList(ImageList imageList) - - - + + GetEmailAddress() -> String - - AssignButtonsImageList(ImageList imageList) - - - + + GetHostName() -> String - - AddColumn(String text) - - - + + GetFullHostName() -> String - - AddColumnInfo(TreeListColumnInfo col) - - - + + GetUserId() -> String - - InsertColumn(size_t before, String text) - - - - + + GetUserName() -> String - - InsertColumnInfo(size_t before, TreeListColumnInfo col) - - - - + + GetHomeDir() -> String - - RemoveColumn(size_t column) + + GetUserHome(String user=EmptyString) -> String - + - - GetColumnCount() -> size_t + + GetProcessId() -> unsigned long - - SetColumnWidth(size_t column, size_t width) - - - - + + Trap() - - GetColumnWidth(size_t column) -> int + + FileSelector(String message=FileSelectorPromptStr, String default_path=EmptyString, + String default_filename=EmptyString, + String default_extension=EmptyString, + String wildcard=FileSelectorDefaultWildcardStr, + int flags=0, Window parent=None, int x=-1, + int y=-1) -> String - + + + + + + + + + - - SetMainColumn(size_t column) + + LoadFileSelector(String what, String extension, String default_name=EmptyString, + Window parent=None) -> String - + + + + - - GetMainColumn() -> size_t - - - SetColumnText(size_t column, String text) + + SaveFileSelector(String what, String extension, String default_name=EmptyString, + Window parent=None) -> String - - + + + + - - GetColumnText(size_t column) -> String + + DirSelector(String message=DirSelectorPromptStr, String defaultPath=EmptyString, + long style=DD_DEFAULT_STYLE, + Point pos=DefaultPosition, Window parent=None) -> String - + + + + + - - SetColumn(size_t column, TreeListColumnInfo info) + + GetTextFromUser(String message, String caption=EmptyString, String default_value=EmptyString, + Window parent=None, + int x=-1, int y=-1, bool centre=True) -> String - - + + + + + + + - - GetColumn(size_t column) -> TreeListColumnInfo + + GetPasswordFromUser(String message, String caption=EmptyString, String default_value=EmptyString, + Window parent=None) -> String - + + + + - - SetColumnAlignment(size_t column, int align) + + GetSingleChoice(String message, String caption, int choices, String choices_array, + Window parent=None, int x=-1, + int y=-1, bool centre=True, int width=150, int height=200) -> String - - + + + + + + + + + + - - GetColumnAlignment(size_t column) -> int + + GetSingleChoiceIndex(String message, String caption, int choices, String choices_array, + Window parent=None, int x=-1, + int y=-1, bool centre=True, int width=150, int height=200) -> int - + + + + + + + + + + - - SetColumnImage(size_t column, int image) + + MessageBox(String message, String caption=EmptyString, int style=wxOK|wxCENTRE, + Window parent=None, int x=-1, + int y=-1) -> int - - + + + + + + - - GetColumnImage(size_t column) -> int + + GetNumberFromUser(String message, String prompt, String caption, long value, + long min=0, long max=100, Window parent=None, + Point pos=DefaultPosition) -> long - + + + + + + + + - - GetItemText(TreeItemId item, int column=-1) -> String - - - - + + ColourDisplay() -> bool - - GetItemImage(TreeItemId item, int column=-1, int which=TreeItemIcon_Normal) -> int - - - - - + + DisplayDepth() -> int - - SetItemText(TreeItemId item, String text, int column=-1) - - - - - + + GetDisplayDepth() -> int - - SetItemImage(TreeItemId item, int image, int column=-1, int which=TreeItemIcon_Normal) + + DisplaySize() -> (width, height) - - - - + + - - GetItemData(TreeItemId item) -> TreeItemData - - - + + GetDisplaySize() -> Size - - SetItemData(TreeItemId item, TreeItemData data) + + DisplaySizeMM() -> (width, height) - - + + - - GetItemPyData(TreeItemId item) -> PyObject - - - + + GetDisplaySizeMM() -> Size - - SetItemPyData(TreeItemId item, PyObject obj) + + ClientDisplayRect() -> (x, y, width, height) - - + + + + - - SetItemHasChildren(TreeItemId item, bool has=True) - - - - + + GetClientDisplayRect() -> Rect - - SetItemBold(TreeItemId item, bool bold=True) + + SetCursor(Cursor cursor) - - + - - SetItemTextColour(TreeItemId item, Colour col) + + BeginBusyCursor(Cursor cursor=wxHOURGLASS_CURSOR) - - + - - SetItemBackgroundColour(TreeItemId item, Colour col) - - - - + + GetActiveWindow() -> Window - - SetItemFont(TreeItemId item, Font font) + + GenericFindWindowAtPoint(Point pt) -> Window - - + - - GetItemBold(TreeItemId item) -> bool + + FindWindowAtPoint(Point pt) -> Window - + - - GetItemTextColour(TreeItemId item) -> Colour + + GetTopLevelParent(Window win) -> Window - + - - GetItemBackgroundColour(TreeItemId item) -> Colour + + 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. + - + - - GetItemFont(TreeItemId item) -> Font - - - + + WakeUpMainThread() - - IsVisible(TreeItemId item) -> bool - - - + + MutexGuiEnter() - - ItemHasChildren(TreeItemId item) -> bool - - - + + MutexGuiLeave() - - IsExpanded(TreeItemId item) -> bool - - - + + + __init__(self) -> MutexGuiLocker + + + __del__(self) + + + + Thread_IsMain() -> bool - - IsSelected(TreeItemId item) -> bool + +#--------------------------------------------------------------------------- + + + + + __init__(self, String tip) -> ToolTip + + + + + + SetTip(self, String tip) + + + + + + GetTip(self) -> String + + + GetWindow(self) -> Window + + + Enable(bool flag) + + + + + + SetDelay(long milliseconds) + + + + + + + + __init__(self, Window window, Size size) -> Caret + + + + + + + __del__(self) + + + IsOk(self) -> bool + + + IsVisible(self) -> bool + + + GetPosition(self) -> Point + + + GetPositionTuple() -> (x,y) + + + + + + + GetSize(self) -> Size + + + GetSizeTuple() -> (width, height) + + + + + + + GetWindow(self) -> Window + + + MoveXY(self, int x, int y) + + + + + + + Move(self, Point pt) + + + + + + SetSizeWH(self, int width, int height) + + + + + + + SetSize(self, Size size) + + + + + + Show(self, int show=True) + + + + + + Hide(self) + + + + Caret_GetBlinkTime() -> int + + + Caret_SetBlinkTime(int milliseconds) - + - - IsBold(TreeItemId item) -> bool - - + + + __init__(self, Cursor cursor=wxHOURGLASS_CURSOR) -> BusyCursor + + + + + + __del__(self) + + + + + __init__(self, Window winToSkip=None) -> WindowDisabler + + + + + + __del__(self) + + + + + + __init__(self, String message) -> BusyInfo + + + + + + __del__(self) + + + + + __init__(self) -> StopWatch + + + Start(self, long t0=0) + + + + + + Pause(self) + + + Resume(self) + + + Time(self) -> long + + + + + + __init__(self, int maxFiles=9, int idBase=ID_FILE1) -> FileHistory + + + + + + + __del__(self) + + + AddFileToHistory(self, String file) + + + + + + RemoveFileFromHistory(self, int i) + + + + + + GetMaxFiles(self) -> int + + + UseMenu(self, Menu menu) + + + + + + RemoveMenu(self, Menu menu) + + + + + + Load(self, ConfigBase config) + + + + + + Save(self, ConfigBase config) + + + + + + AddFilesToMenu(self) + + + AddFilesToThisMenu(self, Menu menu) + + + + + + GetHistoryFile(self, int i) -> String + + + + + + GetCount(self) -> int + + + + + __init__(self, String name, String path=EmptyString) -> SingleInstanceChecker + + + + + + + PreSingleInstanceChecker() -> SingleInstanceChecker + + + __del__(self) + + + Create(self, String name, String path=EmptyString) -> bool + + + + + + + IsAnotherRunning(self) -> bool + + + + DrawWindowOnDC(Window window, DC dc, int method) + + + + + + + +#--------------------------------------------------------------------------- + + + + __del__(self) + + + GetTip(self) -> String + + + GetCurrentTip(self) -> size_t + + + PreprocessTip(self, String tip) -> String + + + + + + + + + __init__(self, size_t currentTip) -> PyTipProvider + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + + ShowTip(Window parent, TipProvider tipProvider, bool showAtStartup=True) -> bool + + + + + + + + CreateFileTipProvider(String filename, size_t currentTip) -> TipProvider + + + - - GetChildrenCount(TreeItemId item, bool recursively=True) -> size_t + +#--------------------------------------------------------------------------- + + + + + __init__(self, EvtHandler owner=None, int id=-1) -> Timer + + + + + + + __del__(self) + + + _setCallbackInfo(self, PyObject self, PyObject _class, int incref=1) + + + + + + + + SetOwner(self, EvtHandler owner, int id=-1) + + + + + + + GetOwner(self) -> EvtHandler + + + Start(self, int milliseconds=-1, bool oneShot=False) -> bool + + + + + + + Stop(self) + + + IsRunning(self) -> bool + + + GetInterval(self) -> int + + + IsOneShot(self) -> bool + + + GetId(self) -> int + + + +# For backwards compatibility with 2.4 +class PyTimer(Timer): + def __init__(self, notify): + Timer.__init__(self) + self.notify = notify + + def Notify(self): + if self.notify: + self.notify() + + +EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 ) + + + + + + __init__(self, int timerid=0, int interval=0) -> TimerEvent + + + + + + + GetInterval(self) -> int + + + + + + + + + + __init__(self, wxTimer timer) -> TimerRunner +__init__(self, wxTimer timer, int milli, bool oneShot=False) -> TimerRunner + + + + + + + + __del__(self) + + + Start(self, int milli, bool oneShot=False) + + + + + + + +#--------------------------------------------------------------------------- + + + + __init__(self) -> Log + + + IsEnabled() -> bool + + + EnableLogging(bool doIt=True) -> bool + + + + + + OnLog(wxLogLevel level, wxChar szString, time_t t) + + + + + + + + Flush(self) + + + FlushActive() + + + GetActiveTarget() -> Log + + + SetActiveTarget(Log pLogger) -> Log + + + + + + Suspend() + + + Resume() + + + SetVerbose(bool bVerbose=True) + + + + + + SetLogLevel(wxLogLevel logLevel) + + + + + + DontCreateOnDemand() + + + SetTraceMask(wxTraceMask ulMask) + + + + + + AddTraceMask(String str) + + + + + + RemoveTraceMask(String str) + + + + + + ClearTraceMasks() + + + GetTraceMasks() -> wxArrayString + + + SetTimestamp(wxChar ts) + + + + + + GetVerbose() -> bool + + + GetTraceMask() -> wxTraceMask + + + IsAllowedTraceMask(wxChar mask) -> bool + + + + + + GetLogLevel() -> wxLogLevel + + + GetTimestamp() -> wxChar + + + TimeStamp() -> String + + + Destroy(self) + + + + + + __init__(self) -> LogStderr + + + + + + __init__(self, wxTextCtrl pTextCtrl) -> LogTextCtrl + + + + + + + + + __init__(self) -> LogGui + + + + + + __init__(self, wxFrame pParent, String szTitle, bool bShow=True, bool bPassToOld=True) -> LogWindow + + + + + + + + + Show(self, bool bShow=True) + + + + + + GetFrame(self) -> wxFrame + + + GetOldLog(self) -> Log + + + IsPassingMessages(self) -> bool + + + PassMessages(self, bool bDoPass) + + + + + + + + + __init__(self, Log logger) -> LogChain + + + + + + SetLog(self, Log logger) + + + + + + PassMessages(self, bool bDoPass) + + + + + + IsPassingMessages(self) -> bool + + + GetOldLog(self) -> Log + + + + SysErrorCode() -> unsigned long + + + SysErrorMsg(unsigned long nErrCode=0) -> String + + + + + + LogFatalError(String msg) + + + + + + LogError(String msg) + + + + + + LogWarning(String msg) + + + + + + LogMessage(String msg) - - + - - GetRootItem() -> TreeItemId - - - GetSelection() -> TreeItemId - - - GetSelections() -> PyObject - - - GetItemParent(TreeItemId item) -> TreeItemId + + LogInfo(String msg) - + - - GetFirstChild(TreeItemId item) -> PyObject + + LogDebug(String msg) - + - - GetNextChild(TreeItemId item, long cookie) -> PyObject + + LogVerbose(String msg) - - + - - GetLastChild(TreeItemId item) -> TreeItemId + + LogStatus(String msg) - + - - GetNextSibling(TreeItemId item) -> TreeItemId + + LogStatusFrame(wxFrame pFrame, String msg) - + + - - GetPrevSibling(TreeItemId item) -> TreeItemId + + LogSysError(String msg) - + - - GetFirstVisibleItem() -> TreeItemId - - - GetNextVisible(TreeItemId item) -> TreeItemId + - + + - - GetPrevVisible(TreeItemId item) -> TreeItemId + + LogTrace(unsigned long mask, String msg) +LogTrace(String mask, String msg) - - - - - GetNext(TreeItemId item) -> TreeItemId + + + + + + LogGeneric(unsigned long level, String msg) + + + + + + + SafeShowMessage(String title, String text) + + + + + + + + __init__(self) -> LogNull + + + __del__(self) + + + + + + __init__(self) -> PyLog + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, EvtHandler parent=None, int id=-1) -> Process + + + + + + + Kill(int pid, int sig=SIGTERM) -> int + + + + + + + Exists(int pid) -> bool + + + + + + Open(String cmd, int flags=EXEC_ASYNC) -> Process + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + base_OnTerminate(self, int pid, int status) + + + + + + + Redirect(self) + + + IsRedirected(self) -> bool + + + Detach(self) + + + GetInputStream(self) -> InputStream + + + GetErrorStream(self) -> InputStream + + + GetOutputStream(self) -> OutputStream + + + CloseOutput(self) + + + IsInputOpened(self) -> bool + + + IsInputAvailable(self) -> bool + + + IsErrorAvailable(self) -> bool + + + + + + __init__(self, int id=0, int pid=0, int exitcode=0) -> ProcessEvent + + + + + + + + GetPid(self) -> int + + + GetExitCode(self) -> int + + + + + +EVT_END_PROCESS = wx.PyEventBinder( wxEVT_END_PROCESS, 1 ) + + + Execute(String command, int flags=EXEC_ASYNC, Process process=None) -> long - + + + - - AddRoot(String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId + +#--------------------------------------------------------------------------- + + + + __init__(self, int joystick=JOYSTICK1) -> Joystick + + + + + + __del__(self) + + + GetPosition(self) -> Point + + + GetZPosition(self) -> int + + + GetButtonState(self) -> int + + + GetPOVPosition(self) -> int + + + GetPOVCTSPosition(self) -> int + + + GetRudderPosition(self) -> int + + + GetUPosition(self) -> int + + + GetVPosition(self) -> int + + + GetMovementThreshold(self) -> int + + + SetMovementThreshold(self, int threshold) + + + + + + IsOk(self) -> bool + + + GetNumberJoysticks(self) -> int + + + GetManufacturerId(self) -> int + + + GetProductId(self) -> int + + + GetProductName(self) -> String + + + GetXMin(self) -> int + + + GetYMin(self) -> int + + + GetZMin(self) -> int + + + GetXMax(self) -> int + + + GetYMax(self) -> int + + + GetZMax(self) -> int + + + GetNumberButtons(self) -> int + + + GetNumberAxes(self) -> int + + + GetMaxButtons(self) -> int + + + GetMaxAxes(self) -> int + + + GetPollingMin(self) -> int + + + GetPollingMax(self) -> int + + + GetRudderMin(self) -> int + + + GetRudderMax(self) -> int + + + GetUMin(self) -> int + + + GetUMax(self) -> int + + + GetVMin(self) -> int + + + GetVMax(self) -> int + + + HasRudder(self) -> bool + + + HasZ(self) -> bool + + + HasU(self) -> bool + + + HasV(self) -> bool + + + HasPOV(self) -> bool + + + HasPOV4Dir(self) -> bool + + + HasPOVCTS(self) -> bool + + + SetCapture(self, Window win, int pollingFreq=0) -> bool + + + + + + + ReleaseCapture(self) -> bool + + + + + + __init__(self, wxEventType type=wxEVT_NULL, int state=0, int joystick=JOYSTICK1, + int change=0) -> JoystickEvent + + + + + + + + + + + + + + GetPosition(self) -> Point + + + GetZPosition(self) -> int + + + GetButtonState(self) -> int + + + GetButtonChange(self) -> int + + + GetJoystick(self) -> int + + + SetJoystick(self, int stick) + + + + + + SetButtonState(self, int state) + + + + + + SetButtonChange(self, int change) + + + + + + SetPosition(self, Point pos) + + + + + + SetZPosition(self, int zPos) + + + + + + IsButton(self) -> bool + + + IsMove(self) -> bool + + + IsZMove(self) -> bool + + + ButtonDown(self, int but=JOY_BUTTON_ANY) -> bool + + + + + + ButtonUp(self, int but=JOY_BUTTON_ANY) -> bool + + + + + + ButtonIsDown(self, int but=JOY_BUTTON_ANY) -> bool + + + + + + +EVT_JOY_BUTTON_DOWN = wx.PyEventBinder( wxEVT_JOY_BUTTON_DOWN ) +EVT_JOY_BUTTON_UP = wx.PyEventBinder( wxEVT_JOY_BUTTON_UP ) +EVT_JOY_MOVE = wx.PyEventBinder( wxEVT_JOY_MOVE ) +EVT_JOY_ZMOVE = wx.PyEventBinder( wxEVT_JOY_ZMOVE ) + +EVT_JOYSTICK_EVENTS = wx.PyEventBinder([ wxEVT_JOY_BUTTON_DOWN, + wxEVT_JOY_BUTTON_UP, + wxEVT_JOY_MOVE, + wxEVT_JOY_ZMOVE, + ]) + + + +#--------------------------------------------------------------------------- + + + + __init__(self, String fileName=EmptyString) -> Sound + + + + + + SoundFromData(PyObject data) -> Sound + + + + + + __del__(self) + + + Create(self, String fileName) -> bool + + + + + + CreateFromData(self, PyObject data) -> bool + + + + + + IsOk(self) -> bool + + + Play(self, unsigned int flags=SOUND_ASYNC) -> bool + + + + + + PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool + + + + + + + Stop() + + + +#--------------------------------------------------------------------------- + + + + __init__(self, String mimeType, String openCmd, String printCmd, String desc) -> FileTypeInfo + + + + + + + + + FileTypeInfoSequence(wxArrayString sArray) -> FileTypeInfo + + + + + + NullFileTypeInfo() -> FileTypeInfo + + + IsValid(self) -> bool + + + SetIcon(self, String iconFile, int iconIndex=0) + + + + + + + SetShortDesc(self, String shortDesc) + + + + + + GetMimeType(self) -> String + + + GetOpenCommand(self) -> String + + + GetPrintCommand(self) -> String + + + GetShortDesc(self) -> String + + + GetDescription(self) -> String + + + GetExtensions(self) -> wxArrayString + + + GetExtensionsCount(self) -> int + + + GetIconFile(self) -> String + + + GetIconIndex(self) -> int + + + + + __init__(self, FileTypeInfo ftInfo) -> FileType + + + + + + __del__(self) + + + GetMimeType(self) -> PyObject + + + GetMimeTypes(self) -> PyObject + + + GetExtensions(self) -> PyObject + + + GetIcon(self) -> Icon + + + GetIconInfo(self) -> PyObject + + + GetDescription(self) -> PyObject + + + GetOpenCommand(self, String filename, String mimetype=EmptyString) -> PyObject + + + + + + + GetPrintCommand(self, String filename, String mimetype=EmptyString) -> PyObject + + + + + + + GetAllCommands(self, String filename, String mimetype=EmptyString) -> PyObject + + + + + + + SetCommand(self, String cmd, String verb, bool overwriteprompt=True) -> bool + + + + + + + + SetDefaultIcon(self, String cmd=EmptyString, int index=0) -> bool + + + + + + + Unassociate(self) -> bool + + + ExpandCommand(String command, String filename, String mimetype=EmptyString) -> String + + + + + + + + + + __init__(self) -> MimeTypesManager + + + __del__(self) + + + IsOfType(String mimeType, String wildcard) -> bool + + + + + + + Initialize(self, int mailcapStyle=MAILCAP_ALL, String extraDir=EmptyString) + + + + + + + ClearData(self) + + + GetFileTypeFromExtension(self, String ext) -> FileType + + + + + + GetFileTypeFromMimeType(self, String mimeType) -> FileType + + + + + + ReadMailcap(self, String filename, bool fallback=False) -> bool + + + + + + + ReadMimeTypes(self, String filename) -> bool + + + + + + EnumAllFileTypes(self) -> PyObject + + + AddFallback(self, FileTypeInfo ft) + + + + + + Associate(self, FileTypeInfo ftInfo) -> FileType + + + + + + Unassociate(self, FileType ft) -> 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__(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(self, PyObject self, PyObject _class) + + + + + + + PushProvider(ArtProvider provider) + Add new provider to the top of providers stack. + + + + + + PopProvider() -> bool + Remove latest added provider and delete it. + + + RemoveProvider(ArtProvider provider) -> bool + Remove provider. The provider must have been added previously! The +provider is _not_ deleted. + + + + + + GetBitmap(String id, String client=ART_OTHER, Size size=DefaultSize) -> Bitmap + Query the providers for bitmap with given ID and return it. Return +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 +wx.NullIcon if no provider provides it. + + + + + + + + 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. + +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. + + + __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. + + + + + + Get(bool createOnDemand=True) -> ConfigBase + Returns the current global config object, creating one if neccessary. + + + + + + Create() -> ConfigBase + Create and return a new global config object. This function will +create the "best" implementation of wx.Config available for the +current platform. + + + DontCreateOnDemand() + Should Get() try to create a new log object if there isn't a current +one? + + + 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(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. + + + 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. + + + + + + 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 +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 +GetNextGroup to fetch the next item. + + + + + + GetNumberOfEntries(self, bool recursive=False) -> size_t + Get the number of entries 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(self, String name) -> bool + Returns True if the group by this name exists + + + + + + HasEntry(self, String name) -> bool + Returns True if the entry by this name exists + + + + + + Exists(self, String name) -> bool + Returns True if either a group or an entry with a given name exists + + + + + + GetEntryType(self, String name) -> int + Get the type of the entry. Returns one of the wx.Config.Type_XXX values. + + + + + + Read(self, String key, String defaultVal=EmptyString) -> String + Returns the value of key if it exists, defaultVal otherwise. + + + + + + + ReadInt(self, String key, long defaultVal=0) -> long + Returns the value of key if it exists, defaultVal otherwise. + + + + + + + ReadFloat(self, String key, double defaultVal=0.0) -> double + Returns the value of key if it exists, defaultVal otherwise. + + + + + + + ReadBool(self, String key, bool defaultVal=False) -> bool + Returns the value of key if it exists, defaultVal otherwise. + + + + + + + Write(self, String key, String value) -> bool + write the value (return True on success) + + + + + + + WriteInt(self, String key, long value) -> bool + write the value (return True on success) + + + + + + + WriteFloat(self, String key, double value) -> bool + write the value (return True on success) + + + + + + + WriteBool(self, String key, bool value) -> bool + write the value (return True on success) + + + + + + + Flush(self, bool currentOnly=False) -> bool + permanently writes all changes + + + + + + 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) + + + + + + + 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) + + + + + + + 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(self, String key) -> bool + Delete the group (with all subgroups) + + + + + + DeleteAll(self) -> bool + Delete the whole underlying object (disk file, registry key, ...) +primarly intended for use by deinstallation routine. + + + 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(self) -> bool + Are we currently expanding environment variables? + + + SetRecordDefaults(self, bool doIt=True) + Set whether the config objec should record default values. + + + + + + IsRecordingDefaults(self) -> bool + Are we currently recording default values? + + + ExpandEnvVars(self, String str) -> String + Expand any environment variables in str and return the result + + + + + + GetAppName(self) -> String + + + GetVendorName(self) -> String + + + SetAppName(self, String appName) + + + + + + SetVendorName(self, String vendorName) + + + + + + SetStyle(self, long style) + + + + + + GetStyle(self) -> long + + + + This ConfigBase-derived class will use the registry on Windows, +and will be a wx.FileConfig on other platforms. + + + __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 + + + + + + + + + + __del__(self) + + + + This config class will use a file for storage on all platforms. + + + __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 + + + + + + + + + + __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. + + __init__(self, ConfigBase config, String entry) -> ConfigPathChanger + + + + + + + __del__(self) + + + 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. + + + + + +#--------------------------------------------------------------------------- + + + + __init__(self) -> DateTime + + + DateTimeFromTimeT(time_t timet) -> DateTime + + + + + + DateTimeFromJDN(double jdn) -> DateTime + + + + + + DateTimeFromHMS(int hour, int minute=0, int second=0, int millisec=0) -> DateTime + + + + + + + + + DateTimeFromDMY(int day, int month=Inv_Month, int year=Inv_Year, int hour=0, + int minute=0, int second=0, int millisec=0) -> DateTime + + + + + + + + + + + + __del__(self) + + + SetCountry(int country) + + + + + + GetCountry() -> int + + + IsWestEuropeanCountry(int country=Country_Default) -> bool + + + + + + GetCurrentYear(int cal=Gregorian) -> int + + + + + + ConvertYearToBC(int year) -> int + + + + + + GetCurrentMonth(int cal=Gregorian) -> int + + + + + + IsLeapYear(int year=Inv_Year, int cal=Gregorian) -> bool + + + + + + + GetCentury(int year=Inv_Year) -> int + + + + + + GetNumberOfDaysinYear(int year, int cal=Gregorian) -> int + + + + + + + GetNumberOfDaysInMonth(int month, int year=Inv_Year, int cal=Gregorian) -> int + + + + + + + + GetMonthName(int month, int flags=Name_Full) -> String + + + + + + + GetWeekDayName(int weekday, int flags=Name_Full) -> String + + + + + + + GetAmPmStrings() -> (am, pm) + Get the AM and PM strings in the current locale (may be empty) + + + + + + + IsDSTApplicable(int year=Inv_Year, int country=Country_Default) -> bool + + + + + + + GetBeginDST(int year=Inv_Year, int country=Country_Default) -> DateTime + + + + + + + GetEndDST(int year=Inv_Year, int country=Country_Default) -> DateTime + + + + + + + Now() -> DateTime + + + UNow() -> DateTime + + + Today() -> DateTime + + + SetToCurrent(self) -> DateTime + + + SetTimeT(self, time_t timet) -> DateTime + + + + + + SetJDN(self, double jdn) -> DateTime + + + + + + SetHMS(self, int hour, int minute=0, int second=0, int millisec=0) -> DateTime + + + + + + + + + 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 + + + + + + + + + + + + ResetTime(self) -> DateTime + + + SetYear(self, int year) -> DateTime + + + + + + SetMonth(self, int month) -> DateTime + + + + + + SetDay(self, int day) -> DateTime + + + + + + SetHour(self, int hour) -> DateTime + + + + + + SetMinute(self, int minute) -> DateTime + + + + + + SetSecond(self, int second) -> DateTime + + + + + + SetMillisecond(self, int millisecond) -> DateTime + + + + + + SetToWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime + + + + + + + GetWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime + + + + + + + SetToNextWeekDay(self, int weekday) -> DateTime + + + + + + GetNextWeekDay(self, int weekday) -> DateTime + + + + + + SetToPrevWeekDay(self, int weekday) -> DateTime + + + + + + GetPrevWeekDay(self, int weekday) -> DateTime + + + + + + SetToWeekDay(self, int weekday, int n=1, int month=Inv_Month, int year=Inv_Year) -> bool + + + + + + + + + SetToLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> bool + + + + + + + + GetLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> DateTime + + + + + + + + SetToTheWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> bool + + + + + + + + GetWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> DateTime + + + + + + + + SetToLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime + + + + + + + GetLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime + + + + + + + SetToYearDay(self, int yday) -> DateTime + + + + + + GetYearDay(self, int yday) -> DateTime + + + + + + GetJulianDayNumber(self) -> double + + + GetJDN(self) -> double + + + GetModifiedJulianDayNumber(self) -> double + + + GetMJD(self) -> double + + + GetRataDie(self) -> double + + + ToTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime + + + + + + + MakeTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime + + + + + + + ToGMT(self, bool noDST=False) -> DateTime + + + + + + MakeGMT(self, bool noDST=False) -> DateTime + + + + + + IsDST(self, int country=Country_Default) -> int + + + + + + IsValid(self) -> bool + + + GetTicks(self) -> time_t + + + GetYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + + + + + + GetMonth(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + + + + + + GetDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + + + + + + GetWeekDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + + + + + + GetHour(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + + + + + + GetMinute(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + + + + + + GetSecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + + + + + + GetMillisecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + + + + + + GetDayOfYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + + + + + + GetWeekOfYear(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + + + + + + + GetWeekOfMonth(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int + + + + + + + IsWorkDay(self, int country=Country_Default) -> bool + + + + + + IsEqualTo(self, DateTime datetime) -> bool + + + + + + IsEarlierThan(self, DateTime datetime) -> bool + + + + + + IsLaterThan(self, DateTime datetime) -> bool + + + + + + IsStrictlyBetween(self, DateTime t1, DateTime t2) -> bool + + + + + + + IsBetween(self, DateTime t1, DateTime t2) -> bool + + + + + + + IsSameDate(self, DateTime dt) -> bool + + + + + + IsSameTime(self, DateTime dt) -> bool + + + + + + IsEqualUpTo(self, DateTime dt, TimeSpan ts) -> bool + + + + + + + AddTS(self, TimeSpan diff) -> DateTime + + + + + + AddDS(self, DateSpan diff) -> DateTime + + + + + + SubtractTS(self, TimeSpan diff) -> DateTime + + + + + + SubtractDS(self, DateSpan diff) -> DateTime + + + + + + Subtract(self, DateTime dt) -> TimeSpan + + + + + + + + + + + __iadd__(self, TimeSpan diff) -> DateTime +__iadd__(self, DateSpan diff) -> DateTime + + + + + + + + + + + __isub__(self, TimeSpan diff) -> DateTime +__isub__(self, DateSpan diff) -> DateTime + + + + + + + + + + + __add__(self, TimeSpan other) -> DateTime +__add__(self, DateSpan other) -> DateTime + + + + + + + + + + + + + + + + __sub__(self, DateTime other) -> TimeSpan +__sub__(self, TimeSpan other) -> DateTime +__sub__(self, DateSpan other) -> DateTime + + + + + + __lt__(self, DateTime other) -> bool + + + + + + __le__(self, DateTime other) -> bool + + + + + + __gt__(self, DateTime other) -> bool + + + + + + __ge__(self, DateTime other) -> bool + + + + + + __eq__(self, DateTime other) -> bool + + + + + + __ne__(self, DateTime other) -> bool + + + + + + ParseRfc822Date(self, String date) -> int + + + + + + ParseFormat(self, String date, String format=DateFormatStr, DateTime dateDef=DefaultDateTime) -> int + + + + + + + + ParseDateTime(self, String datetime) -> int + + + + + + ParseDate(self, String date) -> int + + + + + + ParseTime(self, String time) -> int + + + + + + Format(self, String format=DateFormatStr, wxDateTime::TimeZone tz=LOCAL_TZ) -> String + + + + + + + FormatDate(self) -> String + + + FormatTime(self) -> String + + + FormatISODate(self) -> String + + + FormatISOTime(self) -> String + + + + + __init__(self, long hours=0, long minutes=0, long seconds=0, long milliseconds=0) -> TimeSpan + + + + + + + + + __del__(self) + + + Seconds(long sec) -> TimeSpan + + + + + + Second() -> TimeSpan + + + Minutes(long min) -> TimeSpan + + + + + + Minute() -> TimeSpan + + + Hours(long hours) -> TimeSpan + + + + + + Hour() -> TimeSpan + + + Days(long days) -> TimeSpan + + + + + + Day() -> TimeSpan + + + Weeks(long days) -> TimeSpan + + + + + + Week() -> TimeSpan + + + Add(self, TimeSpan diff) -> TimeSpan + + + + + + Subtract(self, TimeSpan diff) -> TimeSpan + + + + + + Multiply(self, int n) -> TimeSpan + + + + + + Neg(self) -> TimeSpan + + + Abs(self) -> TimeSpan + + + __iadd__(self, TimeSpan diff) -> TimeSpan + + + + + + __isub__(self, TimeSpan diff) -> TimeSpan + + + + + + __imul__(self, int n) -> TimeSpan + + + + + + __neg__(self) -> TimeSpan + + + __add__(self, TimeSpan other) -> TimeSpan + + + + + + __sub__(self, TimeSpan other) -> TimeSpan + + + + + + __mul__(self, int n) -> TimeSpan + + + + + + __rmul__(self, int n) -> TimeSpan + + + + + + __lt__(self, TimeSpan other) -> bool + + + + + + __le__(self, TimeSpan other) -> bool + + + + + + __gt__(self, TimeSpan other) -> bool + + + + + + __ge__(self, TimeSpan other) -> bool + + + + + + __eq__(self, TimeSpan other) -> bool + + + + + + __ne__(self, TimeSpan other) -> bool + + + + + + IsNull(self) -> bool + + + IsPositive(self) -> bool + + + IsNegative(self) -> bool + + + IsEqualTo(self, TimeSpan ts) -> bool + + + + + + IsLongerThan(self, TimeSpan ts) -> bool + + + + + + IsShorterThan(self, TimeSpan t) -> bool + + + + + + GetWeeks(self) -> int + + + GetDays(self) -> int + + + GetHours(self) -> int + + + GetMinutes(self) -> int + + + GetSeconds(self) -> wxLongLong + + + GetMilliseconds(self) -> wxLongLong + + + Format(self, String format=TimeSpanFormatStr) -> String + + + + + + + + __init__(self, int years=0, int months=0, int weeks=0, int days=0) -> DateSpan + + + + + + + + + __del__(self) + + + Days(int days) -> DateSpan + + + + + + Day() -> DateSpan + + + Weeks(int weeks) -> DateSpan + + + + + + Week() -> DateSpan + + + Months(int mon) -> DateSpan + + + + + + Month() -> DateSpan + + + Years(int years) -> DateSpan + + + + + + Year() -> DateSpan + + + SetYears(self, int n) -> DateSpan + + + + + + SetMonths(self, int n) -> DateSpan + + + + + + SetWeeks(self, int n) -> DateSpan + + + + + + SetDays(self, int n) -> DateSpan + + + + + + GetYears(self) -> int + + + GetMonths(self) -> int + + + GetWeeks(self) -> int + + + GetDays(self) -> int + + + GetTotalDays(self) -> int + + + Add(self, DateSpan other) -> DateSpan + + + + + + Subtract(self, DateSpan other) -> DateSpan + + + + + + Neg(self) -> DateSpan + + + Multiply(self, int factor) -> DateSpan + + + + + + __iadd__(self, DateSpan other) -> DateSpan + + + + + + __isub__(self, DateSpan other) -> DateSpan + + + + + + __neg__(self) -> DateSpan + + + __imul__(self, int factor) -> DateSpan + + + + + + __add__(self, DateSpan other) -> DateSpan + + + + + + __sub__(self, DateSpan other) -> DateSpan + + + + + + __mul__(self, int n) -> DateSpan + + + + + + __rmul__(self, int n) -> DateSpan + + + + + + __eq__(self, DateSpan other) -> bool + + + + + + __ne__(self, DateSpan other) -> bool + + + + + + + GetLocalTime() -> long + + + GetUTCTime() -> long + + + GetCurrentTime() -> long + + + GetLocalTimeMillis() -> wxLongLong + + +#--------------------------------------------------------------------------- + + + 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, (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__(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. + + + + + + __del__(self) + + + + + + + + + + + + + __eq__(self, int format) -> bool +__eq__(self, DataFormat format) -> bool + + + + + + __ne__(self, int format) -> bool +__ne__(self, DataFormat format) -> bool + + + + + + SetType(self, int format) + Sets the format to the given value, which should be one of wx.DF_XXX +constants. + + + + + + GetType(self) -> int + Returns the platform-specific number identifying the format. + + + GetId(self) -> String + Returns the name of a custom format (this function will fail for a +standard 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__(self) + + + 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(self, int dir=Get) -> size_t + Returns the number of available formats for rendering or setting the +data. + + + + + + IsSupported(self, DataFormat format, int dir=Get) -> bool + Returns True if this format is supported. + + + + + + + GetDataSize(self, DataFormat format) -> size_t + Get the (total) size of data for the given format + + + + + + GetAllFormats(self, int dir=Get) -> [formats] + Returns a list of all the wx.DataFormats that this dataobject supports +in the given direction. + + + + + + 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(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__(self, DataFormat format=FormatInvalid) -> DataObjectSimple + Constructor accepts the supported format (none by default) which may +also be set later with `SetFormat`. + + + + + + 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(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__(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(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__(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(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__(self, String text=EmptyString) -> TextDataObject + Constructor, may be used to initialise the text (otherwise `SetText` +should be used later). + + + + + + 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(self) -> String + Returns the text associated with the data object. + + + 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__(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(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__(self, Bitmap bitmap=wxNullBitmap) -> BitmapDataObject + Constructor, optionally passing a bitmap (otherwise use `SetBitmap` +later). + + + + + + 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(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__(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(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__(self) -> FileDataObject + + + GetFilenames(self) -> [names] + Returns a list of file names. + + + 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__(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. + + + + + + SetData(self, String data) -> bool + Copy the data value to the data object. + + + + + + GetSize(self) -> size_t + Get the size of the data. + + + 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__(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(self) -> String + Returns a string containing the current URL. + + + SetURL(self, String url) + Set the URL. + + + + + + + + + __init__(self) -> MetafileDataObject + + + +#--------------------------------------------------------------------------- + + + IsDragResultOk(int res) -> bool - - - - + - - PrependItem(TreeItemId parent, String text, int image=-1, int selectedImage=-1, + + + __init__(self, Window win, Icon copy=wxNullIcon, Icon move=wxNullIcon, + Icon none=wxNullIcon) -> DropSource + + + + + + + + + __del__(self) + + + _setCallbackInfo(self, PyObject self, PyObject _class, int incref) + + + + + + + + SetData(self, DataObject data) + + + + + + GetDataObject(self) -> DataObject + + + SetCursor(self, int res, Cursor cursor) + + + + + + + DoDragDrop(self, int flags=Drag_CopyOnly) -> int + + + + + + base_GiveFeedback(self, int effect) -> bool + + + + + + + + __init__(self, DataObject dataObject=None) -> DropTarget + + + + + + __del__(self) + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + GetDataObject(self) -> DataObject + + + SetDataObject(self, DataObject dataObject) + + + + + + base_OnEnter(self, int x, int y, int def) -> int + + + + + + + + base_OnDragOver(self, int x, int y, int def) -> int + + + + + + + + base_OnLeave(self) + + + base_OnDrop(self, int x, int y) -> bool + + + + + + + GetData(self) -> bool + + + PyDropTarget = DropTarget + + + + __init__(self) -> TextDropTarget + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + base_OnEnter(self, int x, int y, int def) -> int + + + + + + + + base_OnDragOver(self, int x, int y, int def) -> int + + + + + + + + base_OnLeave(self) + + + base_OnDrop(self, int x, int y) -> bool + + + + + + + base_OnData(self, int x, int y, int def) -> int + + + + + + + + + + + __init__(self) -> FileDropTarget + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + base_OnEnter(self, int x, int y, int def) -> int + + + + + + + + base_OnDragOver(self, int x, int y, int def) -> int + + + + + + + + base_OnLeave(self) + + + base_OnDrop(self, int x, int y) -> bool + + + + + + + base_OnData(self, int x, int y, int def) -> int + + + + + + + + +#--------------------------------------------------------------------------- + + + 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__(self) -> Clipboard + + + __del__(self) + + + 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(self) + Closes the clipboard. + + + IsOpened(self) -> bool + Query whether the clipboard is opened + + + 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. + +:see: `wx.DataObject` + + + + + + SetData(self, DataObject data) -> bool + Set the clipboard data, this is the same as `Clear` followed by +`AddData`. + +:see: `wx.DataObject` + + + + + + IsSupported(self, DataFormat format) -> bool + Returns True if the given format is available in the data object(s) on +the clipboard. + + + + + + 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(self) + Clears data from the clipboard object and also the system's clipboard +if possible. + + + 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. + + + 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. + + + + 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__(self, Clipboard clipboard=None) -> ClipboardLocker + A helpful class for opening the clipboard and automatically +closing it when the locker is destroyed. + + + + + + __del__(self) + + + __nonzero__(self) -> bool + A ClipboardLocker instance evaluates to True if the clipboard was +successfully opened. + + + +#--------------------------------------------------------------------------- + + + A simple struct containing video mode parameters for a display + + __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 + + + + + + + + + __del__(self) + + + 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(self) -> int + Returns the screen width in pixels (e.g. 640*480), 0 means unspecified + + + GetHeight(self) -> int + Returns the screen width in pixels (e.g. 640*480), 0 means +unspecified + + + GetDepth(self) -> int + Returns the screen's bits per pixel (e.g. 32), 1 is monochrome and 0 +means unspecified/known + + + IsOk(self) -> bool + returns true if the object has been initialized + + + __eq__(self, VideoMode other) -> bool + + + + + + __ne__(self, VideoMode other) -> bool + + + + + + + + + + + Represents a display/monitor attached to the system + + __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__(self) + + + GetCount() -> size_t + Return the number of available displays. + + + GetFromPoint(Point pt) -> int + 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. + + + + + + IsOk(self) -> bool + Return true if the object was initialized successfully + + + GetGeometry(self) -> Rect + Returns the bounding rectangle of the display whose index was passed +to the constructor. + + + GetName(self) -> String + Returns the display's name. A name is not available on all platforms. + + + 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()). + +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(self) -> VideoMode + Get the current video mode. + + + 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(self) + Restore the default video mode (just a more readable synonym) + + + + + + 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. + + __init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour, + Colour colBorder=wxNullColour, Font font=wxNullFont, + int border=CAL_BORDER_NONE) -> CalendarDateAttr + Create a CalendarDateAttr. + + + + + + + + + + SetTextColour(self, Colour colText) + + + + + + SetBackgroundColour(self, Colour colBack) + + + + + + SetBorderColour(self, Colour col) + + + + + + SetFont(self, Font font) + + + + + + SetBorder(self, int border) + + + + + + SetHoliday(self, bool holiday) + + + + + + HasTextColour(self) -> bool + + + HasBackgroundColour(self) -> bool + + + HasBorderColour(self) -> bool + + + HasFont(self) -> bool + + + HasBorder(self) -> bool + + + IsHoliday(self) -> bool + + + GetTextColour(self) -> Colour + + + GetBackgroundColour(self) -> Colour + + + GetBorderColour(self) -> Colour + + + GetFont(self) -> Font + + + GetBorder(self) -> int + + + + + + __init__(self, CalendarCtrl cal, wxEventType type) -> CalendarEvent + + + + + + + GetDate(self) -> DateTime + + + SetDate(self, DateTime date) + + + + + + SetWeekDay(self, int wd) + + + + + + GetWeekDay(self) -> int + + + +EVT_CALENDAR = wx.PyEventBinder( wxEVT_CALENDAR_DOUBLECLICKED, 1) +EVT_CALENDAR_SEL_CHANGED = wx.PyEventBinder( wxEVT_CALENDAR_SEL_CHANGED, 1) +EVT_CALENDAR_DAY = wx.PyEventBinder( wxEVT_CALENDAR_DAY_CHANGED, 1) +EVT_CALENDAR_MONTH = wx.PyEventBinder( wxEVT_CALENDAR_MONTH_CHANGED, 1) +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. + +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__(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. + + + + + + + + + + + + PreCalendarCtrl() -> CalendarCtrl + Precreate a CalendarCtrl for 2-phase creation. + + + 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. + + + + + + + + + + + + SetDate(self, DateTime date) + Sets the current date. + + + + + + GetDate(self) -> DateTime + Gets the currently selected date. + + + SetLowerDateLimit(self, DateTime date=DefaultDateTime) -> bool + set the range in which selection can occur + + + + + + SetUpperDateLimit(self, DateTime date=DefaultDateTime) -> bool + set the range in which selection can occur + + + + + + GetLowerDateLimit(self) -> DateTime + get the range in which selection can occur + + + GetUpperDateLimit(self) -> DateTime + get the range in which selection can occur + + + SetDateRange(self, DateTime lowerdate=DefaultDateTime, DateTime upperdate=DefaultDateTime) -> bool + set the range in which selection can occur + + + + + + + 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. + + + + + + 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(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(self, Colour colFg, Colour colBg) + 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(self) -> Colour + Header colours are used for painting the weekdays at the top. + + + SetHighlightColours(self, Colour colFg, Colour colBg) + Highlight colour is used for the currently selected date. + + + + + + + GetHighlightColourFg(self) -> Colour + Highlight colour is used for the currently selected date. + + + GetHighlightColourBg(self) -> Colour + Highlight colour is used for the currently selected date. + + + SetHolidayColours(self, Colour colFg, Colour colBg) + 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(self) -> Colour + Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is +used). + + + 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(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(self, size_t day) + Marks the specified day as being a holiday in the current month. + + + + + + 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. + =================== ============================================ + + + + + + + GetMonthControl(self) -> Control + Get the currently shown control for month. + + + 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 + __docfilter__ = wx.__DocFilter(globals()) + + + _setOORInfo(self, PyObject _self) + + + + + + SetParameters(self, String params) + + + + + + IncRef(self) + + + DecRef(self) + + + Draw(self, Grid grid, GridCellAttr attr, DC dc, Rect rect, int row, + int col, bool isSelected) + + + + + + + + + + + + GetBestSize(self, Grid grid, GridCellAttr attr, DC dc, int row, int col) -> Size + + + + + + + + + + Clone(self) -> GridCellRenderer + + + + + + __init__(self) -> PyGridCellRenderer + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + base_SetParameters(self, String params) + + + + + + + + + __init__(self) -> GridCellStringRenderer + + + + + + __init__(self) -> GridCellNumberRenderer + + + + + + __init__(self, int width=-1, int precision=-1) -> GridCellFloatRenderer + + + + + + + GetWidth(self) -> int + + + SetWidth(self, int width) + + + + + + GetPrecision(self) -> int + + + SetPrecision(self, int precision) + + + + + + + + + __init__(self) -> GridCellBoolRenderer + + + + + + __init__(self, String outformat=DateTimeFormatStr, String informat=DateTimeFormatStr) -> GridCellDateTimeRenderer + + + + + + + + + + __init__(self, String choices=EmptyString) -> GridCellEnumRenderer + + + + + + + + + __init__(self) -> GridCellAutoWrapStringRenderer + + + + + _setOORInfo(self, PyObject _self) + + + + + + IsCreated(self) -> bool + + + GetControl(self) -> Control + + + SetControl(self, Control control) + + + + + + GetCellAttr(self) -> GridCellAttr + + + SetCellAttr(self, GridCellAttr attr) + + + + + + SetParameters(self, String params) + + + + + + IncRef(self) + + + DecRef(self) + + + Create(self, Window parent, int id, EvtHandler evtHandler) + + + + + + + + BeginEdit(self, int row, int col, Grid grid) + + + + + + + + EndEdit(self, int row, int col, Grid grid) -> bool + + + + + + + + Reset(self) + + + Clone(self) -> GridCellEditor + + + SetSize(self, Rect rect) + + + + + + Show(self, bool show, GridCellAttr attr=None) + + + + + + + PaintBackground(self, Rect rectCell, GridCellAttr attr) + + + + + + + IsAcceptedKey(self, KeyEvent event) -> bool + + + + + + StartingKey(self, KeyEvent event) + + + + + + StartingClick(self) + + + HandleReturn(self, KeyEvent event) + + + + + + Destroy(self) + + + + + + __init__(self) -> PyGridCellEditor + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + base_SetSize(self, Rect rect) + + + + + + base_Show(self, bool show, GridCellAttr attr=None) + + + + + + + base_PaintBackground(self, Rect rectCell, GridCellAttr attr) + + + + + + + base_IsAcceptedKey(self, KeyEvent event) -> bool + + + + + + base_StartingKey(self, KeyEvent event) + + + + + + base_StartingClick(self) + + + base_HandleReturn(self, KeyEvent event) + + + + + + base_Destroy(self) + + + base_SetParameters(self, String params) + + + + + + + + + __init__(self) -> GridCellTextEditor + + + GetValue(self) -> String + + + + + + __init__(self, int min=-1, int max=-1) -> GridCellNumberEditor + + + + + + + GetValue(self) -> String + + + + + + __init__(self, int width=-1, int precision=-1) -> GridCellFloatEditor + + + + + + + GetValue(self) -> String + + + + + + __init__(self) -> GridCellBoolEditor + + + GetValue(self) -> String + + + + + + __init__(self, int choices=0, String choices_array=None, bool allowOthers=False) -> GridCellChoiceEditor + + + + + + + + GetValue(self) -> String + + + + + + __init__(self, String choices=EmptyString) -> GridCellEnumEditor + + + + + + GetValue(self) -> String + + + + + + __init__(self) -> GridCellAutoWrapStringEditor + + + GetValue(self) -> String + + + + + __init__(self, GridCellAttr attrDefault=None) -> GridCellAttr + + + + + + _setOORInfo(self, PyObject _self) + + + + + + Clone(self) -> GridCellAttr + + + MergeWith(self, GridCellAttr mergefrom) + + + + + + IncRef(self) + + + DecRef(self) + + + SetTextColour(self, Colour colText) + + + + + + SetBackgroundColour(self, Colour colBack) + + + + + + SetFont(self, Font font) + + + + + + SetAlignment(self, int hAlign, int vAlign) + + + + + + + SetSize(self, int num_rows, int num_cols) + + + + + + + SetOverflow(self, bool allow=True) + + + + + + SetReadOnly(self, bool isReadOnly=True) + + + + + + SetRenderer(self, GridCellRenderer renderer) + + + + + + SetEditor(self, GridCellEditor editor) + + + + + + SetKind(self, int kind) + + + + + + HasTextColour(self) -> bool + + + HasBackgroundColour(self) -> bool + + + HasFont(self) -> bool + + + HasAlignment(self) -> bool + + + HasRenderer(self) -> bool + + + HasEditor(self) -> bool + + + HasReadWriteMode(self) -> bool + + + HasOverflowMode(self) -> bool + + + GetTextColour(self) -> Colour + + + GetBackgroundColour(self) -> Colour + + + GetFont(self) -> Font + + + GetAlignment() -> (hAlign, vAlign) + + + + + + + GetSize() -> (num_rows, num_cols) + + + + + + + GetOverflow(self) -> bool + + + GetRenderer(self, Grid grid, int row, int col) -> GridCellRenderer + + + + + + + + GetEditor(self, Grid grid, int row, int col) -> GridCellEditor + + + + + + + + IsReadOnly(self) -> bool + + + GetKind(self) -> int + + + SetDefAttr(self, GridCellAttr defAttr) + + + + + + + + __init__(self) -> GridCellAttrProvider + + + _setOORInfo(self, PyObject _self) + + + + + + GetAttr(self, int row, int col, int kind) -> GridCellAttr + + + + + + + + SetAttr(self, GridCellAttr attr, int row, int col) + + + + + + + + SetRowAttr(self, GridCellAttr attr, int row) + + + + + + + SetColAttr(self, GridCellAttr attr, int col) + + + + + + + UpdateAttrRows(self, size_t pos, int numRows) + + + + + + + UpdateAttrCols(self, size_t pos, int numCols) + + + + + + + + + + __init__(self) -> PyGridCellAttrProvider + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + base_GetAttr(self, int row, int col, int kind) -> GridCellAttr + + + + + + + + base_SetAttr(self, GridCellAttr attr, int row, int col) + + + + + + + + base_SetRowAttr(self, GridCellAttr attr, int row) + + + + + + + base_SetColAttr(self, GridCellAttr attr, int col) + + + + + + + + + + _setOORInfo(self, PyObject _self) + + + + + + SetAttrProvider(self, GridCellAttrProvider attrProvider) + + + + + + GetAttrProvider(self) -> GridCellAttrProvider + + + SetView(self, Grid grid) + + + + + + GetView(self) -> Grid + + + GetNumberRows(self) -> int + + + GetNumberCols(self) -> int + + + IsEmptyCell(self, int row, int col) -> bool + + + + + + + GetValue(self, int row, int col) -> String + + + + + + + SetValue(self, int row, int col, String value) + + + + + + + + GetTypeName(self, int row, int col) -> String + + + + + + + CanGetValueAs(self, int row, int col, String typeName) -> bool + + + + + + + + CanSetValueAs(self, int row, int col, String typeName) -> bool + + + + + + + + GetValueAsLong(self, int row, int col) -> long + + + + + + + GetValueAsDouble(self, int row, int col) -> double + + + + + + + GetValueAsBool(self, int row, int col) -> bool + + + + + + + SetValueAsLong(self, int row, int col, long value) + + + + + + + + SetValueAsDouble(self, int row, int col, double value) + + + + + + + + SetValueAsBool(self, int row, int col, bool value) + + + + + + + + Clear(self) + + + InsertRows(self, size_t pos=0, size_t numRows=1) -> bool + + + + + + + AppendRows(self, size_t numRows=1) -> bool + + + + + + DeleteRows(self, size_t pos=0, size_t numRows=1) -> bool + + + + + + + InsertCols(self, size_t pos=0, size_t numCols=1) -> bool + + + + + + + AppendCols(self, size_t numCols=1) -> bool + + + + + + DeleteCols(self, size_t pos=0, size_t numCols=1) -> bool + + + + + + + GetRowLabelValue(self, int row) -> String + + + + + + GetColLabelValue(self, int col) -> String + + + + + + SetRowLabelValue(self, int row, String value) + + + + + + + SetColLabelValue(self, int col, String value) + + + + + + + CanHaveAttributes(self) -> bool + + + GetAttr(self, int row, int col, int kind) -> GridCellAttr + + + + + + + + SetAttr(self, GridCellAttr attr, int row, int col) + + + + + + + + SetRowAttr(self, GridCellAttr attr, int row) + + + + + + + SetColAttr(self, GridCellAttr attr, int col) + + + + + + + + + + __init__(self) -> PyGridTableBase + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + Destroy(self) + Deletes the C++ object this Python object is a proxy for. + + + base_GetTypeName(self, int row, int col) -> String + + + + + + + base_CanGetValueAs(self, int row, int col, String typeName) -> bool + + + + + + + + base_CanSetValueAs(self, int row, int col, String typeName) -> bool + + + + + + + + base_Clear(self) + + + base_InsertRows(self, size_t pos=0, size_t numRows=1) -> bool + + + + + + + base_AppendRows(self, size_t numRows=1) -> bool + + + + + + base_DeleteRows(self, size_t pos=0, size_t numRows=1) -> bool + + + + + + + base_InsertCols(self, size_t pos=0, size_t numCols=1) -> bool + + + + + + + base_AppendCols(self, size_t numCols=1) -> bool + + + + + + base_DeleteCols(self, size_t pos=0, size_t numCols=1) -> bool + + + + + + + base_GetRowLabelValue(self, int row) -> String + + + + + + base_GetColLabelValue(self, int col) -> String + + + + + + base_SetRowLabelValue(self, int row, String value) + + + + + + + base_SetColLabelValue(self, int col, String value) + + + + + + + base_CanHaveAttributes(self) -> bool + + + base_GetAttr(self, int row, int col, int kind) -> GridCellAttr + + + + + + + + base_SetAttr(self, GridCellAttr attr, int row, int col) + + + + + + + + base_SetRowAttr(self, GridCellAttr attr, int row) + + + + + + + base_SetColAttr(self, GridCellAttr attr, int col) + + + + + + + + + + __init__(self, int numRows=0, int numCols=0) -> GridStringTable + + + + + + + + + __init__(self, GridTableBase table, int id, int comInt1=-1, int comInt2=-1) -> GridTableMessage + + + + + + + + + __del__(self) + + + SetTableObject(self, GridTableBase table) + + + + + + GetTableObject(self) -> GridTableBase + + + SetId(self, int id) + + + + + + GetId(self) -> int + + + SetCommandInt(self, int comInt1) + + + + + + GetCommandInt(self) -> int + + + SetCommandInt2(self, int comInt2) + + + + + + GetCommandInt2(self) -> int + + + + + __init__(self, int r=-1, int c=-1) -> GridCellCoords + + + + + + + __del__(self) + + + GetRow(self) -> int + + + SetRow(self, int n) + + + + + + GetCol(self) -> int + + + SetCol(self, int n) + + + + + + Set(self, int row, int col) + + + + + + + __eq__(self, GridCellCoords other) -> bool + + + + + + __ne__(self, GridCellCoords other) -> bool + + + + + + Get(self) -> PyObject + + + + + + __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(self, int numRows, int numCols, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool + + + + + + + + SetSelectionMode(self, WXGRIDSELECTIONMODES selmode) + + + + + + GetSelectionMode(self) -> WXGRIDSELECTIONMODES + + + GetNumberRows(self) -> int + + + GetNumberCols(self) -> int + + + ProcessTableMessage(self, GridTableMessage ??) -> bool + + + + + + GetTable(self) -> GridTableBase + + + SetTable(self, GridTableBase table, bool takeOwnership=False, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool + + + + + + + + ClearGrid(self) + + + InsertRows(self, int pos=0, int numRows=1, bool updateLabels=True) -> bool + + + + + + + + AppendRows(self, int numRows=1, bool updateLabels=True) -> bool + + + + + + + DeleteRows(self, int pos=0, int numRows=1, bool updateLabels=True) -> bool + + + + + + + + InsertCols(self, int pos=0, int numCols=1, bool updateLabels=True) -> bool + + + + + + + + AppendCols(self, int numCols=1, bool updateLabels=True) -> bool + + + + + + + DeleteCols(self, int pos=0, int numCols=1, bool updateLabels=True) -> bool + + + + + + + + DrawCellHighlight(self, DC dc, GridCellAttr attr) + + + + + + + DrawTextRectangle(self, DC dc, String ??, Rect ??, int horizontalAlignment=LEFT, + int verticalAlignment=TOP, int textOrientation=HORIZONTAL) + + + + + + + + + + + GetTextBoxSize(DC dc, list lines) -> (width, height) + + + + + + + + + BeginBatch(self) + + + EndBatch(self) + + + GetBatchCount(self) -> int + + + ForceRefresh(self) + + + IsEditable(self) -> bool + + + EnableEditing(self, bool edit) + + + + + + EnableCellEditControl(self, bool enable=True) + + + + + + DisableCellEditControl(self) + + + CanEnableCellControl(self) -> bool + + + IsCellEditControlEnabled(self) -> bool + + + IsCellEditControlShown(self) -> bool + + + IsCurrentCellReadOnly(self) -> bool + + + ShowCellEditControl(self) + + + HideCellEditControl(self) + + + SaveEditControlValue(self) + + + XYToCell(self, int x, int y) -> GridCellCoords + + + + + + + YToRow(self, int y) -> int + + + + + + XToCol(self, int x) -> int + + + + + + YToEdgeOfRow(self, int y) -> int + + + + + + XToEdgeOfCol(self, int x) -> int + + + + + + CellToRect(self, int row, int col) -> Rect + + + + + + + GetGridCursorRow(self) -> int + + + GetGridCursorCol(self) -> int + + + IsVisible(self, int row, int col, bool wholeCellVisible=True) -> bool + + + + + + + + MakeCellVisible(self, int row, int col) + + + + + + + SetGridCursor(self, int row, int col) + + + + + + + MoveCursorUp(self, bool expandSelection) -> bool + + + + + + MoveCursorDown(self, bool expandSelection) -> bool + + + + + + MoveCursorLeft(self, bool expandSelection) -> bool + + + + + + MoveCursorRight(self, bool expandSelection) -> bool + + + + + + MovePageDown(self) -> bool + + + MovePageUp(self) -> bool + + + MoveCursorUpBlock(self, bool expandSelection) -> bool + + + + + + MoveCursorDownBlock(self, bool expandSelection) -> bool + + + + + + MoveCursorLeftBlock(self, bool expandSelection) -> bool + + + + + + MoveCursorRightBlock(self, bool expandSelection) -> bool + + + + + + GetDefaultRowLabelSize(self) -> int + + + GetRowLabelSize(self) -> int + + + GetDefaultColLabelSize(self) -> int + + + GetColLabelSize(self) -> int + + + GetLabelBackgroundColour(self) -> Colour + + + GetLabelTextColour(self) -> Colour + + + GetLabelFont(self) -> Font + + + GetRowLabelAlignment() -> (horiz, vert) + + + + + + + GetColLabelAlignment() -> (horiz, vert) + + + + + + + GetColLabelTextOrientation(self) -> int + + + GetRowLabelValue(self, int row) -> String + + + + + + GetColLabelValue(self, int col) -> String + + + + + + GetGridLineColour(self) -> Colour + + + GetCellHighlightColour(self) -> Colour + + + GetCellHighlightPenWidth(self) -> int + + + GetCellHighlightROPenWidth(self) -> int + + + SetRowLabelSize(self, int width) + + + + + + SetColLabelSize(self, int height) + + + + + + SetLabelBackgroundColour(self, Colour ??) + + + + + + SetLabelTextColour(self, Colour ??) + + + + + + SetLabelFont(self, Font ??) + + + + + + SetRowLabelAlignment(self, int horiz, int vert) + + + + + + + SetColLabelAlignment(self, int horiz, int vert) + + + + + + + SetColLabelTextOrientation(self, int textOrientation) + + + + + + SetRowLabelValue(self, int row, String ??) + + + + + + + SetColLabelValue(self, int col, String ??) + + + + + + + SetGridLineColour(self, Colour ??) + + + + + + SetCellHighlightColour(self, Colour ??) + + + + + + SetCellHighlightPenWidth(self, int width) + + + + + + SetCellHighlightROPenWidth(self, int width) + + + + + + EnableDragRowSize(self, bool enable=True) + + + + + + DisableDragRowSize(self) + + + CanDragRowSize(self) -> bool + + + EnableDragColSize(self, bool enable=True) + + + + + + DisableDragColSize(self) + + + CanDragColSize(self) -> bool + + + EnableDragGridSize(self, bool enable=True) + + + + + + DisableDragGridSize(self) + + + CanDragGridSize(self) -> bool + + + EnableDragCell(self, bool enable=True) + + + + + + DisableDragCell(self) + + + CanDragCell(self) -> bool + + + SetAttr(self, int row, int col, GridCellAttr attr) + + + + + + + + SetRowAttr(self, int row, GridCellAttr attr) + + + + + + + SetColAttr(self, int col, GridCellAttr attr) + + + + + + + SetColFormatBool(self, int col) + + + + + + SetColFormatNumber(self, int col) + + + + + + SetColFormatFloat(self, int col, int width=-1, int precision=-1) + + + + + + + + SetColFormatCustom(self, int col, String typeName) + + + + + + + EnableGridLines(self, bool enable=True) + + + + + + GridLinesEnabled(self) -> bool + + + GetDefaultRowSize(self) -> int + + + GetRowSize(self, int row) -> int + + + + + + GetDefaultColSize(self) -> int + + + GetColSize(self, int col) -> int + + + + + + GetDefaultCellBackgroundColour(self) -> Colour + + + GetCellBackgroundColour(self, int row, int col) -> Colour + + + + + + + GetDefaultCellTextColour(self) -> Colour + + + GetCellTextColour(self, int row, int col) -> Colour + + + + + + + GetDefaultCellFont(self) -> Font + + + GetCellFont(self, int row, int col) -> Font + + + + + + + GetDefaultCellAlignment() -> (horiz, vert) + + + + + + + GetCellAlignment() -> (horiz, vert) + + + + + + + + + GetDefaultCellOverflow(self) -> bool + + + GetCellOverflow(self, int row, int col) -> bool + + + + + + + GetCellSize(int row, int col) -> (num_rows, num_cols) + + + + + + + + + SetDefaultRowSize(self, int height, bool resizeExistingRows=False) + + + + + + + SetRowSize(self, int row, int height) + + + + + + + SetDefaultColSize(self, int width, bool resizeExistingCols=False) + + + + + + + SetColSize(self, int col, int width) + + + + + + + AutoSizeColumn(self, int col, bool setAsMin=True) + + + + + + + AutoSizeRow(self, int row, bool setAsMin=True) + + + + + + + AutoSizeColumns(self, bool setAsMin=True) + + + + + + AutoSizeRows(self, bool setAsMin=True) + + + + + + AutoSize(self) + + + AutoSizeRowLabelSize(self, int row) + + + + + + AutoSizeColLabelSize(self, int col) + + + + + + SetColMinimalWidth(self, int col, int width) + + + + + + + SetRowMinimalHeight(self, int row, int width) + + + + + + + SetColMinimalAcceptableWidth(self, int width) + + + + + + SetRowMinimalAcceptableHeight(self, int width) + + + + + + GetColMinimalAcceptableWidth(self) -> int + + + GetRowMinimalAcceptableHeight(self) -> int + + + SetDefaultCellBackgroundColour(self, Colour ??) + + + + + + SetCellBackgroundColour(self, int row, int col, Colour ??) + + + + + + + + SetDefaultCellTextColour(self, Colour ??) + + + + + + SetCellTextColour(self, int row, int col, Colour ??) + + + + + + + + SetDefaultCellFont(self, Font ??) + + + + + + SetCellFont(self, int row, int col, Font ??) + + + + + + + + SetDefaultCellAlignment(self, int horiz, int vert) + + + + + + + SetCellAlignment(self, int row, int col, int horiz, int vert) + + + + + + + + + SetDefaultCellOverflow(self, bool allow) + + + + + + SetCellOverflow(self, int row, int col, bool allow) + + + + + + + + SetCellSize(self, int row, int col, int num_rows, int num_cols) + + + + + + + + + SetDefaultRenderer(self, GridCellRenderer renderer) + + + + + + SetCellRenderer(self, int row, int col, GridCellRenderer renderer) + + + + + + + + GetDefaultRenderer(self) -> GridCellRenderer + + + GetCellRenderer(self, int row, int col) -> GridCellRenderer + + + + + + + SetDefaultEditor(self, GridCellEditor editor) + + + + + + SetCellEditor(self, int row, int col, GridCellEditor editor) + + + + + + + + GetDefaultEditor(self) -> GridCellEditor + + + GetCellEditor(self, int row, int col) -> GridCellEditor + + + + + + + GetCellValue(self, int row, int col) -> String + + + + + + + SetCellValue(self, int row, int col, String s) + + + + + + + + IsReadOnly(self, int row, int col) -> bool + + + + + + + SetReadOnly(self, int row, int col, bool isReadOnly=True) + + + + + + + + SelectRow(self, int row, bool addToSelected=False) + + + + + + + SelectCol(self, int col, bool addToSelected=False) + + + + + + + SelectBlock(self, int topRow, int leftCol, int bottomRow, int rightCol, + bool addToSelected=False) + + + + + + + + + + SelectAll(self) + + + IsSelection(self) -> bool + + + ClearSelection(self) + + + IsInSelection(self, int row, int col) -> bool + + + + + + + GetSelectedCells(self) -> wxGridCellCoordsArray + + + GetSelectionBlockTopLeft(self) -> wxGridCellCoordsArray + + + GetSelectionBlockBottomRight(self) -> wxGridCellCoordsArray + + + GetSelectedRows(self) -> wxArrayInt + + + GetSelectedCols(self) -> wxArrayInt + + + DeselectRow(self, int row) + + + + + + DeselectCol(self, int col) + + + + + + DeselectCell(self, int row, int col) + + + + + + + BlockToDeviceRect(self, GridCellCoords topLeft, GridCellCoords bottomRight) -> Rect + + + + + + + GetSelectionBackground(self) -> Colour + + + GetSelectionForeground(self) -> Colour + + + SetSelectionBackground(self, Colour c) + + + + + + SetSelectionForeground(self, Colour c) + + + + + + RegisterDataType(self, String typeName, GridCellRenderer renderer, GridCellEditor editor) + + + + + + + + GetDefaultEditorForCell(self, int row, int col) -> GridCellEditor + + + + + + + GetDefaultRendererForCell(self, int row, int col) -> GridCellRenderer + + + + + + + GetDefaultEditorForType(self, String typeName) -> GridCellEditor + + + + + + GetDefaultRendererForType(self, String typeName) -> GridCellRenderer + + + + + + SetMargins(self, int extraWidth, int extraHeight) + + + + + + + GetGridWindow(self) -> Window + + + GetGridRowLabelWindow(self) -> Window + + + GetGridColLabelWindow(self) -> 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__(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 + + + + + + + + + + + + + + + + + GetRow(self) -> int + + + GetCol(self) -> int + + + GetPosition(self) -> Point + + + Selecting(self) -> bool + + + ControlDown(self) -> bool + + + MetaDown(self) -> bool + + + ShiftDown(self) -> bool + + + AltDown(self) -> bool + + + + + + __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 + + + + + + + + + + + + + + + GetRowOrCol(self) -> int + + + GetPosition(self) -> Point + + + ControlDown(self) -> bool + + + MetaDown(self) -> bool + + + ShiftDown(self) -> bool + + + AltDown(self) -> bool + + + + + + __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 + + + + + + + + + + + + + + + GetTopLeftCoords(self) -> GridCellCoords + + + GetBottomRightCoords(self) -> GridCellCoords + + + GetTopRow(self) -> int + + + GetBottomRow(self) -> int + + + GetLeftCol(self) -> int + + + GetRightCol(self) -> int + + + Selecting(self) -> bool + + + ControlDown(self) -> bool + + + MetaDown(self) -> bool + + + ShiftDown(self) -> bool + + + AltDown(self) -> bool + + + + + + __init__(self, int id, wxEventType type, Object obj, int row, int col, + Control ctrl) -> GridEditorCreatedEvent + + + + + + + + + + + GetRow(self) -> int + + + GetCol(self) -> int + + + GetControl(self) -> Control + + + SetRow(self, int row) + + + + + + SetCol(self, int col) + + + + + + SetControl(self, Control ctrl) + + + + + + +EVT_GRID_CELL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_CLICK ) +EVT_GRID_CELL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_CLICK ) +EVT_GRID_CELL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_DCLICK ) +EVT_GRID_CELL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_DCLICK ) +EVT_GRID_LABEL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_CLICK ) +EVT_GRID_LABEL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_CLICK ) +EVT_GRID_LABEL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_DCLICK ) +EVT_GRID_LABEL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_DCLICK ) +EVT_GRID_ROW_SIZE = wx.PyEventBinder( wxEVT_GRID_ROW_SIZE ) +EVT_GRID_COL_SIZE = wx.PyEventBinder( wxEVT_GRID_COL_SIZE ) +EVT_GRID_RANGE_SELECT = wx.PyEventBinder( wxEVT_GRID_RANGE_SELECT ) +EVT_GRID_CELL_CHANGE = wx.PyEventBinder( wxEVT_GRID_CELL_CHANGE ) +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 + __docfilter__ = wx.__DocFilter(globals()) + +#--------------------------------------------------------------------------- + + + + + __init__(self, String href, String target=EmptyString) -> HtmlLinkInfo + + + + + + + GetHref(self) -> String + + + GetTarget(self) -> String + + + GetEvent(self) -> MouseEvent + + + GetHtmlCell(self) -> HtmlCell + + + SetEvent(self, MouseEvent e) + + + + + + SetHtmlCell(self, HtmlCell e) + + + + + + + + + GetName(self) -> String + + + HasParam(self, String par) -> bool + + + + + + GetParam(self, String par, int with_commas=False) -> String + + + + + + + GetAllParams(self) -> String + + + HasEnding(self) -> bool + + + GetBeginPos(self) -> int + + + GetEndPos1(self) -> int + + + GetEndPos2(self) -> int + + + + + + SetFS(self, FileSystem fs) + + + + + + GetFS(self) -> FileSystem + + + Parse(self, String source) -> Object + + + + + + InitParser(self, String source) + + + + + + DoneParser(self) + + + DoParsing(self, int begin_pos, int end_pos) + + + + + + + StopParsing(self) + + + AddTagHandler(self, HtmlTagHandler handler) + + + + + + GetSource(self) -> String + + + PushTagHandler(self, HtmlTagHandler handler, String tags) + + + + + + + PopTagHandler(self) + + + + + + __init__(self, HtmlWindow wnd=None) -> HtmlWinParser + + + + + + SetDC(self, DC dc) + + + + + + GetDC(self) -> DC + + + GetCharHeight(self) -> int + + + GetCharWidth(self) -> int + + + GetWindow(self) -> HtmlWindow + + + SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None) + + + + + + + + NormalizeFontSizes(self, int size=-1) + + + + + + GetContainer(self) -> HtmlContainerCell + + + OpenContainer(self) -> HtmlContainerCell + + + SetContainer(self, HtmlContainerCell c) -> HtmlContainerCell + + + + + + CloseContainer(self) -> HtmlContainerCell + + + GetFontSize(self) -> int + + + SetFontSize(self, int s) + + + + + + GetFontBold(self) -> int + + + SetFontBold(self, int x) + + + + + + GetFontItalic(self) -> int + + + SetFontItalic(self, int x) + + + + + + GetFontUnderlined(self) -> int + + + SetFontUnderlined(self, int x) + + + + + + GetFontFixed(self) -> int + + + SetFontFixed(self, int x) + + + + + + GetAlign(self) -> int + + + SetAlign(self, int a) + + + + + + GetLinkColor(self) -> Colour + + + SetLinkColor(self, Colour clr) + + + + + + GetActualColor(self) -> Colour + + + SetActualColor(self, Colour clr) + + + + + + SetLink(self, String link) + + + + + + CreateCurrentFont(self) -> Font + + + GetLink(self) -> HtmlLinkInfo + + + + + + __init__(self) -> HtmlTagHandler + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + SetParser(self, HtmlParser parser) + + + + + + GetParser(self) -> HtmlParser + + + ParseInner(self, HtmlTag tag) + + + + + + + + + __init__(self) -> HtmlWinTagHandler + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + SetParser(self, HtmlParser parser) + + + + + + GetParser(self) -> HtmlWinParser + + + ParseInner(self, HtmlTag tag) + + + + + + + HtmlWinParser_AddTagHandler(PyObject tagHandlerClass) + + + + + +#--------------------------------------------------------------------------- + + + + __init__(self) -> HtmlSelection + + + __del__(self) + + + Set(self, Point fromPos, HtmlCell fromCell, Point toPos, HtmlCell toCell) + + + + + + + + + SetCells(self, HtmlCell fromCell, HtmlCell toCell) + + + + + + + GetFromCell(self) -> HtmlCell + + + GetToCell(self) -> HtmlCell + + + GetFromPos(self) -> Point + + + GetToPos(self) -> Point + + + GetFromPrivPos(self) -> Point + + + GetToPrivPos(self) -> Point + + + SetFromPrivPos(self, Point pos) + + + + + + SetToPrivPos(self, Point pos) + + + + + + ClearPrivPos(self) + + + IsEmpty(self) -> bool + + + + + __init__(self) -> HtmlRenderingState + + + __del__(self) + + + SetSelectionState(self, int s) + + + + + + GetSelectionState(self) -> int + + + SetFgColour(self, Colour c) + + + + + + GetFgColour(self) -> Colour + + + SetBgColour(self, Colour c) + + + + + + GetBgColour(self) -> Colour + + + + + GetSelectedTextColour(self, Colour clr) -> Colour + + + + + + GetSelectedTextBgColour(self, Colour clr) -> Colour + + + + + + + + + GetSelectedTextColour(self, Colour clr) -> Colour + + + + + + GetSelectedTextBgColour(self, Colour clr) -> Colour + + + + + + + + __init__(self) -> HtmlRenderingInfo + + + __del__(self) + + + SetSelection(self, HtmlSelection s) + + + + + + GetSelection(self) -> HtmlSelection + + + SetStyle(self, HtmlRenderingStyle style) + + + + + + GetStyle(self) -> HtmlRenderingStyle + + + GetState(self) -> HtmlRenderingState + + + +#--------------------------------------------------------------------------- + + + + + __init__(self) -> HtmlCell + + + GetPosX(self) -> int + + + GetPosY(self) -> int + + + GetWidth(self) -> int + + + GetHeight(self) -> int + + + GetDescent(self) -> int + + + GetMaxTotalWidth(self) -> int + + + GetId(self) -> String + + + SetId(self, String id) + + + + + + GetLink(self, int x=0, int y=0) -> HtmlLinkInfo + + + + + + + GetNext(self) -> HtmlCell + + + GetParent(self) -> HtmlContainerCell + + + GetFirstChild(self) -> HtmlCell + + + GetCursor(self) -> Cursor + + + IsFormattingCell(self) -> bool + + + SetLink(self, HtmlLinkInfo link) + + + + + + SetNext(self, HtmlCell cell) + + + + + + SetParent(self, HtmlContainerCell p) + + + + + + SetPos(self, int x, int y) + + + + + + + Layout(self, int w) + + + + + + Draw(self, DC dc, int x, int y, int view_y1, int view_y2, HtmlRenderingInfo info) + + + + + + + + + + + DrawInvisible(self, DC dc, int x, int y, HtmlRenderingInfo info) + + + + + + + + + Find(self, int condition, void param) -> HtmlCell + + + + + + + AdjustPagebreak(self, int INOUT) -> bool + + + + + + SetCanLiveOnPagebreak(self, bool can) + + + + + + IsLinebreakAllowed(self) -> bool + + + IsTerminalCell(self) -> bool + + + FindCellByPos(self, int x, int y, unsigned int flags=HTML_FIND_EXACT) -> HtmlCell + + + + + + + + GetAbsPos(self) -> Point + + + GetFirstTerminal(self) -> HtmlCell + + + GetLastTerminal(self) -> HtmlCell + + + GetDepth(self) -> unsigned int + + + IsBefore(self, HtmlCell cell) -> bool + + + + + + ConvertToText(self, HtmlSelection sel) -> String + + + + + + + + + __init__(self, String word, DC dc) -> HtmlWordCell + + + + + + + + + + __init__(self, HtmlContainerCell parent) -> HtmlContainerCell + + + + + + InsertCell(self, HtmlCell cell) + + + + + + SetAlignHor(self, int al) + + + + + + GetAlignHor(self) -> int + + + SetAlignVer(self, int al) + + + + + + GetAlignVer(self) -> int + + + SetIndent(self, int i, int what, int units=HTML_UNITS_PIXELS) + + + + + + + + GetIndent(self, int ind) -> int + + + + + + GetIndentUnits(self, int ind) -> int + + + + + + SetAlign(self, HtmlTag tag) + + + + + + SetWidthFloat(self, int w, int units) + + + + + + + SetWidthFloatFromTag(self, HtmlTag tag) + + + + + + SetMinHeight(self, int h, int align=HTML_ALIGN_TOP) + + + + + + + SetBackgroundColour(self, Colour clr) + + + + + + GetBackgroundColour(self) -> Colour + + + SetBorder(self, Colour clr1, Colour clr2) + + + + + + + GetFirstChild(self) -> HtmlCell + + + + + + __init__(self, Colour clr, int flags=HTML_CLR_FOREGROUND) -> HtmlColourCell + + + + + + + + + + __init__(self, Font font) -> HtmlFontCell + + + + + + + + + __init__(self, Window wnd, int w=0) -> HtmlWidgetCell + + + + + + + +#--------------------------------------------------------------------------- + + + + + __init__(self) -> HtmlFilter + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + +#--------------------------------------------------------------------------- + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, int style=HW_DEFAULT_STYLE, + String name=HtmlWindowNameStr) -> HtmlWindow + + + + + + + + + + + PreHtmlWindow() -> HtmlWindow + + + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, int style=HW_SCROLLBAR_AUTO, + String name=HtmlWindowNameStr) -> bool + + + + + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + SetPage(self, String source) -> bool + + + + + + LoadPage(self, String location) -> bool + + + + + + LoadFile(self, String filename) -> bool + + + + + + AppendToPage(self, String source) -> bool + + + + + + GetOpenedPage(self) -> String + + + GetOpenedAnchor(self) -> String + + + GetOpenedPageTitle(self) -> String + + + SetRelatedFrame(self, Frame frame, String format) + + + + + + + GetRelatedFrame(self) -> Frame + + + SetRelatedStatusBar(self, int bar) + + + + + + SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None) + + + + + + + + NormalizeFontSizes(self, int size=-1) + + + + + + SetTitle(self, String title) + + + + + + SetBorders(self, int b) + + + + + + ReadCustomization(self, ConfigBase cfg, String path=EmptyString) + + + + + + + WriteCustomization(self, ConfigBase cfg, String path=EmptyString) + + + + + + + HistoryBack(self) -> bool + + + HistoryForward(self) -> bool + + + HistoryCanBack(self) -> bool + + + HistoryCanForward(self) -> bool + + + HistoryClear(self) + + + GetInternalRepresentation(self) -> HtmlContainerCell + + + GetParser(self) -> HtmlWinParser + + + ScrollToAnchor(self, String anchor) -> bool + + + + + + HasAnchor(self, String anchor) -> bool + + + + + + AddFilter(HtmlFilter filter) + + + + + + SelectWord(self, Point pos) + + + + + + SelectLine(self, Point pos) + + + + + + SelectAll(self) + + + SelectionToText(self) -> String + + + ToText(self) -> String + + + base_OnLinkClicked(self, HtmlLinkInfo link) + + + + + + base_OnSetTitle(self, String title) + + + + + + base_OnCellMouseHover(self, HtmlCell cell, int x, int y) + + + + + + + + base_OnCellClicked(self, HtmlCell cell, int x, int y, MouseEvent event) + + + + + + + + + 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__(self) -> HtmlDCRenderer + + + __del__(self) + + + SetDC(self, DC dc, int maxwidth) + + + + + + + SetSize(self, int width, int height) + + + + + + + SetHtmlText(self, String html, String basepath=EmptyString, bool isdir=True) + + + + + + + + SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None) + + + + + + + + NormalizeFontSizes(self, int size=-1) + + + + + + Render(self, int x, int y, int from=0, int dont_render=False, int to=INT_MAX, + int choices=None, int LCOUNT=0) -> int + + + + + + + + + + + + GetTotalHeight(self) -> int + + + + + + __init__(self, String title=HtmlPrintoutTitleStr) -> HtmlPrintout + + + + + + SetHtmlText(self, String html, String basepath=EmptyString, bool isdir=True) + + + + + + + + SetHtmlFile(self, String htmlfile) + + + + + + SetHeader(self, String header, int pg=PAGE_ALL) + + + + + + + SetFooter(self, String footer, int pg=PAGE_ALL) + + + + + + + SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None) + + + + + + + + NormalizeFontSizes(self, int size=-1) + + + + + + SetMargins(self, float top=25.2, float bottom=25.2, float left=25.2, + float right=25.2, float spaces=5) + + + + + + + + + + AddFilter(wxHtmlFilter filter) + + + + + + CleanUpStatics() + + + + + + __init__(self, String name=HtmlPrintingTitleStr, Window parentWindow=None) -> HtmlEasyPrinting + + + + + + + __del__(self) + + + PreviewFile(self, String htmlfile) + + + + + + PreviewText(self, String htmltext, String basepath=EmptyString) + + + + + + + PrintFile(self, String htmlfile) + + + + + + PrintText(self, String htmltext, String basepath=EmptyString) + + + + + + + PrinterSetup(self) + + + PageSetup(self) + + + SetHeader(self, String header, int pg=PAGE_ALL) + + + + + + + SetFooter(self, String footer, int pg=PAGE_ALL) + + + + + + + SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None) + + + + + + + + NormalizeFontSizes(self, int size=-1) + + + + + + GetPrintData(self) -> PrintData + + + GetPageSetupData(self) -> PageSetupDialogData + + + +#--------------------------------------------------------------------------- + + + + __init__(self, String bookfile, String basepath, String title, String start) -> HtmlBookRecord + + + + + + + + + GetBookFile(self) -> String + + + GetTitle(self) -> String + + + GetStart(self) -> String + + + GetBasePath(self) -> String + + + SetContentsRange(self, int start, int end) + + + + + + + GetContentsStart(self) -> int + + + GetContentsEnd(self) -> int + + + SetTitle(self, String title) + + + + + + SetBasePath(self, String path) + + + + + + SetStart(self, String start) + + + + + + GetFullPath(self, String page) -> String + + + + + + + + GetLevel(self) -> int + + + GetID(self) -> int + + + GetName(self) -> String + + + GetPage(self) -> String + + + GetBook(self) -> HtmlBookRecord + + + + + Search(self) -> bool + + + IsActive(self) -> bool + + + GetCurIndex(self) -> int + + + GetMaxIndex(self) -> int + + + GetName(self) -> String + + + GetContentsItem(self) -> HtmlContentsItem + + + + + __init__(self) -> HtmlHelpData + + + __del__(self) + + + SetTempDir(self, String path) + + + + + + AddBook(self, String book) -> bool + + + + + + FindPageByName(self, String page) -> String + + + + + + FindPageById(self, int id) -> String + + + + + + GetBookRecArray(self) -> wxHtmlBookRecArray + + + GetContents(self) -> HtmlContentsItem + + + GetContentsCnt(self) -> int + + + GetIndex(self) -> HtmlContentsItem + + + GetIndexCnt(self) -> int + + + + + + __init__(self, Window parent, int ??, String title=EmptyString, int style=HF_DEFAULTSTYLE, + HtmlHelpData data=None) -> HtmlHelpFrame + + + + + + + + + + GetData(self) -> HtmlHelpData + + + SetTitleFormat(self, String format) + + + + + + Display(self, String x) + + + + + + DisplayID(self, int id) + + + + + + DisplayContents(self) + + + DisplayIndex(self) + + + KeywordSearch(self, String keyword) -> bool + + + + + + UseConfig(self, ConfigBase config, String rootpath=EmptyString) + + + + + + + ReadCustomization(self, ConfigBase cfg, String path=EmptyString) + + + + + + + WriteCustomization(self, ConfigBase cfg, String path=EmptyString) + + + + + + + + + + __init__(self, int style=HF_DEFAULTSTYLE) -> HtmlHelpController + + + + + + __del__(self) + + + SetTitleFormat(self, String format) + + + + + + SetTempDir(self, String path) + + + + + + AddBook(self, String book, int show_wait_msg=False) -> bool + + + + + + + Display(self, String x) + + + + + + DisplayID(self, int id) + + + + + + DisplayContents(self) + + + DisplayIndex(self) + + + KeywordSearch(self, String keyword) -> bool + + + + + + UseConfig(self, ConfigBase config, String rootpath=EmptyString) + + + + + + + ReadCustomization(self, ConfigBase cfg, String path=EmptyString) + + + + + + + WriteCustomization(self, ConfigBase cfg, String path=EmptyString) + + + + + + + GetFrame(self) -> HtmlHelpFrame + + + + + + 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) +EVT_WIZARD_CANCEL = wx.PyEventBinder( wxEVT_WIZARD_CANCEL, 1) +EVT_WIZARD_HELP = wx.PyEventBinder( wxEVT_WIZARD_HELP, 1) +EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) + + + + + __init__(self, wxEventType type=wxEVT_NULL, int id=-1, bool direction=True, + WizardPage page=None) -> WizardEvent + + + + + + + + + GetDirection(self) -> bool + + + GetPage(self) -> WizardPage + + + + + + Create(self, Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool + + + + + + + + GetPrev(self) -> WizardPage + + + GetNext(self) -> WizardPage + + + GetBitmap(self) -> Bitmap + + + + + + __init__(self, Wizard parent, Bitmap bitmap=&wxNullBitmap, String resource=&wxPyEmptyString) -> PyWizardPage + + + + + + + + PrePyWizardPage() -> PyWizardPage + + + Create(self, Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool + + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + 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) + + + + + + + + + __init__(self, Wizard parent, WizardPage prev=None, WizardPage next=None, + Bitmap bitmap=wxNullBitmap, wxChar resource=None) -> WizardPageSimple + + + + + + + + + + PreWizardPageSimple() -> WizardPageSimple + + + Create(self, Wizard parent=None, WizardPage prev=None, WizardPage next=None, + Bitmap bitmap=wxNullBitmap, wxChar resource=None) -> bool + + + + + + + + + + SetPrev(self, WizardPage prev) + + + + + + SetNext(self, WizardPage next) + + + + + + Chain(WizardPageSimple first, WizardPageSimple second) + + + + + + + + + + __init__(self, Window parent, int id=-1, String title=EmptyString, + Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition, + long style=DEFAULT_DIALOG_STYLE) -> Wizard + + + + + + + + + + + PreWizard() -> Wizard + + + Create(self, Window parent, int id=-1, String title=EmptyString, + Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition) -> bool + + + + + + + + + + Init(self) + + + RunWizard(self, WizardPage firstPage) -> bool + + + + + + GetCurrentPage(self) -> WizardPage + + + SetPageSize(self, Size size) + + + + + + GetPageSize(self) -> Size + + + FitToPage(self, WizardPage firstPage) + + + + + + GetPageAreaSizer(self) -> Sizer + + + SetBorder(self, int border) + + + + + + IsRunning(self) -> bool + + + ShowPage(self, WizardPage page, bool goingForward=True) -> bool + + + + + + + HasNextPage(self, WizardPage page) -> bool + + + + + + HasPrevPage(self, WizardPage page) -> bool + + + + + + + + + wx = _core + __docfilter__ = wx.__DocFilter(globals()) + + + + __init__(self, bool isRGB, GLCanvas win, wxPalette palette=wxNullPalette, + GLContext other=None) -> GLContext + + + + + + + + + __del__(self) + + + SetCurrent(self) + + + SetColour(self, String colour) + + + + + + SwapBuffers(self) + + + SetupPixelFormat(self) + + + SetupPalette(self, wxPalette palette) + + + + + + CreateDefaultPalette(self) -> wxPalette + + + GetPalette(self) -> wxPalette + + + GetWindow(self) -> Window + + + + + + __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 + + + + + + + + + + + + + GLCanvasWithContext(Window parent, GLContext shared=None, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, + long style=0, String name=GLCanvasNameStr, + int attribList=None, wxPalette palette=wxNullPalette) -> GLCanvas + + + + + + + + + + + + + + SetCurrent(self) + + + SetColour(self, String colour) + + + + + + SwapBuffers(self) + + + GetContext(self) -> GLContext + + + + + + 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__(self) -> ShapeRegion + + + SetText(self, String s) + + + + + + SetFont(self, Font f) + + + + + + SetMinSize(self, double w, double h) + + + + + + + SetSize(self, double w, double h) + + + + + + + SetPosition(self, double x, double y) + + + + + + + SetProportions(self, double x, double y) + + + + + + + SetFormatMode(self, int mode) + + + + + + SetName(self, String s) + + + + + + SetColour(self, String col) + + + + + + GetText(self) -> String + + + GetFont(self) -> Font + + + GetMinSize(self, double OUTPUT, double OUTPUT) + + + + + + + GetProportion(self, double OUTPUT, double OUTPUT) + + + + + + + GetSize(self, double OUTPUT, double OUTPUT) + + + + + + + GetPosition(self, double OUTPUT, double OUTPUT) + + + + + + + GetFormatMode(self) -> int + + + GetName(self) -> String + + + GetColour(self) -> String + + + GetActualColourObject(self) -> Colour + + + GetFormattedText(self) -> wxList + + + GetPenColour(self) -> String + + + GetPenStyle(self) -> int + + + SetPenStyle(self, int style) + + + + + + SetPenColour(self, String col) + + + + + + GetActualPen(self) -> wxPen + + + GetWidth(self) -> double + + + GetHeight(self) -> double + + + ClearText(self) + + + + + + __init__(self, int id=0, double x=0.0, double y=0.0) -> AttachmentPoint + + + + + + + + + + + + + + __init__(self, PyShapeEvtHandler prev=None, PyShape shape=None) -> PyShapeEvtHandler + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + _setOORInfo(self, PyObject _self) + + + + + + SetShape(self, PyShape sh) + + + + + + GetShape(self) -> PyShape + + + SetPreviousHandler(self, PyShapeEvtHandler handler) + + + + + + GetPreviousHandler(self) -> PyShapeEvtHandler + + + CreateNewCopy(self) -> PyShapeEvtHandler + + + base_OnDelete(self) + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=False) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self, PyShapeCanvas can=None) -> PyShape + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + GetBoundingBoxMax(self, double OUTPUT, double OUTPUT) + + + + + + + GetBoundingBoxMin(self, double OUTPUT, double OUTPUT) + + + + + + + GetPerimeterPoint(self, double x1, double y1, double x2, double y2, double OUTPUT, + double OUTPUT) -> bool + + + + + + + + + + + GetCanvas(self) -> PyShapeCanvas + + + SetCanvas(self, PyShapeCanvas the_canvas) + + + + + + AddToCanvas(self, PyShapeCanvas the_canvas, PyShape addAfter=None) + + + + + + + InsertInCanvas(self, PyShapeCanvas the_canvas) + + + + + + RemoveFromCanvas(self, PyShapeCanvas the_canvas) + + + + + + GetX(self) -> double + + + GetY(self) -> double + + + SetX(self, double x) + + + + + + SetY(self, double y) + + + + + + GetParent(self) -> PyShape + + + SetParent(self, PyShape p) + + + + + + GetTopAncestor(self) -> PyShape + + + GetChildren(self) -> PyObject + + + Unlink(self) + + + SetDrawHandles(self, bool drawH) + + + + + + GetDrawHandles(self) -> bool + + + MakeControlPoints(self) + + + DeleteControlPoints(self, DC dc=None) + + + + + + ResetControlPoints(self) + + + GetEventHandler(self) -> PyShapeEvtHandler + + + SetEventHandler(self, PyShapeEvtHandler handler) + + + + + + MakeMandatoryControlPoints(self) + + + ResetMandatoryControlPoints(self) + + + Recompute(self) -> bool + + + CalculateSize(self) + + + Select(self, bool select=True, DC dc=None) + + + + + + + SetHighlight(self, bool hi=True, bool recurse=False) + + + + + + + IsHighlighted(self) -> bool + + + Selected(self) -> bool + + + AncestorSelected(self) -> bool + + + SetSensitivityFilter(self, int sens=OP_ALL, bool recursive=False) + + + + + + + GetSensitivityFilter(self) -> int + + + SetDraggable(self, bool drag, bool recursive=False) + + + + + + + SetFixedSize(self, bool x, bool y) + + + + + + + GetFixedSize(self, bool OUTPUT, bool OUTPUT) + + + + + + + GetFixedWidth(self) -> bool + + + GetFixedHeight(self) -> bool + + + SetSpaceAttachments(self, bool sp) + + + + + + GetSpaceAttachments(self) -> bool + + + SetShadowMode(self, int mode, bool redraw=False) + + + + + + + GetShadowMode(self) -> int + + + HitTest(self, double x, double y, int OUTPUT, double OUTPUT) -> bool + + + + + + + + + SetCentreResize(self, bool cr) + + + + + + GetCentreResize(self) -> bool + + + SetMaintainAspectRatio(self, bool ar) + + + + + + GetMaintainAspectRatio(self) -> bool + + + GetLines(self) -> PyObject + + + SetDisableLabel(self, bool flag) + + + + + + GetDisableLabel(self) -> bool + + + SetAttachmentMode(self, int mode) + + + + + + GetAttachmentMode(self) -> int + + + SetId(self, long i) + + + + + + GetId(self) -> long + + + SetPen(self, wxPen pen) + + + + + + SetBrush(self, wxBrush brush) + + + + + + Show(self, bool show) + + + + + + IsShown(self) -> bool + + + Move(self, DC dc, double x1, double y1, bool display=True) + + + + + + + + + Erase(self, DC dc) + + + + + + EraseContents(self, DC dc) + + + + + + Draw(self, DC dc) + + + + + + Flash(self) + + + MoveLinks(self, DC dc) + + + + + + DrawContents(self, DC dc) + + + + + + SetSize(self, double x, double y, bool recursive=True) + + + + + + + + SetAttachmentSize(self, double x, double y) + + + + + + + Attach(self, PyShapeCanvas can) + + + + + + Detach(self) + + + Constrain(self) -> bool + + + AddLine(self, PyLineShape line, PyShape other, int attachFrom=0, + int attachTo=0, int positionFrom=-1, int positionTo=-1) + + + + + + + + + + + GetLinePosition(self, PyLineShape line) -> int + + + + + + AddText(self, String string) + + + + + + GetPen(self) -> wxPen + + + GetBrush(self) -> wxBrush + + + SetDefaultRegionSize(self) + + + FormatText(self, DC dc, String s, int regionId=0) + + + + + + + + SetFormatMode(self, int mode, int regionId=0) + + + + + + + GetFormatMode(self, int regionId=0) -> int + + + + + + SetFont(self, Font font, int regionId=0) + + + + + + + GetFont(self, int regionId=0) -> Font + + + + + + SetTextColour(self, String colour, int regionId=0) + + + + + + + GetTextColour(self, int regionId=0) -> String + + + + + + GetNumberOfTextRegions(self) -> int + + + SetRegionName(self, String name, int regionId=0) + + + + + + + GetRegionName(self, int regionId) -> String + + + + + + GetRegionId(self, String name) -> int + + + + + + NameRegions(self, String parentName=EmptyString) + + + + + + GetRegions(self) -> PyObject + + + AddRegion(self, ShapeRegion region) + + + + + + ClearRegions(self) + + + AssignNewIds(self) + + + FindRegion(self, String regionName, int OUTPUT) -> PyShape + + + + + + + FindRegionNames(self, wxStringList list) + + + + + + ClearText(self, int regionId=0) + + + + + + RemoveLine(self, PyLineShape line) + + + + + + GetAttachmentPosition(self, int attachment, double OUTPUT, double OUTPUT, int nth=0, + int no_arcs=1, PyLineShape line=None) -> bool + + + + + + + + + + + GetNumberOfAttachments(self) -> int + + + AttachmentIsValid(self, int attachment) -> bool + + + + + + GetAttachments(self) -> PyObject + + + GetAttachmentPositionEdge(self, int attachment, double OUTPUT, double OUTPUT, int nth=0, + int no_arcs=1, PyLineShape line=None) -> bool + + + + + + + + + + + CalcSimpleAttachment(self, RealPoint pt1, RealPoint pt2, int nth, int noArcs, + PyLineShape line) -> RealPoint + + + + + + + + + + AttachmentSortTest(self, int attachmentPoint, RealPoint pt1, RealPoint pt2) -> bool + + + + + + + + EraseLinks(self, DC dc, int attachment=-1, bool recurse=False) + + + + + + + + DrawLinks(self, DC dc, int attachment=-1, bool recurse=False) + + + + + + + + MoveLineToNewAttachment(self, DC dc, PyLineShape to_move, double x, double y) -> bool + + + + + + + + + ApplyAttachmentOrdering(self, PyObject linesToSort) + + + + + + GetBranchingAttachmentRoot(self, int attachment) -> RealPoint + + + + + + GetBranchingAttachmentInfo(self, int attachment, RealPoint root, RealPoint neck, RealPoint shoulder1, + RealPoint shoulder2) -> bool + + + + + + + + + + GetBranchingAttachmentPoint(self, int attachment, int n, RealPoint attachmentPoint, RealPoint stemPoint) -> bool + + + + + + + + + GetAttachmentLineCount(self, int attachment) -> int + + + + + + SetBranchNeckLength(self, int len) + + + + + + GetBranchNeckLength(self) -> int + + + SetBranchStemLength(self, int len) + + + + + + GetBranchStemLength(self) -> int + + + SetBranchSpacing(self, int len) + + + + + + GetBranchSpacing(self) -> int + + + SetBranchStyle(self, long style) + + + + + + GetBranchStyle(self) -> long + + + PhysicalToLogicalAttachment(self, int physicalAttachment) -> int + + + + + + LogicalToPhysicalAttachment(self, int logicalAttachment) -> int + + + + + + Draggable(self) -> bool + + + HasDescendant(self, PyShape image) -> bool + + + + + + CreateNewCopy(self, bool resetMapping=True, bool recompute=True) -> PyShape + + + + + + + Copy(self, PyShape copy) + + + + + + CopyWithHandler(self, PyShape copy) + + + + + + Rotate(self, double x, double y, double theta) + + + + + + + + GetRotation(self) -> double + + + SetRotation(self, double rotation) + + + + + + ClearAttachments(self) + + + Recentre(self, DC dc) + + + + + + ClearPointList(self, wxList list) + + + + + + GetBackgroundPen(self) -> wxPen + + + GetBackgroundBrush(self) -> wxBrush + + + base_OnDelete(self) + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=False) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self) -> PseudoMetaFile + + + __del__(self) + + + Draw(self, DC dc, double xoffset, double yoffset) + + + + + + + + Clear(self) + + + Copy(self, PseudoMetaFile copy) + + + + + + Scale(self, double sx, double sy) + + + + + + + ScaleTo(self, double w, double h) + + + + + + + Translate(self, double x, double y) + + + + + + + Rotate(self, double x, double y, double theta) + + + + + + + + LoadFromMetaFile(self, String filename, double width, double height) -> bool + + + + + + + + GetBounds(self, double minX, double minY, double maxX, double maxY) + + + + + + + + + CalculateSize(self, PyDrawnShape shape) + + + + + + SetRotateable(self, bool rot) + + + + + + GetRotateable(self) -> bool + + + SetSize(self, double w, double h) + + + + + + + SetFillBrush(self, wxBrush brush) + + + + + + GetFillBrush(self) -> wxBrush + + + SetOutlinePen(self, wxPen pen) + + + + + + GetOutlinePen(self) -> wxPen + + + SetOutlineOp(self, int op) + + + + + + GetOutlineOp(self) -> int + + + IsValid(self) -> bool + + + DrawLine(self, Point pt1, Point pt2) + + + + + + + DrawRectangle(self, Rect rect) + + + + + + DrawRoundedRectangle(self, Rect rect, double radius) + + + + + + + DrawArc(self, Point centrePt, Point startPt, Point endPt) + + + + + + + + DrawEllipticArc(self, Rect rect, double startAngle, double endAngle) + + + + + + + + DrawEllipse(self, Rect rect) + + + + + + DrawPoint(self, Point pt) + + + + + + DrawText(self, String text, Point pt) + + + + + + + DrawLines(self, int points, Point points_array) + + + + + + + DrawPolygon(self, int points, Point points_array, int flags=0) + + + + + + + + DrawSpline(self, int points, Point points_array) + + + + + + + SetClippingRect(self, Rect rect) + + + + + + DestroyClippingRect(self) + + + SetPen(self, wxPen pen, bool isOutline=FALSE) + + + + + + + SetBrush(self, wxBrush brush, bool isFill=FALSE) + + + + + + + SetFont(self, Font font) + + + + + + SetTextColour(self, Colour colour) + + + + + + SetBackgroundColour(self, Colour colour) + + + + + + SetBackgroundMode(self, int mode) + + + + + + + + + __init__(self, double width=0.0, double height=0.0) -> PyRectangleShape + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + SetCornerRadius(self, double radius) + + + + + + GetCornerRadius(self) -> double + + + base_OnDelete(self) + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __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 + + + + + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + SetCornerRadius(self, double radius) + + + + + + base_OnDelete(self) + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self) -> PyBitmapShape + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + GetBitmap(self) -> Bitmap + + + GetFilename(self) -> String + + + SetBitmap(self, Bitmap bitmap) + + + + + + SetFilename(self, String filename) + + + + + + base_OnDelete(self) + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self) -> PyDrawnShape + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + CalculateSize(self) + + + DestroyClippingRect(self) + + + DrawArc(self, Point centrePoint, Point startPoint, Point endPoint) + + + + + + + + DrawAtAngle(self, int angle) + + + + + + DrawEllipticArc(self, Rect rect, double startAngle, double endAngle) + + + + + + + + DrawLine(self, Point point1, Point point2) + + + + + + + DrawLines(self, int points, Point points_array) + + + + + + + DrawPoint(self, Point point) + + + + + + DrawPolygon(self, int points, Point points_array, int flags=0) + + + + + + + + DrawRectangle(self, Rect rect) + + + + + + DrawRoundedRectangle(self, Rect rect, double radius) + + + + + + + DrawSpline(self, int points, Point points_array) + + + + + + + DrawText(self, String text, Point point) + + + + + + + GetAngle(self) -> int + + + GetMetaFile(self) -> PseudoMetaFile + + + GetRotation(self) -> double + + + LoadFromMetaFile(self, String filename) -> bool + + + + + + Rotate(self, double x, double y, double theta) + + + + + + + + SetClippingRect(self, Rect rect) + + + + + + SetDrawnBackgroundColour(self, Colour colour) + + + + + + SetDrawnBackgroundMode(self, int mode) + + + + + + SetDrawnBrush(self, wxBrush pen, bool isOutline=FALSE) + + + + + + + SetDrawnFont(self, Font font) + + + + + + SetDrawnPen(self, wxPen pen, bool isOutline=FALSE) + + + + + + + SetDrawnTextColour(self, Colour colour) + + + + + + Scale(self, double sx, double sy) + + + + + + + SetSaveToFile(self, bool save) + + + + + + Translate(self, double x, double y) + + + + + + + base_OnDelete(self) + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self, int type, PyShape constraining, PyObject constrained) -> OGLConstraint + + + + + + + + Evaluate(self) -> bool + + + SetSpacing(self, double x, double y) + + + + + + + Equals(self, double a, double b) -> bool + + + + + + + + + + __init__(self) -> PyCompositeShape + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + AddChild(self, PyShape child, PyShape addAfter=None) + + + + + + + AddConstraint(self, OGLConstraint constraint) -> OGLConstraint + + + + + + AddConstrainedShapes(self, int type, PyShape constraining, PyObject constrained) -> OGLConstraint + + + + + + + + AddSimpleConstraint(self, int type, PyShape constraining, PyShape constrained) -> OGLConstraint + + + + + + + + CalculateSize(self) + + + ContainsDivision(self, PyDivisionShape division) -> bool + + + + + + DeleteConstraint(self, OGLConstraint constraint) + + + + + + DeleteConstraintsInvolvingChild(self, PyShape child) + + + + + + FindContainerImage(self) -> PyShape + + + GetConstraints(self) -> PyObject + + + GetDivisions(self) -> PyObject + + + MakeContainer(self) + + + Recompute(self) -> bool + + + RemoveChild(self, PyShape child) + + + + + + base_OnDelete(self) + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self, double width=0.0, double height=0.0) -> PyDividedShape + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + EditRegions(self) + + + SetRegionSizes(self) + + + base_OnDelete(self) + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self) -> PyDivisionShape + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + AdjustBottom(self, double bottom, bool test) + + + + + + + AdjustLeft(self, double left, bool test) + + + + + + + AdjustRight(self, double right, bool test) + + + + + + + AdjustTop(self, double top, bool test) + + + + + + + Divide(self, int direction) + + + + + + EditEdge(self, int side) + + + + + + GetBottomSide(self) -> PyDivisionShape + + + GetHandleSide(self) -> int + + + GetLeftSide(self) -> PyDivisionShape + + + GetLeftSideColour(self) -> String + + + GetLeftSidePen(self) -> wxPen + + + GetRightSide(self) -> PyDivisionShape + + + GetTopSide(self) -> PyDivisionShape + + + GetTopSidePen(self) -> wxPen + + + ResizeAdjoining(self, int side, double newPos, bool test) + + + + + + + + PopupMenu(self, double x, double y) + + + + + + + SetBottomSide(self, PyDivisionShape shape) + + + + + + SetHandleSide(self, int side) + + + + + + SetLeftSide(self, PyDivisionShape shape) + + + + + + SetLeftSideColour(self, String colour) + + + + + + SetLeftSidePen(self, wxPen pen) + + + + + + SetRightSide(self, PyDivisionShape shape) + + + + + + SetTopSide(self, PyDivisionShape shape) + + + + + + SetTopSideColour(self, String colour) + + + + + + SetTopSidePen(self, wxPen pen) + + + + + + base_OnDelete(self) + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self, double width=0.0, double height=0.0) -> PyEllipseShape + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self, double width=0.0) -> PyCircleShape + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __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 + + + + + + + + + + + + __del__(self) + + + _GetType(self) -> int + + + GetPosition(self) -> int + + + SetPosition(self, int pos) + + + + + + GetXOffset(self) -> double + + + GetYOffset(self) -> double + + + GetSpacing(self) -> double + + + GetSize(self) -> double + + + GetName(self) -> String + + + SetXOffset(self, double x) + + + + + + SetYOffset(self, double y) + + + + + + GetMetaFile(self) -> PseudoMetaFile + + + GetId(self) -> long + + + GetArrowEnd(self) -> int + + + GetArrowSize(self) -> double + + + SetSize(self, double size) + + + + + + SetSpacing(self, double sp) + + + + + + + + + __init__(self) -> PyLineShape + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + 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) + + + + + + + + + + + + AddArrowOrdered(self, ArrowHead arrow, PyObject referenceList, int end) + + + + + + + + ClearArrow(self, String name) -> bool + + + + + + ClearArrowsAtPosition(self, int position=-1) + + + + + + DrawArrow(self, DC dc, ArrowHead arrow, double xOffset, bool proportionalOffset) + + + + + + + + + DeleteArrowHeadId(self, long arrowId) -> bool + + + + + + DeleteArrowHead(self, int position, String name) -> bool + + + + + + + DeleteLineControlPoint(self) -> bool + + + DrawArrows(self, DC dc) + + + + + + DrawRegion(self, DC dc, ShapeRegion region, double x, double y) + + + + + + + + + EraseRegion(self, DC dc, ShapeRegion region, double x, double y) + + + + + + + + + FindArrowHeadId(self, long arrowId) -> ArrowHead + + + + + + FindArrowHead(self, int position, String name) -> ArrowHead + + + + + + + FindLineEndPoints(self, double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT) + + + + + + + + + FindLinePosition(self, double x, double y) -> int + + + + + + + FindMinimumWidth(self) -> double + + + FindNth(self, PyShape image, int OUTPUT, int OUTPUT, bool incoming) + + + + + + + + + GetAttachmentFrom(self) -> int + + + GetAttachmentTo(self) -> int + + + GetEnds(self, double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT) + + + + + + + + + GetFrom(self) -> PyShape + + + GetLabelPosition(self, int position, double OUTPUT, double OUTPUT) + + + + + + + + GetNextControlPoint(self, PyShape shape) -> RealPoint + + + + + + GetTo(self) -> PyShape + + + Initialise(self) + + + InsertLineControlPoint(self, DC dc) + + + + + + IsEnd(self, PyShape shape) -> bool + + + + + + IsSpline(self) -> bool + + + MakeLineControlPoints(self, int n) + + + + + + GetLineControlPoints(self) -> PyObject + + + SetLineControlPoints(self, PyObject list) + + + + + + SetAttachmentFrom(self, int fromAttach) + + + + + + SetAttachments(self, int fromAttach, int toAttach) + + + + + + + SetAttachmentTo(self, int toAttach) + + + + + + SetEnds(self, double x1, double y1, double x2, double y2) + + + + + + + + + SetFrom(self, PyShape object) + + + + + + SetIgnoreOffsets(self, bool ignore) + + + + + + SetSpline(self, bool spline) + + + + + + SetTo(self, PyShape object) + + + + + + Straighten(self, DC dc=None) + + + + + + Unlink(self) + + + SetAlignmentOrientation(self, bool isEnd, bool isHoriz) + + + + + + + SetAlignmentType(self, bool isEnd, int alignType) + + + + + + + GetAlignmentOrientation(self, bool isEnd) -> bool + + + + + + GetAlignmentType(self, bool isEnd) -> int + + + + + + GetAlignmentStart(self) -> int + + + GetAlignmentEnd(self) -> int + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self) -> PyPolygonShape + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + Create(self, PyObject points) -> PyObject + + + + + + AddPolygonPoint(self, int pos=0) + + + + + + CalculatePolygonCentre(self) + + + DeletePolygonPoint(self, int pos=0) + + + + + + GetPoints(self) -> PyObject + + + GetOriginalPoints(self) -> PyObject + + + GetOriginalWidth(self) -> double + + + GetOriginalHeight(self) -> double + + + SetOriginalWidth(self, double w) + + + + + + SetOriginalHeight(self, double h) + + + + + + UpdateOriginalPoints(self) + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self, double width=0.0, double height=0.0) -> PyTextShape + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + base_OnDelete(self) + + + base_OnDraw(self, DC dc) + + + + + + base_OnDrawContents(self, DC dc) + + + + + + base_OnDrawBranches(self, DC dc, bool erase=FALSE) + + + + + + + base_OnMoveLinks(self, DC dc) + + + + + + base_OnErase(self, DC dc) + + + + + + base_OnEraseContents(self, DC dc) + + + + + + base_OnHighlight(self, DC dc) + + + + + + base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnSize(self, double x, double y) + + + + + + + base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) -> bool + + + + + + + + + + + base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, + bool display=True) + + + + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0) + + + + + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragLeft(self, 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) + + + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0) + + + + + + + + + base_OnDrawOutline(self, DC dc, double x, double y, double w, double h) + + + + + + + + + + base_OnDrawControlPoints(self, DC dc) + + + + + + base_OnEraseControlPoints(self, DC dc) + + + + + + base_OnMoveLink(self, DC dc, bool moveControlPoints=True) + + + + + + + base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + + base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, + int attachment=0) + + + + + + + + + + base_OnBeginSize(self, double w, double h) + + + + + + + base_OnEndSize(self, double w, double h) + + + + + + + + + + __init__(self) -> Diagram + + + AddShape(self, PyShape shape, PyShape addAfter=None) + + + + + + + Clear(self, DC dc) + + + + + + DeleteAllShapes(self) + + + DrawOutline(self, DC dc, double x1, double y1, double x2, double y2) + + + + + + + + + + FindShape(self, long id) -> PyShape + + + + + + GetCanvas(self) -> PyShapeCanvas + + + GetCount(self) -> int + + + GetGridSpacing(self) -> double + + + GetMouseTolerance(self) -> int + + + GetShapeList(self) -> PyObject + + + GetQuickEditMode(self) -> bool + + + GetSnapToGrid(self) -> bool + + + InsertShape(self, PyShape shape) + + + + + + RecentreAll(self, DC dc) + + + + + + Redraw(self, DC dc) + + + + + + RemoveAllShapes(self) + + + RemoveShape(self, PyShape shape) + + + + + + SetCanvas(self, PyShapeCanvas canvas) + + + + + + SetGridSpacing(self, double spacing) + + + + + + SetMouseTolerance(self, int tolerance) + + + + + + SetQuickEditMode(self, bool mode) + + + + + + SetSnapToGrid(self, bool snap) + + + + + + ShowAll(self, bool show) + + + + + + Snap(self, double INOUT, double INOUT) + + + + + + + + + + __init__(self, Window parent=None, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=BORDER, + String name=wxPyShapeCanvasNameStr) -> PyShapeCanvas + + + + + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + AddShape(self, PyShape shape, PyShape addAfter=None) + + + + + + + FindShape(self, double x1, double y, int OUTPUT, wxClassInfo info=None, + PyShape notImage=None) -> PyShape + + + + + + + + + + FindFirstSensitiveShape(self, double x1, double y, int OUTPUT, int op) -> PyShape + + + + + + + + + GetDiagram(self) -> Diagram + + + GetQuickEditMode(self) -> bool + + + InsertShape(self, PyShape shape) + + + + + + base_OnBeginDragLeft(self, double x, double y, int keys=0) + + + + + + + + base_OnBeginDragRight(self, double x, double y, int keys=0) + + + + + + + + base_OnEndDragLeft(self, double x, double y, int keys=0) + + + + + + + + base_OnEndDragRight(self, double x, double y, int keys=0) + + + + + + + + base_OnDragLeft(self, bool draw, double x, double y, int keys=0) + + + + + + + + + base_OnDragRight(self, bool draw, double x, double y, int keys=0) + + + + + + + + + base_OnLeftClick(self, double x, double y, int keys=0) + + + + + + + + base_OnRightClick(self, double x, double y, int keys=0) + + + + + + + + Redraw(self, DC dc) + + + + + + RemoveShape(self, PyShape shape) + + + + + + SetDiagram(self, Diagram diagram) + + + + + + Snap(self, double INOUT, double INOUT) + + + + + + + +# Aliases +ShapeCanvas = PyShapeCanvas +ShapeEvtHandler = PyShapeEvtHandler +Shape = PyShape +RectangleShape = PyRectangleShape +BitmapShape = PyBitmapShape +DrawnShape = PyDrawnShape +CompositeShape = PyCompositeShape +DividedShape = PyDividedShape +DivisionShape = PyDivisionShape +EllipseShape = PyEllipseShape +CircleShape = PyCircleShape +LineShape = PyLineShape +PolygonShape = PyPolygonShape +TextShape = PyTextShape +ControlPoint = PyControlPoint + + + OGLInitialize() + + + OGLCleanUp() + + + + + + wx = _core + __docfilter__ = wx.__DocFilter(globals()) + + + + __init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=STCNameStr) -> StyledTextCtrl + + + + + + + + + + + PreStyledTextCtrl() -> StyledTextCtrl + + + Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0, String name=wxSTCNameStr) + + + + + + + + + + + AddText(self, String text) + + + + + + AddStyledText(self, wxMemoryBuffer data) + + + + + + InsertText(self, int pos, String text) + + + + + + + ClearAll(self) + + + ClearDocumentStyle(self) + + + GetLength(self) -> int + + + GetCharAt(self, int pos) -> int + + + + + + GetCurrentPos(self) -> int + + + GetAnchor(self) -> int + + + GetStyleAt(self, int pos) -> int + + + + + + Redo(self) + + + SetUndoCollection(self, bool collectUndo) + + + + + + SelectAll(self) + + + SetSavePoint(self) + + + GetStyledText(self, int startPos, int endPos) -> wxMemoryBuffer + + + + + + + CanRedo(self) -> bool + + + MarkerLineFromHandle(self, int handle) -> int + + + + + + MarkerDeleteHandle(self, int handle) + + + + + + GetUndoCollection(self) -> bool + + + GetViewWhiteSpace(self) -> int + + + SetViewWhiteSpace(self, int viewWS) + + + + + + PositionFromPoint(self, Point pt) -> int + + + + + + PositionFromPointClose(self, int x, int y) -> int + + + + + + + GotoLine(self, int line) + + + + + + GotoPos(self, int pos) + + + + + + SetAnchor(self, int posAnchor) + + + + + + GetCurLine(self, int OUTPUT) -> String + + + + + + GetEndStyled(self) -> int + + + ConvertEOLs(self, int eolMode) + + + + + + GetEOLMode(self) -> int + + + SetEOLMode(self, int eolMode) + + + + + + StartStyling(self, int pos, int mask) + + + + + + + SetStyling(self, int length, int style) + + + + + + + GetBufferedDraw(self) -> bool + + + SetBufferedDraw(self, bool buffered) + + + + + + SetTabWidth(self, int tabWidth) + + + + + + GetTabWidth(self) -> int + + + SetCodePage(self, int codePage) + + + + + + MarkerDefine(self, int markerNumber, int markerSymbol, Colour foreground=wxNullColour, + Colour background=wxNullColour) + + + + + + + + + MarkerSetForeground(self, int markerNumber, Colour fore) + + + + + + + MarkerSetBackground(self, int markerNumber, Colour back) + + + + + + + MarkerAdd(self, int line, int markerNumber) -> int + + + + + + + MarkerDelete(self, int line, int markerNumber) + + + + + + + MarkerDeleteAll(self, int markerNumber) + + + + + + MarkerGet(self, int line) -> int + + + + + + MarkerNext(self, int lineStart, int markerMask) -> int + + + + + + + MarkerPrevious(self, int lineStart, int markerMask) -> int + + + + + + + MarkerDefineBitmap(self, int markerNumber, Bitmap bmp) + + + + + + + SetMarginType(self, int margin, int marginType) + + + + + + + GetMarginType(self, int margin) -> int + + + + + + SetMarginWidth(self, int margin, int pixelWidth) + + + + + + + GetMarginWidth(self, int margin) -> int + + + + + + SetMarginMask(self, int margin, int mask) + + + + + + + GetMarginMask(self, int margin) -> int + + + + + + SetMarginSensitive(self, int margin, bool sensitive) + + + + + + + GetMarginSensitive(self, int margin) -> bool + + + + + + StyleClearAll(self) + + + StyleSetForeground(self, int style, Colour fore) + + + + + + + StyleSetBackground(self, int style, Colour back) + + + + + + + StyleSetBold(self, int style, bool bold) + + + + + + + StyleSetItalic(self, int style, bool italic) + + + + + + + StyleSetSize(self, int style, int sizePoints) + + + + + + + StyleSetFaceName(self, int style, String fontName) + + + + + + + StyleSetEOLFilled(self, int style, bool filled) + + + + + + + StyleResetDefault(self) + + + StyleSetUnderline(self, int style, bool underline) + + + + + + + StyleSetCase(self, int style, int caseForce) + + + + + + + StyleSetCharacterSet(self, int style, int characterSet) + + + + + + + StyleSetHotSpot(self, int style, bool hotspot) + + + + + + + SetSelForeground(self, bool useSetting, Colour fore) + + + + + + + SetSelBackground(self, bool useSetting, Colour back) + + + + + + + SetCaretForeground(self, Colour fore) + + + + + + CmdKeyAssign(self, int key, int modifiers, int cmd) + + + + + + + + CmdKeyClear(self, int key, int modifiers) + + + + + + + CmdKeyClearAll(self) + + + SetStyleBytes(self, int length, char styleBytes) + + + + + + + StyleSetVisible(self, int style, bool visible) + + + + + + + GetCaretPeriod(self) -> int + + + SetCaretPeriod(self, int periodMilliseconds) + + + + + + SetWordChars(self, String characters) + + + + + + BeginUndoAction(self) + + + EndUndoAction(self) + + + IndicatorSetStyle(self, int indic, int style) + + + + + + + IndicatorGetStyle(self, int indic) -> int + + + + + + IndicatorSetForeground(self, int indic, Colour fore) + + + + + + + IndicatorGetForeground(self, int indic) -> Colour + + + + + + SetWhitespaceForeground(self, bool useSetting, Colour fore) + + + + + + + SetWhitespaceBackground(self, bool useSetting, Colour back) + + + + + + + SetStyleBits(self, int bits) + + + + + + GetStyleBits(self) -> int + + + SetLineState(self, int line, int state) + + + + + + + GetLineState(self, int line) -> int + + + + + + GetMaxLineState(self) -> int + + + GetCaretLineVisible(self) -> bool + + + SetCaretLineVisible(self, bool show) + + + + + + GetCaretLineBack(self) -> Colour + + + SetCaretLineBack(self, Colour back) + + + + + + StyleSetChangeable(self, int style, bool changeable) + + + + + + + AutoCompShow(self, int lenEntered, String itemList) + + + + + + + AutoCompCancel(self) + + + AutoCompActive(self) -> bool + + + AutoCompPosStart(self) -> int + + + AutoCompComplete(self) + + + AutoCompStops(self, String characterSet) + + + + + + AutoCompSetSeparator(self, int separatorCharacter) + + + + + + AutoCompGetSeparator(self) -> int + + + AutoCompSelect(self, String text) + + + + + + AutoCompSetCancelAtStart(self, bool cancel) + + + + + + AutoCompGetCancelAtStart(self) -> bool + + + AutoCompSetFillUps(self, String characterSet) + + + + + + AutoCompSetChooseSingle(self, bool chooseSingle) + + + + + + AutoCompGetChooseSingle(self) -> bool + + + AutoCompSetIgnoreCase(self, bool ignoreCase) + + + + + + AutoCompGetIgnoreCase(self) -> bool + + + UserListShow(self, int listType, String itemList) + + + + + + + AutoCompSetAutoHide(self, bool autoHide) + + + + + + AutoCompGetAutoHide(self) -> bool + + + AutoCompSetDropRestOfWord(self, bool dropRestOfWord) + + + + + + AutoCompGetDropRestOfWord(self) -> bool + + + RegisterImage(self, int type, Bitmap bmp) + + + + + + + ClearRegisteredImages(self) + + + AutoCompGetTypeSeparator(self) -> int + + + AutoCompSetTypeSeparator(self, int separatorCharacter) + + + + + + SetIndent(self, int indentSize) + + + + + + GetIndent(self) -> int + + + SetUseTabs(self, bool useTabs) + + + + + + GetUseTabs(self) -> bool + + + SetLineIndentation(self, int line, int indentSize) + + + + + + + GetLineIndentation(self, int line) -> int + + + + + + GetLineIndentPosition(self, int line) -> int + + + + + + GetColumn(self, int pos) -> int + + + + + + SetUseHorizontalScrollBar(self, bool show) + + + + + + GetUseHorizontalScrollBar(self) -> bool + + + SetIndentationGuides(self, bool show) + + + + + + GetIndentationGuides(self) -> bool + + + SetHighlightGuide(self, int column) + + + + + + GetHighlightGuide(self) -> int + + + GetLineEndPosition(self, int line) -> int + + + + + + GetCodePage(self) -> int + + + GetCaretForeground(self) -> Colour + + + GetReadOnly(self) -> bool + + + SetCurrentPos(self, int pos) + + + + + + SetSelectionStart(self, int pos) + + + + + + GetSelectionStart(self) -> int + + + SetSelectionEnd(self, int pos) + + + + + + GetSelectionEnd(self) -> int + + + SetPrintMagnification(self, int magnification) + + + + + + GetPrintMagnification(self) -> int + + + SetPrintColourMode(self, int mode) + + + + + + GetPrintColourMode(self) -> int + + + FindText(self, int minPos, int maxPos, String text, int flags=0) -> int + + + + + + + + + FormatRange(self, bool doDraw, int startPos, int endPos, DC draw, DC target, + Rect renderRect, Rect pageRect) -> int + + + + + + + + + + + + GetFirstVisibleLine(self) -> int + + + GetLine(self, int line) -> String + + + + + + GetLineCount(self) -> int + + + SetMarginLeft(self, int pixelWidth) + + + + + + GetMarginLeft(self) -> int + + + SetMarginRight(self, int pixelWidth) + + + + + + GetMarginRight(self) -> int + + + GetModify(self) -> bool + + + SetSelection(self, int start, int end) + + + + + + + GetSelectedText(self) -> String + + + GetTextRange(self, int startPos, int endPos) -> String + + + + + + + HideSelection(self, bool normal) + + + + + + LineFromPosition(self, int pos) -> int + + + + + + PositionFromLine(self, int line) -> int + + + + + + LineScroll(self, int columns, int lines) + + + + + + + EnsureCaretVisible(self) + + + ReplaceSelection(self, String text) + + + + + + SetReadOnly(self, bool readOnly) + + + + + + CanPaste(self) -> bool + + + CanUndo(self) -> bool + + + EmptyUndoBuffer(self) + + + Undo(self) + + + Cut(self) + + + Copy(self) + + + Paste(self) + + + Clear(self) + + + SetText(self, String text) + + + + + + GetText(self) -> String + + + GetTextLength(self) -> int + + + SetOvertype(self, bool overtype) + + + + + + GetOvertype(self) -> bool + + + SetCaretWidth(self, int pixelWidth) + + + + + + GetCaretWidth(self) -> int + + + SetTargetStart(self, int pos) + + + + + + GetTargetStart(self) -> int + + + SetTargetEnd(self, int pos) + + + + + + GetTargetEnd(self) -> int + + + ReplaceTarget(self, String text) -> int + + + + + + ReplaceTargetRE(self, String text) -> int + + + + + + SearchInTarget(self, String text) -> int + + + + + + SetSearchFlags(self, int flags) + + + + + + GetSearchFlags(self) -> int + + + CallTipShow(self, int pos, String definition) + + + + + + + CallTipCancel(self) + + + CallTipActive(self) -> bool + + + CallTipPosAtStart(self) -> int + + + CallTipSetHighlight(self, int start, int end) + + + + + + + CallTipSetBackground(self, Colour back) + + + + + + CallTipSetForeground(self, Colour fore) + + + + + + CallTipSetForegroundHighlight(self, Colour fore) + + + + + + VisibleFromDocLine(self, int line) -> int + + + + + + DocLineFromVisible(self, int lineDisplay) -> int + + + + + + SetFoldLevel(self, int line, int level) + + + + + + + GetFoldLevel(self, int line) -> int + + + + + + GetLastChild(self, int line, int level) -> int + + + + + + + GetFoldParent(self, int line) -> int + + + + + + ShowLines(self, int lineStart, int lineEnd) + + + + + + + HideLines(self, int lineStart, int lineEnd) + + + + + + + GetLineVisible(self, int line) -> bool + + + + + + SetFoldExpanded(self, int line, bool expanded) + + + + + + + GetFoldExpanded(self, int line) -> bool + + + + + + ToggleFold(self, int line) + + + + + + EnsureVisible(self, int line) + + + + + + SetFoldFlags(self, int flags) + + + + + + EnsureVisibleEnforcePolicy(self, int line) + + + + + + SetTabIndents(self, bool tabIndents) + + + + + + GetTabIndents(self) -> bool + + + SetBackSpaceUnIndents(self, bool bsUnIndents) + + + + + + GetBackSpaceUnIndents(self) -> bool + + + SetMouseDwellTime(self, int periodMilliseconds) + + + + + + GetMouseDwellTime(self) -> int + + + WordStartPosition(self, int pos, bool onlyWordCharacters) -> int + + + + + + + WordEndPosition(self, int pos, bool onlyWordCharacters) -> int + + + + + + + SetWrapMode(self, int mode) + + + + + + GetWrapMode(self) -> int + + + SetLayoutCache(self, int mode) + + + + + + GetLayoutCache(self) -> int + + + SetScrollWidth(self, int pixelWidth) + + + + + + GetScrollWidth(self) -> int + + + TextWidth(self, int style, String text) -> int + + + + + + + SetEndAtLastLine(self, bool endAtLastLine) + + + + + + GetEndAtLastLine(self) -> int + + + TextHeight(self, int line) -> int + + + + + + SetUseVerticalScrollBar(self, bool show) + + + + + + GetUseVerticalScrollBar(self) -> bool + + + AppendText(self, int length, String text) + + + + + + + GetTwoPhaseDraw(self) -> bool + + + SetTwoPhaseDraw(self, bool twoPhase) + + + + + + TargetFromSelection(self) + + + LinesJoin(self) + + + LinesSplit(self, int pixelWidth) + + + + + + SetFoldMarginColour(self, bool useSetting, Colour back) + + + + + + + SetFoldMarginHiColour(self, bool useSetting, Colour fore) + + + + + + + LineDown(self) + This is just a wrapper for ScrollLines(1). + + + LineDownExtend(self) + + + LineUp(self) + This is just a wrapper for ScrollLines(-1). + + + LineUpExtend(self) + + + CharLeft(self) + + + CharLeftExtend(self) + + + CharRight(self) + + + CharRightExtend(self) + + + WordLeft(self) + + + WordLeftExtend(self) + + + WordRight(self) + + + WordRightExtend(self) + + + Home(self) + + + HomeExtend(self) + + + LineEnd(self) + + + LineEndExtend(self) + + + DocumentStart(self) + + + DocumentStartExtend(self) + + + DocumentEnd(self) + + + DocumentEndExtend(self) + + + PageUp(self) + This is just a wrapper for ScrollPages(-1). + + + PageUpExtend(self) + + + PageDown(self) + This is just a wrapper for ScrollPages(1). + + + PageDownExtend(self) + + + EditToggleOvertype(self) + + + Cancel(self) + + + DeleteBack(self) + + + Tab(self) + + + BackTab(self) + + + NewLine(self) + + + FormFeed(self) + + + VCHome(self) + + + VCHomeExtend(self) + + + ZoomIn(self) + + + ZoomOut(self) + + + DelWordLeft(self) + + + DelWordRight(self) + + + LineCut(self) + + + LineDelete(self) + + + LineTranspose(self) + + + LineDuplicate(self) + + + LowerCase(self) + + + UpperCase(self) + + + LineScrollDown(self) + + + LineScrollUp(self) + + + DeleteBackNotLine(self) + + + HomeDisplay(self) + + + HomeDisplayExtend(self) + + + LineEndDisplay(self) + + + LineEndDisplayExtend(self) + + + HomeWrap(self) + + + HomeWrapExtend(self) + + + LineEndWrap(self) + + + LineEndWrapExtend(self) + + + VCHomeWrap(self) + + + VCHomeWrapExtend(self) + + + LineCopy(self) + + + MoveCaretInsideView(self) + + + LineLength(self, int line) -> int + + + + + + BraceHighlight(self, int pos1, int pos2) + + + + + + + BraceBadLight(self, int pos) + + + + + + BraceMatch(self, int pos) -> int + + + + + + GetViewEOL(self) -> bool + + + SetViewEOL(self, bool visible) + + + + + + GetDocPointer(self) -> void + + + SetDocPointer(self, void docPointer) + + + + + + SetModEventMask(self, int mask) + + + + + + GetEdgeColumn(self) -> int + + + SetEdgeColumn(self, int column) + + + + + + GetEdgeMode(self) -> int + + + SetEdgeMode(self, int mode) + + + + + + GetEdgeColour(self) -> Colour + + + SetEdgeColour(self, Colour edgeColour) + + + + + + SearchAnchor(self) + + + SearchNext(self, int flags, String text) -> int + + + + + + + SearchPrev(self, int flags, String text) -> int + + + + + + + LinesOnScreen(self) -> int + + + UsePopUp(self, bool allowPopUp) + + + + + + SelectionIsRectangle(self) -> bool + + + SetZoom(self, int zoom) + + + + + + GetZoom(self) -> int + + + CreateDocument(self) -> void + + + AddRefDocument(self, void docPointer) + + + + + + ReleaseDocument(self, void docPointer) + + + + + + GetModEventMask(self) -> int + + + SetSTCFocus(self, bool focus) + + + + + + GetSTCFocus(self) -> bool + + + SetStatus(self, int statusCode) + + + + + + GetStatus(self) -> int + + + SetMouseDownCaptures(self, bool captures) + + + + + + GetMouseDownCaptures(self) -> bool + + + SetSTCCursor(self, int cursorType) + + + + + + GetSTCCursor(self) -> int + + + SetControlCharSymbol(self, int symbol) + + + + + + GetControlCharSymbol(self) -> int + + + WordPartLeft(self) + + + WordPartLeftExtend(self) + + + WordPartRight(self) + + + WordPartRightExtend(self) + + + SetVisiblePolicy(self, int visiblePolicy, int visibleSlop) + + + + + + + DelLineLeft(self) + + + DelLineRight(self) + + + SetXOffset(self, int newOffset) + + + + + + GetXOffset(self) -> int + + + ChooseCaretX(self) + + + SetXCaretPolicy(self, int caretPolicy, int caretSlop) + + + + + + + SetYCaretPolicy(self, int caretPolicy, int caretSlop) + + + + + + + SetPrintWrapMode(self, int mode) + + + + + + GetPrintWrapMode(self) -> int + + + SetHotspotActiveForeground(self, bool useSetting, Colour fore) + + + + + + + SetHotspotActiveBackground(self, bool useSetting, Colour back) + + + + + + + SetHotspotActiveUnderline(self, bool underline) + + + + + + SetHotspotSingleLine(self, bool singleLine) + + + + + + ParaDown(self) + + + ParaDownExtend(self) + + + ParaUp(self) + + + ParaUpExtend(self) + + + PositionBefore(self, int pos) -> int + + + + + + PositionAfter(self, int pos) -> int + + + + + + CopyRange(self, int start, int end) + + + + + + + CopyText(self, int length, String text) + + + + + + + SetSelectionMode(self, int mode) + + + + + + GetSelectionMode(self) -> int + + + GetLineSelStartPosition(self, int line) -> int + + + + + + GetLineSelEndPosition(self, int line) -> int + + + + + + LineDownRectExtend(self) + + + LineUpRectExtend(self) + + + CharLeftRectExtend(self) + + + CharRightRectExtend(self) + + + HomeRectExtend(self) + + + VCHomeRectExtend(self) + + + LineEndRectExtend(self) + + + PageUpRectExtend(self) + + + PageDownRectExtend(self) + + + StutteredPageUp(self) + + + StutteredPageUpExtend(self) + + + StutteredPageDown(self) + + + StutteredPageDownExtend(self) + + + WordLeftEnd(self) + + + WordLeftEndExtend(self) + + + WordRightEnd(self) + + + WordRightEndExtend(self) + + + SetWhitespaceChars(self, String characters) + + + + + + SetCharsDefault(self) + + + AutoCompGetCurrent(self) -> int + + + StartRecord(self) + + + StopRecord(self) + + + SetLexer(self, int lexer) + + + + + + GetLexer(self) -> int + + + Colourise(self, int start, int end) + + + + + + + SetProperty(self, String key, String value) + + + + + + + SetKeyWords(self, int keywordSet, String keyWords) + + + + + + + SetLexerLanguage(self, String language) + + + + + + GetCurrentLine(self) -> int + + + StyleSetSpec(self, int styleNum, String spec) + + + + + + + StyleSetFont(self, int styleNum, Font font) + + + + + + + StyleSetFontAttr(self, int styleNum, int size, String faceName, bool bold, + bool italic, bool underline) + + + + + + + + + + + CmdKeyExecute(self, int cmd) + + + + + + SetMargins(self, int left, int right) + + + + + + + GetSelection(self, int OUTPUT, int OUTPUT) + + + + + + + PointFromPosition(self, int pos) -> Point + + + + + + ScrollToLine(self, int line) + + + + + + ScrollToColumn(self, int column) + + + + + + SendMsg(self, int msg, long wp=0, long lp=0) -> long + + + + + + + + SetVScrollBar(self, wxScrollBar bar) + + + + + + SetHScrollBar(self, wxScrollBar bar) + + + + + + GetLastKeydownProcessed(self) -> bool + + + SetLastKeydownProcessed(self, bool val) + + + + + + SaveFile(self, String filename) -> bool + + + + + + LoadFile(self, String filename) -> bool + + + + + + DoDragOver(self, int x, int y, int def) -> int + + + + + + + + DoDropText(self, long x, long y, String data) -> bool + + + + + + + + SetUseAntiAliasing(self, bool useAA) + + + + + + GetUseAntiAliasing(self) -> bool + + + + + + __init__(self, wxEventType commandType=0, int id=0) -> StyledTextEvent + + + + + + + __del__(self) + + + SetPosition(self, int pos) + + + + + + SetKey(self, int k) + + + + + + SetModifiers(self, int m) + + + + + + SetModificationType(self, int t) + + + + + + SetText(self, String t) + + + + + + SetLength(self, int len) + + + + + + SetLinesAdded(self, int num) + + + + + + SetLine(self, int val) + + + + + + SetFoldLevelNow(self, int val) + + + + + + SetFoldLevelPrev(self, int val) + + + + + + SetMargin(self, int val) + + + + + + SetMessage(self, int val) + + + + + + SetWParam(self, int val) + + + + + + SetLParam(self, int val) + + + + + + SetListType(self, int val) + + + + + + SetX(self, int val) + + + + + + SetY(self, int val) + + + + + + SetDragText(self, String val) + + + + + + SetDragAllowMove(self, bool val) + + + + + + SetDragResult(self, int val) + + + + + + GetPosition(self) -> int + + + GetKey(self) -> int + + + GetModifiers(self) -> int + + + GetModificationType(self) -> int + + + GetText(self) -> String + + + GetLength(self) -> int + + + GetLinesAdded(self) -> int + + + GetLine(self) -> int + + + GetFoldLevelNow(self) -> int + + + GetFoldLevelPrev(self) -> int + + + GetMargin(self) -> int + + + GetMessage(self) -> int + + + GetWParam(self) -> int + + + GetLParam(self) -> int + + + GetListType(self) -> int + + + GetX(self) -> int + + + GetY(self) -> int + + + GetDragText(self) -> String + + + GetDragAllowMove(self) -> bool + + + GetDragResult(self) -> int + + + GetShift(self) -> bool + + + GetControl(self) -> bool + + + GetAlt(self) -> bool + + + Clone(self) -> Event + + + +EVT_STC_CHANGE = wx.PyEventBinder( wxEVT_STC_CHANGE, 1 ) +EVT_STC_STYLENEEDED = wx.PyEventBinder( wxEVT_STC_STYLENEEDED, 1 ) +EVT_STC_CHARADDED = wx.PyEventBinder( wxEVT_STC_CHARADDED, 1 ) +EVT_STC_SAVEPOINTREACHED = wx.PyEventBinder( wxEVT_STC_SAVEPOINTREACHED, 1 ) +EVT_STC_SAVEPOINTLEFT = wx.PyEventBinder( wxEVT_STC_SAVEPOINTLEFT, 1 ) +EVT_STC_ROMODIFYATTEMPT = wx.PyEventBinder( wxEVT_STC_ROMODIFYATTEMPT, 1 ) +EVT_STC_KEY = wx.PyEventBinder( wxEVT_STC_KEY, 1 ) +EVT_STC_DOUBLECLICK = wx.PyEventBinder( wxEVT_STC_DOUBLECLICK, 1 ) +EVT_STC_UPDATEUI = wx.PyEventBinder( wxEVT_STC_UPDATEUI, 1 ) +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_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 ) +EVT_STC_DWELLSTART = wx.PyEventBinder( wxEVT_STC_DWELLSTART, 1 ) +EVT_STC_DWELLEND = wx.PyEventBinder( wxEVT_STC_DWELLEND, 1 ) +EVT_STC_START_DRAG = wx.PyEventBinder( wxEVT_STC_START_DRAG, 1 ) +EVT_STC_DRAG_OVER = wx.PyEventBinder( wxEVT_STC_DRAG_OVER, 1 ) +EVT_STC_DO_DROP = wx.PyEventBinder( wxEVT_STC_DO_DROP, 1 ) +EVT_STC_ZOOM = wx.PyEventBinder( wxEVT_STC_ZOOM, 1 ) +EVT_STC_HOTSPOT_CLICK = wx.PyEventBinder( wxEVT_STC_HOTSPOT_CLICK, 1 ) +EVT_STC_HOTSPOT_DCLICK = wx.PyEventBinder( wxEVT_STC_HOTSPOT_DCLICK, 1 ) +EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK, 1 ) + + + + + wx = _core + __docfilter__ = wx.__DocFilter(globals()) + +#--------------------------------------------------------------------------- + + + + + __init__(self, String filemask, int flags=XRC_USE_LOCALE) -> XmlResource + + + + + + + EmptyXmlResource(int flags=XRC_USE_LOCALE) -> XmlResource + + + + + + __del__(self) + + + Load(self, String filemask) -> bool + + + + + + LoadFromString(self, String data) -> bool + + + + + + InitAllHandlers(self) + + + AddHandler(self, XmlResourceHandler handler) + + + + + + InsertHandler(self, XmlResourceHandler handler) + + + + + + ClearHandlers(self) + + + AddSubclassFactory(XmlSubclassFactory factory) + + + + + + LoadMenu(self, String name) -> Menu + + + + + + LoadMenuBar(self, String name) -> MenuBar + + + + + + LoadMenuBarOnFrame(self, Window parent, String name) -> MenuBar + + + + + + + LoadToolBar(self, Window parent, String name) -> wxToolBar + + + + + + + LoadDialog(self, Window parent, String name) -> wxDialog + + + + + + + LoadOnDialog(self, wxDialog dlg, Window parent, String name) -> bool + + + + + + + + LoadPanel(self, Window parent, String name) -> wxPanel + + + + + + + LoadOnPanel(self, wxPanel panel, Window parent, String name) -> bool + + + + + + + + LoadFrame(self, Window parent, String name) -> wxFrame + + + + + + + LoadOnFrame(self, wxFrame frame, Window parent, String name) -> bool + + + + + + + + LoadObject(self, Window parent, String name, String classname) -> Object + + + + + + + + LoadOnObject(self, Object instance, Window parent, String name, String classname) -> bool + + + + + + + + + LoadBitmap(self, String name) -> Bitmap + + + + + + LoadIcon(self, String name) -> Icon + + + + + + AttachUnknownControl(self, String name, Window control, Window parent=None) -> bool + + + + + + + + GetXRCID(String str_id) -> int + + + + + + GetVersion(self) -> long + + + CompareVersion(self, int major, int minor, int release, int revision) -> int + + + + + + + + + Get() -> XmlResource + + + Set(XmlResource res) -> XmlResource + + + + + + GetFlags(self) -> int + + + SetFlags(self, int flags) + + + + + + +def XRCID(str_id): + return XmlResource_GetXRCID(str_id) + +def XRCCTRL(window, str_id, *ignoreargs): + return window.FindWindowById(XRCID(str_id)) + + +#--------------------------------------------------------------------------- + + + + __init__(self) -> XmlSubclassFactory + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + +#--------------------------------------------------------------------------- + + + + __init__(self, String name=EmptyString, String value=EmptyString, + XmlProperty next=None) -> XmlProperty + + + + + + + + GetName(self) -> String + + + GetValue(self) -> String + + + GetNext(self) -> XmlProperty + + + SetName(self, String name) + + + + + + SetValue(self, String value) + + + + + + SetNext(self, XmlProperty next) + + + + + + + + __init__(self, XmlNode parent=None, int type=0, String name=EmptyString, + String content=EmptyString, XmlProperty props=None, + XmlNode next=None) -> XmlNode + + + + + + + + + + + XmlNodeEasy(int type, String name, String content=EmptyString) -> XmlNode + + + + + + + + __del__(self) + + + AddChild(self, XmlNode child) + + + + + + InsertChild(self, XmlNode child, XmlNode before_node) + + + + + + + RemoveChild(self, XmlNode child) -> bool + + + + + + AddProperty(self, XmlProperty prop) + + + + + + AddPropertyName(self, String name, String value) + + + + + + + DeleteProperty(self, String name) -> bool + + + + + + GetType(self) -> int + + + GetName(self) -> String + + + GetContent(self) -> String + + + GetParent(self) -> XmlNode + + + GetNext(self) -> XmlNode + + + GetChildren(self) -> XmlNode + + + GetProperties(self) -> XmlProperty + + + GetPropVal(self, String propName, String defaultVal) -> String + + + + + + + HasProp(self, String propName) -> bool + + + + + + SetType(self, int type) + + + + + + SetName(self, String name) + + + + + + SetContent(self, String con) + + + + + + SetParent(self, XmlNode parent) + + + + + + SetNext(self, XmlNode next) + + + + + + SetChildren(self, XmlNode child) + + + + + + SetProperties(self, XmlProperty prop) + + + + + + + + + __init__(self, String filename, String encoding=UTF8String) -> XmlDocument + + + + + + + XmlDocumentFromStream(InputStream stream, String encoding=UTF8String) -> XmlDocument + + + + + + + EmptyXmlDocument() -> XmlDocument + + + __del__(self) + + + Load(self, String filename, String encoding=UTF8String) -> bool + + + + + + + LoadFromStream(self, InputStream stream, String encoding=UTF8String) -> bool + + + + + + + Save(self, String filename) -> bool + + + + + + SaveToStream(self, OutputStream stream) -> bool + + + + + + IsOk(self) -> bool + + + GetRoot(self) -> XmlNode + + + GetVersion(self) -> String + + + GetFileEncoding(self) -> String + + + SetRoot(self, XmlNode node) + + + + + + SetVersion(self, String version) + + + + + + SetFileEncoding(self, String encoding) + + + + + + +#--------------------------------------------------------------------------- + + + + + __init__(self) -> XmlResourceHandler + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + CreateResource(self, XmlNode node, Object parent, Object instance) -> Object + + + + + + + + SetParentResource(self, XmlResource res) + + + + + + GetResource(self) -> XmlResource + + + GetNode(self) -> XmlNode + + + GetClass(self) -> String + + + GetParent(self) -> Object + + + GetInstance(self) -> Object + + + GetParentAsWindow(self) -> Window + + + GetInstanceAsWindow(self) -> Window + + + IsOfClass(self, XmlNode node, String classname) -> bool + + + + + + + GetNodeContent(self, XmlNode node) -> String + + + + + + HasParam(self, String param) -> bool + + + + + + GetParamNode(self, String param) -> XmlNode + + + + + + GetParamValue(self, String param) -> String + + + + + + AddStyle(self, String name, int value) + + + + + + + AddWindowStyles(self) + + + GetStyle(self, String param=StyleString, int defaults=0) -> int + + + + + + + GetText(self, String param, bool translate=True) -> String + + + + + + + GetID(self) -> int + + + GetName(self) -> String + + + GetBool(self, String param, bool defaultv=False) -> bool + + + + + + + GetLong(self, String param, long defaultv=0) -> long + + + + + + + GetColour(self, String param) -> Colour + + + + + + GetSize(self, String param=SizeString) -> Size + + + + + + GetPosition(self, String param=PosString) -> Point + + + + + + GetDimension(self, String param, int defaultv=0) -> int + + + + + + + GetBitmap(self, String param=BitmapString, wxArtClient defaultArtClient=wxART_OTHER, + Size size=DefaultSize) -> Bitmap + + + + + + + + GetIcon(self, String param=IconString, wxArtClient defaultArtClient=wxART_OTHER, + Size size=DefaultSize) -> Icon + + + + + + + + GetFont(self, String param=FontString) -> Font + + + + + + SetupWindow(self, Window wnd) + + + + + + CreateChildren(self, Object parent, bool this_hnd_only=False) + + + + + + + CreateChildrenPrivately(self, Object parent, XmlNode rootnode=None) + + + + + + + CreateResFromNode(self, XmlNode node, Object parent, Object instance=None) -> Object + + + + + + + + GetCurFileSystem(self) -> FileSystem + + + #---------------------------------------------------------------------------- +# The global was removed in favor of static accessor functions. This is for +# backwards compatibility: + +TheXmlResource = XmlResource_Get() + + +#---------------------------------------------------------------------------- +# Create a factory for handling the subclass property of the object tag. + + +def _my_import(name): + mod = __import__(name) + components = name.split('.') + for comp in components[1:]: + mod = getattr(mod, comp) + return mod + + +class XmlSubclassFactory_Python(XmlSubclassFactory): + def __init__(self): + XmlSubclassFactory.__init__(self) + + def Create(self, className): + assert className.find('.') != -1, "Module name must be specified!" + mname = className[:className.rfind('.')] + cname = className[className.rfind('.')+1:] + module = _my_import(mname) + klass = getattr(module, cname) + inst = klass() + return inst + + +XmlResource_AddSubclassFactory(XmlSubclassFactory_Python()) + +#---------------------------------------------------------------------------- + + + + + + import wx + __docfilter__ = wx._core.__DocFilter(globals()) + + + + __init__(self, Object target) -> DynamicSashSplitEvent + + + + + + + + + __init__(self, Object target) -> DynamicSashUnifyEvent + + + + + + + + + __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 + + + + + + + + + + + PreDynamicSashWindow() -> DynamicSashWindow + + + 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 + + + + + + + + + + + GetHScrollBar(self, Window child) -> ScrollBar + + + + + + GetVScrollBar(self, Window child) -> ScrollBar + + + + + + +EVT_DYNAMIC_SASH_SPLIT = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_SPLIT, 1 ) +EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) + + + + + __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 + + + + + + + + + + + + SetStrings(self, wxArrayString strings) + + + + + + GetStrings(self) -> PyObject + + + GetListCtrl(self) -> ListCtrl + + + GetDelButton(self) -> BitmapButton + + + GetNewButton(self) -> BitmapButton + + + GetUpButton(self) -> BitmapButton + + + GetDownButton(self) -> BitmapButton + + + GetEditButton(self) -> BitmapButton + + + + + + __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, + long style=TR_HAS_BUTTONS) -> RemotelyScrolledTreeCtrl + + + + + + + + + + HideVScrollbar(self) + + + AdjustRemoteScrollbars(self) + + + GetScrolledWindow(self) -> ScrolledWindow + + + ScrollToLine(self, int posHoriz, int posVert) + + + + + + + SetCompanionWindow(self, Window companion) + + + + + + GetCompanionWindow(self) -> Window + + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0) -> TreeCompanionWindow + + + + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + GetTreeCtrl(self) -> RemotelyScrolledTreeCtrl + + + SetTreeCtrl(self, RemotelyScrolledTreeCtrl treeCtrl) + + + + + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxSP_3D|wxCLIP_CHILDREN) -> ThinSplitterWindow + + + + + + + + + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=0) -> SplitterScrolledWindow + + + + + + + + + + + + + __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -> LEDNumberCtrl + + + + + + + + + + PreLEDNumberCtrl() -> LEDNumberCtrl + + + Create(self, Window parent, int id=-1, Point pos=DefaultPosition, + Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -> bool + + + + + + + + + + GetAlignment(self) -> int + + + GetDrawFaded(self) -> bool + + + GetValue(self) -> String + + + SetAlignment(self, int Alignment, bool Redraw=true) + + + + + + + SetDrawFaded(self, bool DrawFaded, bool Redraw=true) + + + + + + + SetValue(self, String Value, bool Redraw=true) + + + + + + + wx.TR_DONT_ADJUST_MAC = TR_DONT_ADJUST_MAC + + + + __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(self) -> int + + + GetText(self) -> String + + + GetImage(self) -> int + + + GetSelectedImage(self) -> int + + + GetWidth(self) -> size_t + + + SetShown(self, bool shown) + + + + + + SetAlignment(self, int alignment) + + + + + + SetText(self, String text) + + + + + + SetImage(self, int image) + + + + + + SetSelectedImage(self, int image) + + + + + + SetWidth(self, size_t with) + + + + + + + + + __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 + + + + + + + + + + + + PreTreeListCtrl() -> TreeListCtrl + + + 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 + Do the 2nd phase and create the GUI control. + + + + + + + + + + + + _setCallbackInfo(self, PyObject self, PyObject _class) + + + + + + + GetCount(self) -> size_t + + + GetIndent(self) -> unsigned int + + + SetIndent(self, unsigned int indent) + + + + + + GetLineSpacing(self) -> unsigned int + + + SetLineSpacing(self, unsigned int spacing) + + + + + + GetImageList(self) -> ImageList + + + GetStateImageList(self) -> ImageList + + + GetButtonsImageList(self) -> ImageList + + + SetImageList(self, ImageList imageList) + + + + + + SetStateImageList(self, ImageList imageList) + + + + + + SetButtonsImageList(self, ImageList imageList) + + + + + + AssignImageList(self, ImageList imageList) + + + + + + AssignStateImageList(self, ImageList imageList) + + + + + + AssignButtonsImageList(self, ImageList imageList) + + + + + + AddColumn(self, String text) + + + + + + AddColumnInfo(self, TreeListColumnInfo col) + + + + + + InsertColumn(self, size_t before, String text) + + + + + + + InsertColumnInfo(self, size_t before, TreeListColumnInfo col) + + + + + + + RemoveColumn(self, size_t column) + + + + + + GetColumnCount(self) -> size_t + + + SetColumnWidth(self, size_t column, size_t width) + + + + + + + GetColumnWidth(self, size_t column) -> int + + + + + + SetMainColumn(self, size_t column) + + + + + + GetMainColumn(self) -> size_t + + + SetColumnText(self, size_t column, String text) + + + + + + + GetColumnText(self, size_t column) -> String + + + + + + SetColumn(self, size_t column, TreeListColumnInfo info) + + + + + + + GetColumn(self, size_t column) -> TreeListColumnInfo + + + + + + SetColumnAlignment(self, size_t column, int align) + + + + + + + GetColumnAlignment(self, size_t column) -> int + + + + + + SetColumnImage(self, size_t column, int image) + + + + + + + GetColumnImage(self, size_t column) -> int + + + + + + ShowColumn(self, size_t column, bool shown) + + + + + + + IsColumnShown(self, size_t column) -> bool + + + + + + GetItemText(self, TreeItemId item, int column=-1) -> String + + + + + + + GetItemImage(self, TreeItemId item, int column=-1, int which=TreeItemIcon_Normal) -> int + + + + + + + + SetItemText(self, TreeItemId item, String text, int column=-1) + + + + + + + + SetItemImage(self, TreeItemId item, int image, int column=-1, int which=TreeItemIcon_Normal) + + + + + + + + + GetItemData(self, TreeItemId item) -> TreeItemData + + + + + + SetItemData(self, TreeItemId item, TreeItemData data) + + + + + + + GetItemPyData(self, TreeItemId item) -> PyObject + + + + + + SetItemPyData(self, TreeItemId item, PyObject obj) + + + + + + + SetItemHasChildren(self, TreeItemId item, bool has=True) + + + + + + + SetItemBold(self, TreeItemId item, bool bold=True) + + + + + + + SetItemTextColour(self, TreeItemId item, Colour colour) + + + + + + + SetItemBackgroundColour(self, TreeItemId item, Colour colour) + + + + + + + SetItemFont(self, TreeItemId item, Font font) + + + + + + + GetItemBold(self, TreeItemId item) -> bool + + + + + + GetItemTextColour(self, TreeItemId item) -> Colour + + + + + + GetItemBackgroundColour(self, TreeItemId item) -> Colour + + + + + + GetItemFont(self, TreeItemId item) -> Font + + + + + + IsVisible(self, TreeItemId item) -> bool + + + + + + ItemHasChildren(self, TreeItemId item) -> bool + + + + + + IsExpanded(self, TreeItemId item) -> bool + + + + + + IsSelected(self, TreeItemId item) -> bool + + + + + + IsBold(self, TreeItemId item) -> bool + + + + + + GetChildrenCount(self, TreeItemId item, bool recursively=True) -> size_t + + + + + + + GetRootItem(self) -> TreeItemId + + + GetSelection(self) -> TreeItemId + + + GetSelections(self) -> PyObject + + + GetItemParent(self, TreeItemId item) -> TreeItemId + + + + + + GetFirstChild(self, TreeItemId item) -> PyObject + + + + + + GetNextChild(self, TreeItemId item, void cookie) -> PyObject + + + + + + + GetLastChild(self, TreeItemId item) -> TreeItemId + + + + + + GetNextSibling(self, TreeItemId item) -> TreeItemId + + + + + + GetPrevSibling(self, TreeItemId item) -> TreeItemId + + + + + + GetFirstVisibleItem(self) -> TreeItemId + + + GetNextVisible(self, TreeItemId item) -> TreeItemId + + + + + + GetPrevVisible(self, TreeItemId item) -> TreeItemId + + + + + + GetNext(self, TreeItemId item) -> TreeItemId + + + + + + AddRoot(self, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId + + + + + + + + + PrependItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId - - - - - - - - - - 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 - - - - - - - - - - - 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 - - - - - - - - - - - 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 - - - - - - - - - - Delete(TreeItemId item) - - - - - - DeleteChildren(TreeItemId item) - - - - - - DeleteAllItems() - - - Expand(TreeItemId item) - - - - - - ExpandAll(TreeItemId item) - - - - - - Collapse(TreeItemId item) - - - - - - CollapseAndReset(TreeItemId item) - - - - - - Toggle(TreeItemId item) - - - - - - Unselect() - - - UnselectAll() - - - SelectItem(TreeItemId item, bool unselect_others=True, bool extended_select=False) - - - - - - - - EnsureVisible(TreeItemId item) - - - - - - ScrollTo(TreeItemId item) - - - - - - HitTest(Point point, int OUTPUT, int OUTPUT) -> TreeItemId - - - - - - - - GetBoundingRect(TreeItemId item, bool textOnly=False) -> PyObject - - - - - - - EditLabel(TreeItemId item) - - - - - - Edit(TreeItemId item) - - - - - - SortChildren(TreeItemId item) - - - - - - GetItemSelectedImage(TreeItemId item) -> int - - - - - - SetItemSelectedImage(TreeItemId item, int image) - - - - - - - GetHeaderWindow() -> Window - - - GetMainWindow() -> Window - - - + + + + + + + + + + Delete(self, TreeItemId item) + + + + + + DeleteChildren(self, TreeItemId item) + + + + + + DeleteAllItems(self) + + + Expand(self, TreeItemId item) + + + + + + ExpandAll(self, TreeItemId item) + + + + + + Collapse(self, TreeItemId item) + + + + + + CollapseAndReset(self, TreeItemId item) + + + + + + Toggle(self, TreeItemId item) + + + + + + Unselect(self) + + + UnselectAll(self) + + + SelectItem(self, TreeItemId item, bool unselect_others=True, bool extended_select=False) + + + + + + + + SelectAll(self, bool extended_select=False) + + + + + + EnsureVisible(self, TreeItemId item) + + + + + + ScrollTo(self, TreeItemId item) + + + + + + HitTest(self, Point point, int OUTPUT, int OUTPUT) -> TreeItemId + + + + + + + + GetBoundingRect(self, TreeItemId item, bool textOnly=False) -> PyObject + + + + + + + EditLabel(self, TreeItemId item) + + + + + + Edit(self, TreeItemId item) + + + + + + SortChildren(self, TreeItemId item) + + + + + + FindItem(self, TreeItemId item, String str, int flags=0) -> TreeItemId + + + + + + + + GetHeaderWindow(self) -> Window + + + GetMainWindow(self) -> ScrolledWindow + + + +