X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c2dda882546d1149fef8a7e907718ded5a38f014..1128a89b82a3055e7d609f8f3a1e4bc9d2beea30:/wxPython/docs/xml/wxPython-metadata.xml
diff --git a/wxPython/docs/xml/wxPython-metadata.xml b/wxPython/docs/xml/wxPython-metadata.xml
index 8c0171e6e4..1beefedbd3 100644
--- a/wxPython/docs/xml/wxPython-metadata.xml
+++ b/wxPython/docs/xml/wxPython-metadata.xml
@@ -3361,6 +3361,13 @@ class PyOnDemandOutputWindow:
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):
"""
@@ -3385,11 +3392,6 @@ 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
#----------------------------------------------------------------------
@@ -3463,7 +3465,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')
@@ -4070,26 +4072,38 @@ has been added to the list of windows pending real deletion.
GetLabel() -> String
- Generic way of getting a label from any window, for identification
-purposes. The interpretation of this function differs from class to
-class. For frames and dialogs, the value returned is the title. For
-buttons or static text controls, it is the button text. This function
-can be useful for meta-programs (such as testing tools or
-special-needs access programs) which need to identify windows by name.
+ Generic way of getting a label from any window, for
+identification purposes. The interpretation of this function
+differs from class to class. For frames and dialogs, the value
+returned is the title. For buttons or static text controls, it is
+the button text. This function can be useful for meta-programs
+(such as testing tools or special-needs access programs) which
+need to identify windows by name.
SetName(String name)
- Sets the window's name. The window name is used for ressource setting
-in X, it is not the same as the window title/label
+ Sets the window's name. The window name is used for ressource
+setting in X, it is not the same as the window title/label
GetName() -> String
- Returns the window's name. This name is not guaranteed to be unique;
-it is up to the programmer to supply an appropriate name in the window
-constructor or via wx.Window.SetName.
+ Returns the window's name. This name is not guaranteed to be
+unique; it is up to the programmer to supply an appropriate name
+in the window constructor or via wx.Window.SetName.
+
+
+ SetWindowVariant(int variant)
+ Sets the variant of the window/font size to use for this window,
+if the platform supports variants, (for example, wxMac.)
+
+
+
+
+
+ GetWindowVariant() -> int
SetId(int winid)
@@ -4887,9 +4901,10 @@ colour. Does not cause an erase background event to be generated.
Freeze()
- Freezes the window or, in other words, prevents any updates from
-taking place on screen, the window is not redrawn at all. Thaw must be
-called to reenable window redrawing.
+ 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
@@ -4899,7 +4914,9 @@ mandatory directive.
Thaw()
- Reenables window updating after a previous call to Freeze.
+ 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(DC dc)
@@ -4942,8 +4959,8 @@ exposed.
-
- isExposedRect(Rect rect) -> bool
+
+ IsExposedRect(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
@@ -5015,7 +5032,7 @@ be reset back to default.
GetFont() -> Font
- Returns a reference to the font for this window.
+ Returns the default font used for this window.
SetCaret(Caret caret)
@@ -5496,9 +5513,10 @@ hierarchy. The search is recursive in both cases.
- Window_FromHWND(unsigned long hWnd) -> Window
+ Window_FromHWND(Window parent, unsigned long _hWnd) -> Window
-
+
+
@@ -7644,7 +7662,7 @@ def CallAfter(callable, *args, **kw):
class FutureCall:
"""
- A convenience class for wxTimer, that calls the given callable
+ A convenience class for wx.Timer, that calls the given callable
object once after the given amount of milliseconds, passing any
positional or keyword args. The return value of the callable is
availbale after it has been run with the GetResult method.
@@ -7661,6 +7679,7 @@ class FutureCall:
self.callable = callable
self.SetArgs(*args, **kwargs)
self.runCount = 0
+ self.running = False
self.hasRun = False
self.result = None
self.timer = None
@@ -7682,6 +7701,7 @@ class FutureCall:
self.Stop()
self.timer = wx.PyTimer(self.Notify)
self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
+ self.running = True
Restart = Start
@@ -7728,9 +7748,12 @@ class FutureCall:
"""
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
- wx.CallAfter(self.Stop)
+ if not self.running:
+ # if it wasn't restarted, then cleanup
+ wx.CallAfter(self.Stop)
#----------------------------------------------------------------------------
@@ -8250,6 +8273,18 @@ to the bitmap. This function preserves bit depth and mask information.
+
+ __eq__(Bitmap other) -> bool
+
+
+
+
+
+ __ne__(Bitmap other) -> bool
+
+
+
+
This class encapsulates a monochrome mask bitmap, where the masked area is
@@ -11259,11 +11294,11 @@ the borders, scrollbars, other decorations...)
- CreateStatusBar(int number=1, long style=ST_SIZEGRIP, int winid=0,
- String name=StatusLineNameStr) -> StatusBar
+ CreateStatusBar(int number=1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
+ int winid=0, String name=StatusLineNameStr) -> StatusBar
-
+
@@ -11514,11 +11549,12 @@ the borders, scrollbars, other decorations...)
- __init__(Window parent, int id=-1, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> StatusBar
+ __init__(Window parent, int id=-1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
+ String name=StatusLineNameStr) -> StatusBar
-
+
@@ -14161,8 +14197,13 @@ non-None. Use Show to display the dialog.
-
- __init__() -> PrintDialogData
+
+
+ __init__() -> PrintDialogData
+__init__(PrintData printData) -> PrintDialogData
+
+
+
__del__()
@@ -14599,12 +14640,20 @@ non-None. Use Show to display the dialog.
-
- __init__(Printout printout, Printout printoutForPrinting, PrintData data=None) -> PrintPreview
+
-
+
+
+
+
+ __init__(Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PrintPreview
+__init__(Printout printout, Printout printoutForPrinting, PrintData data) -> PrintPreview
+
+
+
+
@@ -14711,12 +14760,20 @@ non-None. Use Show to display the dialog.
-
- __init__(Printout printout, Printout printoutForPrinting, PrintData data=None) -> PyPrintPreview
+
-
+
+
+
+
+ __init__(Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PyPrintPreview
+__init__(Printout printout, Printout printoutForPrinting, PrintData data) -> PyPrintPreview
+
+
+
+
@@ -18291,6 +18348,9 @@ after changing the others for the change to take place immediately.
+
+ InReportView() -> bool
+
IsVirtual() -> bool
@@ -20602,10 +20662,11 @@ associated with the control (if any) in a tooltip.
__del__()
- _setCallbackInfo(PyObject self, PyObject _class)
+ _setCallbackInfo(PyObject self, PyObject _class, int incref=1)
+
@@ -20638,7 +20699,7 @@ associated with the control (if any) in a tooltip.
GetId() -> int
-
+
# For backwards compatibility with 2.4
class PyTimer(Timer):
def __init__(self, notify):
@@ -20651,7 +20712,7 @@ class PyTimer(Timer):
EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 )
-
+
@@ -21700,18 +21761,19 @@ 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
-(directories) and keys (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.
+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__()
@@ -22026,13 +22088,13 @@ and will be a wx.FileConfig on other platforms.
__init__(String appName=EmptyString, String vendorName=EmptyString,
String localFilename=EmptyString, String globalFilename=EmptyString,
- long style=0) -> FileConfig
+ long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -> FileConfig
-
+
@@ -23791,6 +23853,151 @@ the locker is destroyed.
successfully opened.
+
+#---------------------------------------------------------------------------
+
+
+ A simple struct containing video mode parameters for a display
+
+ __init__(int width=0, int height=0, int depth=0, int freq=0) -> VideoMode
+ A simple struct containing video mode parameters for a display
+
+
+
+
+
+
+
+
+ __del__()
+
+
+ Matches(VideoMode other) -> bool
+ Returns true if this mode matches the other one in the sense that
+all non zero fields of the other mode have the same value in this
+one (except for refresh which is allowed to have a greater value)
+
+
+
+
+
+ GetWidth() -> int
+ Returns the screen width in pixels (e.g. 640*480), 0 means
+unspecified
+
+
+ GetHeight() -> int
+ Returns the screen width in pixels (e.g. 640*480), 0 means
+unspecified
+
+
+ GetDepth() -> int
+ Returns the screen's bits per pixel (e.g. 32), 1 is monochrome
+and 0 means unspecified/known
+
+
+ IsOk() -> bool
+ returns true if the object has been initialized
+
+
+ __eq__(VideoMode other) -> bool
+
+
+
+
+
+ __ne__(VideoMode other) -> bool
+
+
+
+
+
+
+
+
+
+
+ Represents a display/monitor attached to the system
+
+ __init__(size_t index=0) -> Display
+ Set up a Display instance with the specified display. The
+displays are numbered from 0 to GetCount() - 1, 0 is always the
+primary display and the only one which is always supported
+
+
+
+
+
+ __del__()
+
+
+ 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() -> bool
+ Return true if the object was initialized successfully
+
+
+ GetGeometry() -> Rect
+ Returns the bounding rectangle of the display whose index was
+passed to the constructor.
+
+
+ GetName() -> String
+ Returns the display's name. A name is not available on all platforms.
+
+
+ IsPrimary() -> 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() -> VideoMode
+ Get the current video mode.
+
+
+ ChangeMode(VideoMode mode=DefaultVideoMode) -> bool
+ Change current mode, return true if succeeded, false otherwise
+
+
+
+
+
+ ResetMode()
+ Restore the default video mode (just a more readable synonym)
+
+
@@ -25543,16 +25750,6 @@ validity of the remaining two values. The result codes are:
ForceRefresh()
-
- Refresh(bool eraseb=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.
-
-
-
-
-
IsEditable() -> bool
@@ -27551,7 +27748,6 @@ EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED )
SetTitle(String title)
- Sets the window's title. Applicable only to frames and dialogs.
@@ -35738,9 +35934,148 @@ ControlPoint = PyControlPoint
+
+ LineDown()
+ This is just a wrapper for ScrollLines(1).
+
+
+ LineDownExtend()
+
+
+ LineUp()
+ This is just a wrapper for ScrollLines(-1).
+
+
+ LineUpExtend()
+
+
+ CharLeft()
+
+
+ CharLeftExtend()
+
+
+ CharRight()
+
+
+ CharRightExtend()
+
+
+ WordLeft()
+
+
+ WordLeftExtend()
+
+
+ WordRight()
+
+
+ WordRightExtend()
+
+
+ Home()
+
+
+ HomeExtend()
+
+
+ LineEnd()
+
+
+ LineEndExtend()
+
+
+ DocumentStart()
+
+
+ DocumentStartExtend()
+
+
+ DocumentEnd()
+
+
+ DocumentEndExtend()
+
+
+ PageUp()
+ This is just a wrapper for ScrollPages(-1).
+
+
+ PageUpExtend()
+
+
+ PageDown()
+ This is just a wrapper for ScrollPages(1).
+
+
+ PageDownExtend()
+
+
+ EditToggleOvertype()
+
+
+ Cancel()
+
+
+ DeleteBack()
+
+
+ Tab()
+
+
+ BackTab()
+
+
+ NewLine()
+
+
+ FormFeed()
+
+
+ VCHome()
+
+
+ VCHomeExtend()
+
+
+ ZoomIn()
+
+
+ ZoomOut()
+
+
+ DelWordLeft()
+
+
+ DelWordRight()
+
+
+ LineCut()
+
+
+ LineDelete()
+
+
+ LineTranspose()
+
LineDuplicate()
+
+ LowerCase()
+
+
+ UpperCase()
+
+
+ LineScrollDown()
+
+
+ LineScrollUp()
+
+
+ DeleteBackNotLine()
+
HomeDisplay()
@@ -35753,6 +36088,24 @@ ControlPoint = PyControlPoint
LineEndDisplayExtend()
+
+ HomeWrap()
+
+
+ HomeWrapExtend()
+
+
+ LineEndWrap()
+
+
+ LineEndWrapExtend()
+
+
+ VCHomeWrap()
+
+
+ VCHomeWrapExtend()
+
LineCopy()
@@ -36022,6 +36375,18 @@ ControlPoint = PyControlPoint
+
+ ParaDown()
+
+
+ ParaDownExtend()
+
+
+ ParaUp()
+
+
+ ParaUpExtend()
+
PositionBefore(int pos) -> int
@@ -36069,6 +36434,57 @@ ControlPoint = PyControlPoint
+
+ LineDownRectExtend()
+
+
+ LineUpRectExtend()
+
+
+ CharLeftRectExtend()
+
+
+ CharRightRectExtend()
+
+
+ HomeRectExtend()
+
+
+ VCHomeRectExtend()
+
+
+ LineEndRectExtend()
+
+
+ PageUpRectExtend()
+
+
+ PageDownRectExtend()
+
+
+ StutteredPageUp()
+
+
+ StutteredPageUpExtend()
+
+
+ StutteredPageDown()
+
+
+ StutteredPageDownExtend()
+
+
+ WordLeftEnd()
+
+
+ WordLeftEndExtend()
+
+
+ WordRightEnd()
+
+
+ WordRightEndExtend()
+
SetWhitespaceChars(String characters)