1797 lines
144 KiB
HTML
1797 lines
144 KiB
HTML
|
|
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><title>Python: module reprap.wxpygame</title>
|
|
</head><body bgcolor="#f0f0f8">
|
|
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
|
<tr bgcolor="#7799ee">
|
|
<td valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="reprap.html"><font color="#ffffff">reprap</font></a>.wxpygame</strong></big></big></font></td
|
|
><td align=right valign=bottom
|
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python2.5/site-packages/reprap/wxpygame.py">/usr/lib/python2.5/site-packages/reprap/wxpygame.py</a></font></td></tr></table>
|
|
<p><tt>This module provides a pyGame surface as a wxPython object.<br>
|
|
I.e. it lets you use pyGame within a wx frame.<br>
|
|
<br>
|
|
Code derived / inspired from a vague combination of :<br>
|
|
<br>
|
|
BufferedCanvas -- Double-buffered, flicker-free canvas widget<br>
|
|
Copyright (C) 2005, 2006 Daniel Keep<br>
|
|
(GNU Lesser General Public License)<br>
|
|
<br>
|
|
and<br>
|
|
<br>
|
|
wxPython wiki : <a href="http://wiki.wxpython.org/IntegratingPyGame">http://wiki.wxpython.org/IntegratingPyGame</a> (Assumed GNU compatible)<br>
|
|
<br>
|
|
and some work of my own.<br>
|
|
<br>
|
|
<br>
|
|
Example :<br>
|
|
<br>
|
|
import wxpygame<br>
|
|
class DrawCanvas(wxpygame.<a href="#wxSDLPanel">wxSDLPanel</a>):<br>
|
|
def __init__( self, parent, ID=-1 ):<br>
|
|
wxpygame.<a href="#wxSDLPanel">wxSDLPanel</a>.__init__( self, parent,ID )<br>
|
|
<br>
|
|
def draw(self):<br>
|
|
surface = getSurface()<br>
|
|
if not surface is None:<br>
|
|
pygame.draw.circle( surface, (250, 0, 0), (100, 100), 50 )<br>
|
|
pygame.display.flip()</tt></p>
|
|
<p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#aa55cc">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a><br>
|
|
</td><td width="25%" valign=top><a href="pygame.html">pygame</a><br>
|
|
</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
|
|
</td><td width="25%" valign=top><a href="wx.html">wx</a><br>
|
|
</td></tr></table></td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ee77aa">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
|
<td width="100%"><dl>
|
|
<dt><font face="helvetica, arial"><a href="wx._windows.html#Panel">wx._windows.Panel</a>(<a href="wx._core.html#Window">wx._core.Window</a>)
|
|
</font></dt><dd>
|
|
<dl>
|
|
<dt><font face="helvetica, arial"><a href="reprap.wxpygame.html#wxSDLPanel">wxSDLPanel</a>
|
|
</font></dt></dl>
|
|
</dd>
|
|
</dl>
|
|
<p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="wxSDLPanel">class <strong>wxSDLPanel</strong></a>(<a href="wx._windows.html#Panel">wx._windows.Panel</a>)</font></td></tr>
|
|
|
|
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="reprap.wxpygame.html#wxSDLPanel">wxSDLPanel</a></dd>
|
|
<dd><a href="wx._windows.html#Panel">wx._windows.Panel</a></dd>
|
|
<dd><a href="wx._core.html#Window">wx._core.Window</a></dd>
|
|
<dd><a href="wx._core.html#EvtHandler">wx._core.EvtHandler</a></dd>
|
|
<dd><a href="wx._core.html#Object">wx._core.Object</a></dd>
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="wxSDLPanel-MouseMove"><strong>MouseMove</strong></a>(self, event)</dt></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-OnIdle"><strong>OnIdle</strong></a>(self, ev)</dt></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-OnMouseDown"><strong>OnMouseDown</strong></a>(self, event)</dt></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-OnMouseUp"><strong>OnMouseUp</strong></a>(self, event)</dt></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-OnMouseWheel"><strong>OnMouseWheel</strong></a>(self, event)</dt></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-OnPaint"><strong>OnPaint</strong></a>(self, ev)</dt></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-OnSize"><strong>OnSize</strong></a>(self, ev)</dt></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-__init__"><strong>__init__</strong></a>(self, parent, ID<font color="#909090">=-1</font>, pos<font color="#909090">=wx.Point(-1, -1)</font>, size<font color="#909090">=wx.Size(-1, -1)</font>, style<font color="#909090">=0</font>)</dt></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-draw"><strong>draw</strong></a>(self)</dt></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-getSurface"><strong>getSurface</strong></a>(self)</dt></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-update"><strong>update</strong></a>(self)</dt></dl>
|
|
|
|
<hr>
|
|
Data and other attributes defined here:<br>
|
|
<dl><dt><strong>backbuffer</strong> = None</dl>
|
|
|
|
<dl><dt><strong>buffer</strong> = None</dl>
|
|
|
|
<hr>
|
|
Methods inherited from <a href="wx._windows.html#Panel">wx._windows.Panel</a>:<br>
|
|
<dl><dt><a name="wxSDLPanel-Create"><strong>Create</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Create">Create</a>(self, Window parent, int id=-1, Point pos=DefaultPosition, <br>
|
|
Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, <br>
|
|
String name=PanelNameStr) -> bool<br>
|
|
<br>
|
|
Create the GUI part of the Window for 2-phase creation mode.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetFocusIgnoringChildren"><strong>SetFocusIgnoringChildren</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetFocusIgnoringChildren">SetFocusIgnoringChildren</a>(self)<br>
|
|
<br>
|
|
In contrast to `SetFocus` (see above) this will set the focus to the<br>
|
|
panel even of there are child windows in the panel. This is only<br>
|
|
rarely needed.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-__repr__"><strong>__repr__</strong></a> = _swig_repr(self)</dt></dl>
|
|
|
|
<hr>
|
|
Static methods inherited from <a href="wx._windows.html#Panel">wx._windows.Panel</a>:<br>
|
|
<dl><dt><a name="wxSDLPanel-GetClassDefaultAttributes"><strong>GetClassDefaultAttributes</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetClassDefaultAttributes">GetClassDefaultAttributes</a>(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes<br>
|
|
<br>
|
|
Get the default attributes for this class. This is useful if you want<br>
|
|
to use the same font or colour in your own control as in a standard<br>
|
|
control -- which is a much better idea than hard coding specific<br>
|
|
colours or fonts which might look completely out of place on the<br>
|
|
user's system, especially if it uses themes.<br>
|
|
<br>
|
|
The variant parameter is only relevant under Mac currently and is<br>
|
|
ignore under other platforms. Under Mac, it will change the size of<br>
|
|
the returned font. See `wx.Window.SetWindowVariant` for more about<br>
|
|
this.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="wx._windows.html#Panel">wx._windows.Panel</a>:<br>
|
|
<dl><dt><strong>thisown</strong></dt>
|
|
<dd><tt>The membership flag</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods inherited from <a href="wx._core.html#Window">wx._core.Window</a>:<br>
|
|
<dl><dt><a name="wxSDLPanel-AcceptsFocus"><strong>AcceptsFocus</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-AcceptsFocus">AcceptsFocus</a>(self) -> bool<br>
|
|
<br>
|
|
Can this window have focus?</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-AcceptsFocusFromKeyboard"><strong>AcceptsFocusFromKeyboard</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-AcceptsFocusFromKeyboard">AcceptsFocusFromKeyboard</a>(self) -> bool<br>
|
|
<br>
|
|
Can this window be given focus by keyboard navigation? if not, the<br>
|
|
only way to give it focus (provided it accepts it at all) is to click<br>
|
|
it.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-AddChild"><strong>AddChild</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-AddChild">AddChild</a>(self, Window child)<br>
|
|
<br>
|
|
Adds a child window. This is called automatically by window creation<br>
|
|
functions so should not be required by the application programmer.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-AdjustForLayoutDirection"><strong>AdjustForLayoutDirection</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-AdjustForLayoutDirection">AdjustForLayoutDirection</a>(self, int x, int width, int widthTotal) -> int<br>
|
|
<br>
|
|
Mirror coordinates for RTL layout if this window uses it and if the<br>
|
|
mirroring is not done automatically like Win32.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-AssociateHandle"><strong>AssociateHandle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-AssociateHandle">AssociateHandle</a>(self, long handle)<br>
|
|
<br>
|
|
Associate the window with a new native handle</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-CacheBestSize"><strong>CacheBestSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-CacheBestSize">CacheBestSize</a>(self, Size size)<br>
|
|
<br>
|
|
Cache the best size so it doesn't need to be calculated again, (at least until<br>
|
|
some properties of the window change.)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-CanSetTransparent"><strong>CanSetTransparent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-CanSetTransparent">CanSetTransparent</a>(self) -> bool<br>
|
|
<br>
|
|
Returns ``True`` if the platform supports setting the transparency for<br>
|
|
this window. Note that this method will err on the side of caution,<br>
|
|
so it is possible that this will return ``False`` when it is in fact<br>
|
|
possible to set the transparency.<br>
|
|
<br>
|
|
NOTE: On X-windows systems the X server must have the composite<br>
|
|
extension loaded, and there must be a composite manager program (such<br>
|
|
as xcompmgr) running.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-CaptureMouse"><strong>CaptureMouse</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-CaptureMouse">CaptureMouse</a>(self)<br>
|
|
<br>
|
|
Directs all mouse input to this window. Call wx.Window.ReleaseMouse to<br>
|
|
release the capture.<br>
|
|
<br>
|
|
Note that wxWindows maintains the stack of windows having captured the<br>
|
|
mouse and when the mouse is released the capture returns to the window<br>
|
|
which had had captured it previously and it is only really released if<br>
|
|
there were no previous window. In particular, this means that you must<br>
|
|
release the mouse as many times as you capture it, unless the window<br>
|
|
receives the `wx.MouseCaptureLostEvent` event.<br>
|
|
<br>
|
|
Any application which captures the mouse in the beginning of some<br>
|
|
operation *must* handle `wx.MouseCaptureLostEvent` and cancel this<br>
|
|
operation when it receives the event. The event handler must not<br>
|
|
recapture mouse.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Center"><strong>Center</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Center">Center</a>(self, int direction=BOTH)<br>
|
|
<br>
|
|
Centers the window. The parameter specifies the direction for<br>
|
|
cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may<br>
|
|
also include wx.CENTER_ON_SCREEN flag if you want to center the window<br>
|
|
on the entire screen and not on its parent window. If it is a<br>
|
|
top-level window and has no parent then it will always be centered<br>
|
|
relative to the screen.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-CenterOnParent"><strong>CenterOnParent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-CenterOnParent">CenterOnParent</a>(self, int dir=BOTH)<br>
|
|
<br>
|
|
Center with respect to the the parent window</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Centre"><strong>Centre</strong></a> = Center(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Center">Center</a>(self, int direction=BOTH)<br>
|
|
<br>
|
|
Centers the window. The parameter specifies the direction for<br>
|
|
cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may<br>
|
|
also include wx.CENTER_ON_SCREEN flag if you want to center the window<br>
|
|
on the entire screen and not on its parent window. If it is a<br>
|
|
top-level window and has no parent then it will always be centered<br>
|
|
relative to the screen.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-CentreOnParent"><strong>CentreOnParent</strong></a> = CenterOnParent(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-CenterOnParent">CenterOnParent</a>(self, int dir=BOTH)<br>
|
|
<br>
|
|
Center with respect to the the parent window</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ClearBackground"><strong>ClearBackground</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ClearBackground">ClearBackground</a>(self)<br>
|
|
<br>
|
|
Clears the window by filling it with the current background<br>
|
|
colour. Does not cause an erase background event to be generated.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ClientToScreen"><strong>ClientToScreen</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ClientToScreen">ClientToScreen</a>(self, Point pt) -> Point<br>
|
|
<br>
|
|
Converts to screen coordinates from coordinates relative to this window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ClientToScreenXY"><strong>ClientToScreenXY</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ClientToScreenXY">ClientToScreenXY</a>(int x, int y) -> (x,y)<br>
|
|
<br>
|
|
Converts to screen coordinates from coordinates relative to this window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Close"><strong>Close</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Close">Close</a>(self, bool force=False) -> bool<br>
|
|
<br>
|
|
This function simply generates a EVT_CLOSE event whose handler usually<br>
|
|
tries to close the window. It doesn't close the window itself,<br>
|
|
however. If force is False (the default) then the window's close<br>
|
|
handler will be allowed to veto the destruction of the window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ConvertDialogPointToPixels"><strong>ConvertDialogPointToPixels</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ConvertDialogPointToPixels">ConvertDialogPointToPixels</a>(self, Point pt) -> Point<br>
|
|
<br>
|
|
Converts a point or size from dialog units to pixels. Dialog units<br>
|
|
are used for maintaining a dialog's proportions even if the font<br>
|
|
changes. For the x dimension, the dialog units are multiplied by the<br>
|
|
average character width and then divided by 4. For the y dimension,<br>
|
|
the dialog units are multiplied by the average character height and<br>
|
|
then divided by 8.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ConvertDialogSizeToPixels"><strong>ConvertDialogSizeToPixels</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ConvertDialogSizeToPixels">ConvertDialogSizeToPixels</a>(self, Size sz) -> Size<br>
|
|
<br>
|
|
Converts a point or size from dialog units to pixels. Dialog units<br>
|
|
are used for maintaining a dialog's proportions even if the font<br>
|
|
changes. For the x dimension, the dialog units are multiplied by the<br>
|
|
average character width and then divided by 4. For the y dimension,<br>
|
|
the dialog units are multiplied by the average character height and<br>
|
|
then divided by 8.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ConvertPixelPointToDialog"><strong>ConvertPixelPointToDialog</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ConvertPixelPointToDialog">ConvertPixelPointToDialog</a>(self, Point pt) -> Point</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ConvertPixelSizeToDialog"><strong>ConvertPixelSizeToDialog</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ConvertPixelSizeToDialog">ConvertPixelSizeToDialog</a>(self, Size sz) -> Size</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-DLG_PNT"><strong>DLG_PNT</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-DLG_PNT">DLG_PNT</a>(self, Point pt) -> Point<br>
|
|
<br>
|
|
Converts a point or size from dialog units to pixels. Dialog units<br>
|
|
are used for maintaining a dialog's proportions even if the font<br>
|
|
changes. For the x dimension, the dialog units are multiplied by the<br>
|
|
average character width and then divided by 4. For the y dimension,<br>
|
|
the dialog units are multiplied by the average character height and<br>
|
|
then divided by 8.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-DLG_SZE"><strong>DLG_SZE</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-DLG_SZE">DLG_SZE</a>(self, Size sz) -> Size<br>
|
|
<br>
|
|
Converts a point or size from dialog units to pixels. Dialog units<br>
|
|
are used for maintaining a dialog's proportions even if the font<br>
|
|
changes. For the x dimension, the dialog units are multiplied by the<br>
|
|
average character width and then divided by 4. For the y dimension,<br>
|
|
the dialog units are multiplied by the average character height and<br>
|
|
then divided by 8.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Destroy"><strong>Destroy</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Destroy">Destroy</a>(self) -> bool<br>
|
|
<br>
|
|
Destroys the window safely. Frames and dialogs are not destroyed<br>
|
|
immediately when this function is called -- they are added to a list<br>
|
|
of windows to be deleted on idle time, when all the window's events<br>
|
|
have been processed. This prevents problems with events being sent to<br>
|
|
non-existent windows.<br>
|
|
<br>
|
|
Returns True if the window has either been successfully deleted, or it<br>
|
|
has been added to the list of windows pending real deletion.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-DestroyChildren"><strong>DestroyChildren</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-DestroyChildren">DestroyChildren</a>(self) -> bool<br>
|
|
<br>
|
|
Destroys all children of a window. Called automatically by the<br>
|
|
destructor.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Disable"><strong>Disable</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Disable">Disable</a>(self) -> bool<br>
|
|
<br>
|
|
Disables the window, same as <a href="#wxSDLPanel-Enable">Enable</a>(false).</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-DissociateHandle"><strong>DissociateHandle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-DissociateHandle">DissociateHandle</a>(self)<br>
|
|
<br>
|
|
Dissociate the current native handle from the window</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-DragAcceptFiles"><strong>DragAcceptFiles</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-DragAcceptFiles">DragAcceptFiles</a>(self, bool accept)<br>
|
|
<br>
|
|
Enables or disables eligibility for drop file events, EVT_DROP_FILES.<br>
|
|
Only functional on Windows.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Enable"><strong>Enable</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Enable">Enable</a>(self, bool enable=True) -> bool<br>
|
|
<br>
|
|
Enable or disable the window for user input. Note that when a parent<br>
|
|
window is disabled, all of its children are disabled as well and they<br>
|
|
are reenabled again when the parent is. Returns true if the window<br>
|
|
has been enabled or disabled, false if nothing was done, i.e. if the<br>
|
|
window had already been in the specified state.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-FindWindowById"><strong>FindWindowById</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-FindWindowById">FindWindowById</a>(self, long winid) -> Window<br>
|
|
<br>
|
|
Find a child of this window by window ID</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-FindWindowByName"><strong>FindWindowByName</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-FindWindowByName">FindWindowByName</a>(self, String name) -> Window<br>
|
|
<br>
|
|
Find a child of this window by name</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Fit"><strong>Fit</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Fit">Fit</a>(self)<br>
|
|
<br>
|
|
Sizes the window so that it fits around its subwindows. This function<br>
|
|
won't do anything if there are no subwindows and will only really work<br>
|
|
correctly if sizers are used for the subwindows layout. Also, if the<br>
|
|
window has exactly one subwindow it is better (faster and the result<br>
|
|
is more precise as Fit adds some margin to account for fuzziness of<br>
|
|
its calculations) to call window.<a href="#wxSDLPanel-SetClientSize">SetClientSize</a>(child.<a href="#wxSDLPanel-GetSize">GetSize</a>())<br>
|
|
instead of calling Fit.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-FitInside"><strong>FitInside</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-FitInside">FitInside</a>(self)<br>
|
|
<br>
|
|
Similar to Fit, but sizes the interior (virtual) size of a<br>
|
|
window. Mainly useful with scrolled windows to reset scrollbars after<br>
|
|
sizing changes that do not trigger a size event, and/or scrolled<br>
|
|
windows without an interior sizer. This function similarly won't do<br>
|
|
anything if there are no subwindows.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Freeze"><strong>Freeze</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Freeze">Freeze</a>(self)<br>
|
|
<br>
|
|
Freezes the window or, in other words, prevents any updates from<br>
|
|
taking place on screen, the window is not redrawn at all. Thaw must be<br>
|
|
called to reenable window redrawing. Calls to Freeze/Thaw may be<br>
|
|
nested, with the actual Thaw being delayed until all the nesting has<br>
|
|
been undone.<br>
|
|
<br>
|
|
This method is useful for visual appearance optimization (for example,<br>
|
|
it is a good idea to use it before inserting large amount of text into<br>
|
|
a wxTextCtrl under wxGTK) but is not implemented on all platforms nor<br>
|
|
for all controls so it is mostly just a hint to wxWindows and not a<br>
|
|
mandatory directive.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetAcceleratorTable"><strong>GetAcceleratorTable</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetAcceleratorTable">GetAcceleratorTable</a>(self) -> AcceleratorTable<br>
|
|
<br>
|
|
Gets the accelerator table for this window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetAdjustedBestSize"><strong>GetAdjustedBestSize</strong></a> = deprecatedWrapper(*args, **kwargs)</dt><dd><tt>Use `GetEffectiveMinSize` instead.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetAutoLayout"><strong>GetAutoLayout</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetAutoLayout">GetAutoLayout</a>(self) -> bool<br>
|
|
<br>
|
|
Returns the current autoLayout setting</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetBackgroundColour"><strong>GetBackgroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetBackgroundColour">GetBackgroundColour</a>(self) -> Colour<br>
|
|
<br>
|
|
Returns the background colour of the window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetBackgroundStyle"><strong>GetBackgroundStyle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetBackgroundStyle">GetBackgroundStyle</a>(self) -> int<br>
|
|
<br>
|
|
Returns the background style of the window.<br>
|
|
<br>
|
|
:see: `SetBackgroundStyle`</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetBestFittingSize"><strong>GetBestFittingSize</strong></a> = deprecatedWrapper(*args, **kwargs)</dt><dd><tt>Use `GetEffectiveMinSize` instead.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetBestSize"><strong>GetBestSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetBestSize">GetBestSize</a>(self) -> Size<br>
|
|
<br>
|
|
This function returns the best acceptable minimal size for the<br>
|
|
window, if applicable. For example, for a static text control, it will<br>
|
|
be the minimal size such that the control label is not truncated. For<br>
|
|
windows containing subwindows (suzh aswx.<a href="wx._windows.html#Panel">Panel</a>), the size returned by<br>
|
|
this function will be the same as the size the window would have had<br>
|
|
after calling Fit.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetBestSizeTuple"><strong>GetBestSizeTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetBestSizeTuple">GetBestSizeTuple</a>() -> (width, height)<br>
|
|
<br>
|
|
This function returns the best acceptable minimal size for the<br>
|
|
window, if applicable. For example, for a static text control, it will<br>
|
|
be the minimal size such that the control label is not truncated. For<br>
|
|
windows containing subwindows (suzh aswx.<a href="wx._windows.html#Panel">Panel</a>), the size returned by<br>
|
|
this function will be the same as the size the window would have had<br>
|
|
after calling Fit.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetBestVirtualSize"><strong>GetBestVirtualSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetBestVirtualSize">GetBestVirtualSize</a>(self) -> Size<br>
|
|
<br>
|
|
Return the largest of ClientSize and BestSize (as determined by a<br>
|
|
sizer, interior children, or other means)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetBorder"><strong>GetBorder</strong></a>(*args)</dt><dd><tt><a href="#wxSDLPanel-GetBorder">GetBorder</a>(self, long flags) -> int<br>
|
|
<a href="#wxSDLPanel-GetBorder">GetBorder</a>(self) -> int<br>
|
|
<br>
|
|
Get border for the flags of this window</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetCaret"><strong>GetCaret</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetCaret">GetCaret</a>(self) -> Caret<br>
|
|
<br>
|
|
Returns the caret associated with the window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetCharHeight"><strong>GetCharHeight</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetCharHeight">GetCharHeight</a>(self) -> int<br>
|
|
<br>
|
|
Get the (average) character size for the current font.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetCharWidth"><strong>GetCharWidth</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetCharWidth">GetCharWidth</a>(self) -> int<br>
|
|
<br>
|
|
Get the (average) character size for the current font.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetChildren"><strong>GetChildren</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetChildren">GetChildren</a>(self) -> WindowList<br>
|
|
<br>
|
|
Returns an object containing a list of the window's children. The<br>
|
|
object provides a Python sequence-like interface over the internal<br>
|
|
list maintained by the window..</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetClientAreaOrigin"><strong>GetClientAreaOrigin</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetClientAreaOrigin">GetClientAreaOrigin</a>(self) -> Point<br>
|
|
<br>
|
|
Get the origin of the client area of the window relative to the<br>
|
|
window's top left corner (the client area may be shifted because of<br>
|
|
the borders, scrollbars, other decorations...)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetClientRect"><strong>GetClientRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetClientRect">GetClientRect</a>(self) -> Rect<br>
|
|
<br>
|
|
Get the client area position and size as a `wx.Rect` object.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetClientSize"><strong>GetClientSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetClientSize">GetClientSize</a>(self) -> Size<br>
|
|
<br>
|
|
This gets the size of the window's 'client area' in pixels. The client<br>
|
|
area is the area which may be drawn on by the programmer, excluding<br>
|
|
title bar, border, scrollbars, etc.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetClientSizeTuple"><strong>GetClientSizeTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetClientSizeTuple">GetClientSizeTuple</a>() -> (width, height)<br>
|
|
<br>
|
|
This gets the size of the window's 'client area' in pixels. The client<br>
|
|
area is the area which may be drawn on by the programmer, excluding<br>
|
|
title bar, border, scrollbars, etc.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetConstraints"><strong>GetConstraints</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetConstraints">GetConstraints</a>(self) -> LayoutConstraints<br>
|
|
<br>
|
|
Returns a pointer to the window's layout constraints, or None if there<br>
|
|
are none.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetContainingSizer"><strong>GetContainingSizer</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetContainingSizer">GetContainingSizer</a>(self) -> Sizer<br>
|
|
<br>
|
|
Return the sizer that this window is a member of, if any, otherwise None.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetCursor"><strong>GetCursor</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetCursor">GetCursor</a>(self) -> Cursor<br>
|
|
<br>
|
|
Return the cursor associated with this window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetDefaultAttributes"><strong>GetDefaultAttributes</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetDefaultAttributes">GetDefaultAttributes</a>(self) -> VisualAttributes<br>
|
|
<br>
|
|
Get the default attributes for an instance of this class. This is<br>
|
|
useful if you want to use the same font or colour in your own control<br>
|
|
as in a standard control -- which is a much better idea than hard<br>
|
|
coding specific colours or fonts which might look completely out of<br>
|
|
place on the user's system, especially if it uses themes.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetDropTarget"><strong>GetDropTarget</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetDropTarget">GetDropTarget</a>(self) -> DropTarget<br>
|
|
<br>
|
|
Returns the associated drop target, which may be None.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetEffectiveMinSize"><strong>GetEffectiveMinSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetEffectiveMinSize">GetEffectiveMinSize</a>(self) -> Size<br>
|
|
<br>
|
|
This function will merge the window's best size into the window's<br>
|
|
minimum size, giving priority to the min size components, and returns<br>
|
|
the results.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetEventHandler"><strong>GetEventHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetEventHandler">GetEventHandler</a>(self) -> EvtHandler<br>
|
|
<br>
|
|
Returns the event handler for this window. By default, the window is<br>
|
|
its own event handler.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetExtraStyle"><strong>GetExtraStyle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetExtraStyle">GetExtraStyle</a>(self) -> long<br>
|
|
<br>
|
|
Returns the extra style bits for the window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetFont"><strong>GetFont</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetFont">GetFont</a>(self) -> Font<br>
|
|
<br>
|
|
Returns the default font used for this window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetForegroundColour"><strong>GetForegroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetForegroundColour">GetForegroundColour</a>(self) -> Colour<br>
|
|
<br>
|
|
Returns the foreground colour of the window. The interpretation of<br>
|
|
foreground colour is dependent on the window class; it may be the text<br>
|
|
colour or other colour, or it may not be used at all.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetFullTextExtent"><strong>GetFullTextExtent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetFullTextExtent">GetFullTextExtent</a>(String string, Font font=None) -><br>
|
|
(width, height, descent, externalLeading)<br>
|
|
<br>
|
|
Get the width, height, decent and leading of the text using the<br>
|
|
current or specified font.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetGrandParent"><strong>GetGrandParent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetGrandParent">GetGrandParent</a>(self) -> Window<br>
|
|
<br>
|
|
Returns the parent of the parent of this window, or None if there<br>
|
|
isn't one.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetGtkWidget"><strong>GetGtkWidget</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetGtkWidget">GetGtkWidget</a>(self) -> long<br>
|
|
<br>
|
|
On wxGTK returns a pointer to the GtkWidget for this window as a long<br>
|
|
integer. On the other platforms this method returns zero.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetHandle"><strong>GetHandle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetHandle">GetHandle</a>(self) -> long<br>
|
|
<br>
|
|
Returns the platform-specific handle (as a long integer) of the<br>
|
|
physical window. On wxMSW this is the win32 window handle, on wxGTK<br>
|
|
it is the XWindow ID, and on wxMac it is the ControlRef.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetHelpText"><strong>GetHelpText</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetHelpText">GetHelpText</a>(self) -> String<br>
|
|
<br>
|
|
Gets the help text to be used as context-sensitive help for this<br>
|
|
window. Note that the text is actually stored by the current<br>
|
|
`wx.HelpProvider` implementation, and not in the window object itself.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetHelpTextAtPoint"><strong>GetHelpTextAtPoint</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetHelpTextAtPoint">GetHelpTextAtPoint</a>(self, Point pt, wxHelpEvent::Origin origin) -> String<br>
|
|
<br>
|
|
Get the help string associated with the given position in this window.<br>
|
|
<br>
|
|
Notice that pt may be invalid if event origin is keyboard or unknown<br>
|
|
and this method should return the global window help text then</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetId"><strong>GetId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetId">GetId</a>(self) -> int<br>
|
|
<br>
|
|
Returns the identifier of the window. Each window has an integer<br>
|
|
identifier. If the application has not provided one (or the default Id<br>
|
|
-1 is used) then an unique identifier with a negative value will be<br>
|
|
generated.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetLabel"><strong>GetLabel</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetLabel">GetLabel</a>(self) -> String<br>
|
|
<br>
|
|
Generic way of getting a label from any window, for identification<br>
|
|
purposes. The interpretation of this function differs from class to<br>
|
|
class. For frames and dialogs, the value returned is the title. For<br>
|
|
buttons or static text controls, it is the button text. This function<br>
|
|
can be useful for meta-programs such as testing tools or special-needs<br>
|
|
access programs)which need to identify windows by name.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetLayoutDirection"><strong>GetLayoutDirection</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetLayoutDirection">GetLayoutDirection</a>(self) -> int<br>
|
|
<br>
|
|
Get the layout direction (LTR or RTL) for this window. Returns<br>
|
|
``wx.Layout_Default`` if layout direction is not supported.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetMaxHeight"><strong>GetMaxHeight</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetMaxHeight">GetMaxHeight</a>(self) -> int</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetMaxSize"><strong>GetMaxSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetMaxSize">GetMaxSize</a>(self) -> Size</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetMaxWidth"><strong>GetMaxWidth</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetMaxWidth">GetMaxWidth</a>(self) -> int</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetMinHeight"><strong>GetMinHeight</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetMinHeight">GetMinHeight</a>(self) -> int</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetMinSize"><strong>GetMinSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetMinSize">GetMinSize</a>(self) -> Size</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetMinWidth"><strong>GetMinWidth</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetMinWidth">GetMinWidth</a>(self) -> int</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetName"><strong>GetName</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetName">GetName</a>(self) -> String<br>
|
|
<br>
|
|
Returns the windows name. This name is not guaranteed to be unique;<br>
|
|
it is up to the programmer to supply an appropriate name in the window<br>
|
|
constructor or via wx.Window.SetName.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetParent"><strong>GetParent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetParent">GetParent</a>(self) -> Window<br>
|
|
<br>
|
|
Returns the parent window of this window, or None if there isn't one.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetPosition"><strong>GetPosition</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetPosition">GetPosition</a>(self) -> Point<br>
|
|
<br>
|
|
Get the window's position. Notice that the position is in client<br>
|
|
coordinates for child windows and screen coordinates for the top level<br>
|
|
ones, use `GetScreenPosition` if you need screen coordinates for all<br>
|
|
kinds of windows.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetPositionTuple"><strong>GetPositionTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetPositionTuple">GetPositionTuple</a>() -> (x,y)<br>
|
|
<br>
|
|
Get the window's position. Notice that the position is in client<br>
|
|
coordinates for child windows and screen coordinates for the top level<br>
|
|
ones, use `GetScreenPosition` if you need screen coordinates for all<br>
|
|
kinds of windows.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetRect"><strong>GetRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetRect">GetRect</a>(self) -> Rect<br>
|
|
<br>
|
|
Returns the size and position of the window as a `wx.Rect` object.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetScreenPosition"><strong>GetScreenPosition</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetScreenPosition">GetScreenPosition</a>(self) -> Point<br>
|
|
<br>
|
|
Get the position of the window in screen coordinantes.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetScreenPositionTuple"><strong>GetScreenPositionTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetScreenPositionTuple">GetScreenPositionTuple</a>() -> (x,y)<br>
|
|
<br>
|
|
Get the position of the window in screen coordinantes.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetScreenRect"><strong>GetScreenRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetScreenRect">GetScreenRect</a>(self) -> Rect<br>
|
|
<br>
|
|
Returns the size and position of the window in screen coordinantes as<br>
|
|
a `wx.Rect` object.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetScrollPos"><strong>GetScrollPos</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetScrollPos">GetScrollPos</a>(self, int orientation) -> int<br>
|
|
<br>
|
|
Returns the built-in scrollbar position.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetScrollRange"><strong>GetScrollRange</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetScrollRange">GetScrollRange</a>(self, int orientation) -> int<br>
|
|
<br>
|
|
Returns the built-in scrollbar range.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetScrollThumb"><strong>GetScrollThumb</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetScrollThumb">GetScrollThumb</a>(self, int orientation) -> int<br>
|
|
<br>
|
|
Returns the built-in scrollbar thumb size.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetSize"><strong>GetSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetSize">GetSize</a>(self) -> Size<br>
|
|
<br>
|
|
Get the window size.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetSizeTuple"><strong>GetSizeTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetSizeTuple">GetSizeTuple</a>() -> (width, height)<br>
|
|
<br>
|
|
Get the window size.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetSizer"><strong>GetSizer</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetSizer">GetSizer</a>(self) -> Sizer<br>
|
|
<br>
|
|
Return the sizer associated with the window by a previous call to<br>
|
|
SetSizer or None if there isn't one.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetTextExtent"><strong>GetTextExtent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetTextExtent">GetTextExtent</a>(String string) -> (width, height)<br>
|
|
<br>
|
|
Get the width and height of the text using the current font.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetThemeEnabled"><strong>GetThemeEnabled</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetThemeEnabled">GetThemeEnabled</a>(self) -> bool<br>
|
|
<br>
|
|
Return the themeEnabled flag.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetToolTip"><strong>GetToolTip</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetToolTip">GetToolTip</a>(self) -> ToolTip<br>
|
|
<br>
|
|
get the associated tooltip or None if none</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetTopLevelParent"><strong>GetTopLevelParent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetTopLevelParent">GetTopLevelParent</a>(self) -> Window<br>
|
|
<br>
|
|
Returns the first frame or dialog in this window's parental hierarchy.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetUpdateClientRect"><strong>GetUpdateClientRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetUpdateClientRect">GetUpdateClientRect</a>(self) -> Rect<br>
|
|
<br>
|
|
Get the update rectangle region bounding box in client coords.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetUpdateRegion"><strong>GetUpdateRegion</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetUpdateRegion">GetUpdateRegion</a>(self) -> Region<br>
|
|
<br>
|
|
Returns the region specifying which parts of the window have been<br>
|
|
damaged. Should only be called within an EVT_PAINT handler.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetValidator"><strong>GetValidator</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetValidator">GetValidator</a>(self) -> Validator<br>
|
|
<br>
|
|
Returns a pointer to the current validator for the window, or None if<br>
|
|
there is none.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetVirtualSize"><strong>GetVirtualSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetVirtualSize">GetVirtualSize</a>(self) -> Size<br>
|
|
<br>
|
|
Get the the virtual size of the window in pixels. For most windows<br>
|
|
this is just the client area of the window, but for some like scrolled<br>
|
|
windows it is more or less independent of the screen window size.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetVirtualSizeTuple"><strong>GetVirtualSizeTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetVirtualSizeTuple">GetVirtualSizeTuple</a>() -> (width, height)<br>
|
|
<br>
|
|
Get the the virtual size of the window in pixels. For most windows<br>
|
|
this is just the client area of the window, but for some like scrolled<br>
|
|
windows it is more or less independent of the screen window size.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetWindowBorderSize"><strong>GetWindowBorderSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetWindowBorderSize">GetWindowBorderSize</a>(self) -> Size<br>
|
|
<br>
|
|
Return the size of the left/right and top/bottom borders.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetWindowStyle"><strong>GetWindowStyle</strong></a> = GetWindowStyleFlag(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetWindowStyleFlag">GetWindowStyleFlag</a>(self) -> long<br>
|
|
<br>
|
|
Gets the window style that was passed to the constructor or Create<br>
|
|
method.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetWindowStyleFlag"><strong>GetWindowStyleFlag</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetWindowStyleFlag">GetWindowStyleFlag</a>(self) -> long<br>
|
|
<br>
|
|
Gets the window style that was passed to the constructor or Create<br>
|
|
method.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetWindowVariant"><strong>GetWindowVariant</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetWindowVariant">GetWindowVariant</a>(self) -> int</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-HasCapture"><strong>HasCapture</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-HasCapture">HasCapture</a>(self) -> bool<br>
|
|
<br>
|
|
Returns true if this window has the current mouse capture.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-HasFlag"><strong>HasFlag</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-HasFlag">HasFlag</a>(self, int flag) -> bool<br>
|
|
<br>
|
|
Test if the given style is set for this window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-HasMultiplePages"><strong>HasMultiplePages</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-HasMultiplePages">HasMultiplePages</a>(self) -> bool</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-HasScrollbar"><strong>HasScrollbar</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-HasScrollbar">HasScrollbar</a>(self, int orient) -> bool<br>
|
|
<br>
|
|
Does the window have the scrollbar for this orientation?</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-HasTransparentBackground"><strong>HasTransparentBackground</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-HasTransparentBackground">HasTransparentBackground</a>(self) -> bool<br>
|
|
<br>
|
|
Returns True if this window's background is transparent (as, for<br>
|
|
example, for `wx.StaticText`) and should show the parent window's<br>
|
|
background.<br>
|
|
<br>
|
|
This method is mostly used internally by the library itself and you<br>
|
|
normally shouldn't have to call it. You may, however, have to override<br>
|
|
it in your custom control classes to ensure that background is painted<br>
|
|
correctly.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Hide"><strong>Hide</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Hide">Hide</a>(self) -> bool<br>
|
|
<br>
|
|
Equivalent to calling <a href="#wxSDLPanel-Show">Show</a>(False).</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-HitTest"><strong>HitTest</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-HitTest">HitTest</a>(self, Point pt) -> int<br>
|
|
<br>
|
|
Test where the given (in client coords) point lies</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-HitTestXY"><strong>HitTestXY</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-HitTestXY">HitTestXY</a>(self, int x, int y) -> int<br>
|
|
<br>
|
|
Test where the given (in client coords) point lies</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-InheritAttributes"><strong>InheritAttributes</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-InheritAttributes">InheritAttributes</a>(self)<br>
|
|
<br>
|
|
This function is (or should be, in case of custom controls) called<br>
|
|
during window creation to intelligently set up the window visual<br>
|
|
attributes, that is the font and the foreground and background<br>
|
|
colours.<br>
|
|
<br>
|
|
By 'intelligently' the following is meant: by default, all windows use<br>
|
|
their own default attributes. However if some of the parent's<br>
|
|
attributes are explicitly changed (that is, using SetFont and not<br>
|
|
SetOwnFont) and if the corresponding attribute hadn't been<br>
|
|
explicitly set for this window itself, then this window takes the same<br>
|
|
value as used by the parent. In addition, if the window overrides<br>
|
|
ShouldInheritColours to return false, the colours will not be changed<br>
|
|
no matter what and only the font might.<br>
|
|
<br>
|
|
This rather complicated logic is necessary in order to accommodate the<br>
|
|
different usage scenarios. The most common one is when all default<br>
|
|
attributes are used and in this case, nothing should be inherited as<br>
|
|
in modern GUIs different controls use different fonts (and colours)<br>
|
|
than their siblings so they can't inherit the same value from the<br>
|
|
parent. However it was also deemed desirable to allow to simply change<br>
|
|
the attributes of all children at once by just changing the font or<br>
|
|
colour of their common parent, hence in this case we do inherit the<br>
|
|
parents attributes.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-InheritsBackgroundColour"><strong>InheritsBackgroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-InheritsBackgroundColour">InheritsBackgroundColour</a>(self) -> bool</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-InitDialog"><strong>InitDialog</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-InitDialog">InitDialog</a>(self)<br>
|
|
<br>
|
|
Sends an EVT_INIT_DIALOG event, whose handler usually transfers data<br>
|
|
to the dialog via validators.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-InvalidateBestSize"><strong>InvalidateBestSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-InvalidateBestSize">InvalidateBestSize</a>(self)<br>
|
|
<br>
|
|
Reset the cached best size value so it will be recalculated the next<br>
|
|
time it is needed.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsBeingDeleted"><strong>IsBeingDeleted</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsBeingDeleted">IsBeingDeleted</a>(self) -> bool<br>
|
|
<br>
|
|
Is the window in the process of being deleted?</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsDoubleBuffered"><strong>IsDoubleBuffered</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsDoubleBuffered">IsDoubleBuffered</a>(self) -> bool<br>
|
|
<br>
|
|
Returns ``True`` if the window contents is double-buffered by the<br>
|
|
system, i.e. if any drawing done on the window is really done on a<br>
|
|
temporary backing surface and transferred to the screen all at once<br>
|
|
later.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsEnabled"><strong>IsEnabled</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsEnabled">IsEnabled</a>(self) -> bool<br>
|
|
<br>
|
|
Returns true if the window is enabled for input, false otherwise.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsExposed"><strong>IsExposed</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsExposed">IsExposed</a>(self, int x, int y, int w=1, int h=1) -> bool<br>
|
|
<br>
|
|
Returns true if the given point or rectangle area has been exposed<br>
|
|
since the last repaint. Call this in an paint event handler to<br>
|
|
optimize redrawing by only redrawing those areas, which have been<br>
|
|
exposed.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsExposedPoint"><strong>IsExposedPoint</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsExposedPoint">IsExposedPoint</a>(self, Point pt) -> bool<br>
|
|
<br>
|
|
Returns true if the given point or rectangle area has been exposed<br>
|
|
since the last repaint. Call this in an paint event handler to<br>
|
|
optimize redrawing by only redrawing those areas, which have been<br>
|
|
exposed.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsExposedRect"><strong>IsExposedRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsExposedRect">IsExposedRect</a>(self, Rect rect) -> bool<br>
|
|
<br>
|
|
Returns true if the given point or rectangle area has been exposed<br>
|
|
since the last repaint. Call this in an paint event handler to<br>
|
|
optimize redrawing by only redrawing those areas, which have been<br>
|
|
exposed.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsFrozen"><strong>IsFrozen</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsFrozen">IsFrozen</a>(self) -> bool<br>
|
|
<br>
|
|
Returns ``True`` if the window has been frozen and not thawed yet.<br>
|
|
<br>
|
|
:see: `Freeze` and `Thaw`</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsRetained"><strong>IsRetained</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsRetained">IsRetained</a>(self) -> bool<br>
|
|
<br>
|
|
Returns true if the window is retained, false otherwise. Retained<br>
|
|
windows are only available on X platforms.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsShown"><strong>IsShown</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsShown">IsShown</a>(self) -> bool<br>
|
|
<br>
|
|
Returns true if the window is shown, false if it has been hidden.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsShownOnScreen"><strong>IsShownOnScreen</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsShownOnScreen">IsShownOnScreen</a>(self) -> bool<br>
|
|
<br>
|
|
Returns ``True`` if the window is physically visible on the screen,<br>
|
|
i.e. it is shown and all its parents up to the toplevel window are<br>
|
|
shown as well.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsTopLevel"><strong>IsTopLevel</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsTopLevel">IsTopLevel</a>(self) -> bool<br>
|
|
<br>
|
|
Returns true if the given window is a top-level one. Currently all<br>
|
|
frames and dialogs are always considered to be top-level windows (even<br>
|
|
if they have a parent window).</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Layout"><strong>Layout</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Layout">Layout</a>(self) -> bool<br>
|
|
<br>
|
|
Invokes the constraint-based layout algorithm or the sizer-based<br>
|
|
algorithm for this window. See SetAutoLayout: when auto layout is on,<br>
|
|
this function gets called automatically by the default EVT_SIZE<br>
|
|
handler when the window is resized.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-LineDown"><strong>LineDown</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-LineDown">LineDown</a>(self) -> bool<br>
|
|
<br>
|
|
This is just a wrapper for <a href="#wxSDLPanel-ScrollLines">ScrollLines</a>(1).</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-LineUp"><strong>LineUp</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-LineUp">LineUp</a>(self) -> bool<br>
|
|
<br>
|
|
This is just a wrapper for <a href="#wxSDLPanel-ScrollLines">ScrollLines</a>(-1).</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Lower"><strong>Lower</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Lower">Lower</a>(self)<br>
|
|
<br>
|
|
Lowers the window to the bottom of the window hierarchy. In current<br>
|
|
version of wxWidgets this works both for managed and child windows.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-MakeModal"><strong>MakeModal</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-MakeModal">MakeModal</a>(self, bool modal=True)<br>
|
|
<br>
|
|
Disables all other windows in the application so that the user can<br>
|
|
only interact with this window. Passing False will reverse this<br>
|
|
effect.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Move"><strong>Move</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Move">Move</a>(self, Point pt, int flags=SIZE_USE_EXISTING)<br>
|
|
<br>
|
|
Moves the window to the given position.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-MoveAfterInTabOrder"><strong>MoveAfterInTabOrder</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-MoveAfterInTabOrder">MoveAfterInTabOrder</a>(self, Window win)<br>
|
|
<br>
|
|
Moves this window in the tab navigation order after the specified<br>
|
|
sibling window. This means that when the user presses the TAB key on<br>
|
|
that other window, the focus switches to this window.<br>
|
|
<br>
|
|
The default tab order is the same as creation order. This function<br>
|
|
and `MoveBeforeInTabOrder` allow to change it after creating all the<br>
|
|
windows.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-MoveBeforeInTabOrder"><strong>MoveBeforeInTabOrder</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-MoveBeforeInTabOrder">MoveBeforeInTabOrder</a>(self, Window win)<br>
|
|
<br>
|
|
Same as `MoveAfterInTabOrder` except that it inserts this window just<br>
|
|
before win instead of putting it right after it.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-MoveXY"><strong>MoveXY</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-MoveXY">MoveXY</a>(self, int x, int y, int flags=SIZE_USE_EXISTING)<br>
|
|
<br>
|
|
Moves the window to the given position.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Navigate"><strong>Navigate</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Navigate">Navigate</a>(self, int flags=NavigationKeyEvent.IsForward) -> bool<br>
|
|
<br>
|
|
Does keyboard navigation from this window to another, by sending a<br>
|
|
`wx.NavigationKeyEvent`.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-PageDown"><strong>PageDown</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-PageDown">PageDown</a>(self) -> bool<br>
|
|
<br>
|
|
This is just a wrapper for <a href="#wxSDLPanel-ScrollPages">ScrollPages</a>(1).</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-PageUp"><strong>PageUp</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-PageUp">PageUp</a>(self) -> bool<br>
|
|
<br>
|
|
This is just a wrapper for <a href="#wxSDLPanel-ScrollPages">ScrollPages</a>(-1).</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-PopEventHandler"><strong>PopEventHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-PopEventHandler">PopEventHandler</a>(self, bool deleteHandler=False) -> EvtHandler<br>
|
|
<br>
|
|
Removes and returns the top-most event handler on the event handler<br>
|
|
stack. If deleteHandler is True then the wx.EvtHandler object will be<br>
|
|
destroyed after it is popped, and ``None`` will be returned instead.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-PopupMenu"><strong>PopupMenu</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-PopupMenu">PopupMenu</a>(self, Menu menu, Point pos=DefaultPosition) -> bool<br>
|
|
<br>
|
|
Pops up the given menu at the specified coordinates, relative to this window,<br>
|
|
and returns control when the user has dismissed the menu. If a menu item is<br>
|
|
selected, the corresponding menu event is generated and will be processed as<br>
|
|
usual. If the default position is given then the current position of the<br>
|
|
mouse cursor will be used.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-PopupMenuXY"><strong>PopupMenuXY</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-PopupMenuXY">PopupMenuXY</a>(self, Menu menu, int x=-1, int y=-1) -> bool<br>
|
|
<br>
|
|
Pops up the given menu at the specified coordinates, relative to this window,<br>
|
|
and returns control when the user has dismissed the menu. If a menu item is<br>
|
|
selected, the corresponding menu event is generated and will be processed as<br>
|
|
usual. If the default position is given then the current position of the<br>
|
|
mouse cursor will be used.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-PostCreate"><strong>PostCreate</strong></a>(self, pre)</dt><dd><tt>Phase 3 of the 2-phase create <wink!><br>
|
|
Call this method after precreating the window with the 2-phase create method.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-PrepareDC"><strong>PrepareDC</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-PrepareDC">PrepareDC</a>(self, DC dc)<br>
|
|
<br>
|
|
Call this function to prepare the device context for drawing a<br>
|
|
scrolled image. It sets the device origin according to the current<br>
|
|
scroll position.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-PushEventHandler"><strong>PushEventHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-PushEventHandler">PushEventHandler</a>(self, EvtHandler handler)<br>
|
|
<br>
|
|
Pushes this event handler onto the event handler stack for the window.<br>
|
|
An event handler is an object that is capable of processing the events<br>
|
|
sent to a window. (In other words, is able to dispatch the events to a<br>
|
|
handler function.) By default, the window is its own event handler,<br>
|
|
but an application may wish to substitute another, for example to<br>
|
|
allow central implementation of event-handling for a variety of<br>
|
|
different window classes.<br>
|
|
<br>
|
|
wx.Window.PushEventHandler allows an application to set up a chain of<br>
|
|
event handlers, where an event not handled by one event handler is<br>
|
|
handed to the next one in the chain. Use `wx.Window.PopEventHandler`<br>
|
|
to remove the event handler. Ownership of the handler is *not* given<br>
|
|
to the window, so you should be sure to pop the handler before the<br>
|
|
window is destroyed and either let PopEventHandler destroy it, or call<br>
|
|
its Destroy method yourself.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Raise"><strong>Raise</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Raise">Raise</a>(self)<br>
|
|
<br>
|
|
Raises the window to the top of the window hierarchy. In current<br>
|
|
version of wxWidgets this works both for managed and child windows.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Refresh"><strong>Refresh</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Refresh">Refresh</a>(self, bool eraseBackground=True, Rect rect=None)<br>
|
|
<br>
|
|
Mark the specified rectangle (or the whole window) as "dirty" so it<br>
|
|
will be repainted. Causes an EVT_PAINT event to be generated and sent<br>
|
|
to the window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-RefreshRect"><strong>RefreshRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-RefreshRect">RefreshRect</a>(self, Rect rect, bool eraseBackground=True)<br>
|
|
<br>
|
|
Redraws the contents of the given rectangle: the area inside it will<br>
|
|
be repainted. This is the same as Refresh but has a nicer syntax.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-RegisterHotKey"><strong>RegisterHotKey</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-RegisterHotKey">RegisterHotKey</a>(self, int hotkeyId, int modifiers, int keycode) -> bool<br>
|
|
<br>
|
|
Registers a system wide hotkey. Every time the user presses the hotkey<br>
|
|
registered here, this window will receive a hotkey event. It will<br>
|
|
receive the event even if the application is in the background and<br>
|
|
does not have the input focus because the user is working with some<br>
|
|
other application. To bind an event handler function to this hotkey<br>
|
|
use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the<br>
|
|
hotkey was registered successfully.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ReleaseMouse"><strong>ReleaseMouse</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ReleaseMouse">ReleaseMouse</a>(self)<br>
|
|
<br>
|
|
Releases mouse input captured with wx.Window.CaptureMouse.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-RemoveChild"><strong>RemoveChild</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-RemoveChild">RemoveChild</a>(self, Window child)<br>
|
|
<br>
|
|
Removes a child window. This is called automatically by window<br>
|
|
deletion functions so should not be required by the application<br>
|
|
programmer.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-RemoveEventHandler"><strong>RemoveEventHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-RemoveEventHandler">RemoveEventHandler</a>(self, EvtHandler handler) -> bool<br>
|
|
<br>
|
|
Find the given handler in the event handler chain and remove (but not<br>
|
|
delete) it from the event handler chain, returns True if it was found<br>
|
|
and False otherwise (this also results in an assert failure so this<br>
|
|
function should only be called when the handler is supposed to be<br>
|
|
there.)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Reparent"><strong>Reparent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Reparent">Reparent</a>(self, Window newParent) -> bool<br>
|
|
<br>
|
|
Reparents the window, i.e the window will be removed from its current<br>
|
|
parent window (e.g. a non-standard toolbar in a wxFrame) and then<br>
|
|
re-inserted into another. Available on Windows and GTK. Returns True<br>
|
|
if the parent was changed, False otherwise (error or newParent ==<br>
|
|
oldParent)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ScreenToClient"><strong>ScreenToClient</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ScreenToClient">ScreenToClient</a>(self, Point pt) -> Point<br>
|
|
<br>
|
|
Converts from screen to client window coordinates.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ScreenToClientXY"><strong>ScreenToClientXY</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ScreenToClientXY">ScreenToClientXY</a>(int x, int y) -> (x,y)<br>
|
|
<br>
|
|
Converts from screen to client window coordinates.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ScrollLines"><strong>ScrollLines</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ScrollLines">ScrollLines</a>(self, int lines) -> bool<br>
|
|
<br>
|
|
If the platform and window class supports it, scrolls the window by<br>
|
|
the given number of lines down, if lines is positive, or up if lines<br>
|
|
is negative. Returns True if the window was scrolled, False if it was<br>
|
|
already on top/bottom and nothing was done.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ScrollPages"><strong>ScrollPages</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ScrollPages">ScrollPages</a>(self, int pages) -> bool<br>
|
|
<br>
|
|
If the platform and window class supports it, scrolls the window by<br>
|
|
the given number of pages down, if pages is positive, or up if pages<br>
|
|
is negative. Returns True if the window was scrolled, False if it was<br>
|
|
already on top/bottom and nothing was done.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ScrollWindow"><strong>ScrollWindow</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ScrollWindow">ScrollWindow</a>(self, int dx, int dy, Rect rect=None)<br>
|
|
<br>
|
|
Physically scrolls the pixels in the window and move child windows<br>
|
|
accordingly. Use this function to optimise your scrolling<br>
|
|
implementations, to minimise the area that must be redrawn. Note that<br>
|
|
it is rarely required to call this function from a user program.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SendSizeEvent"><strong>SendSizeEvent</strong></a>(self)</dt></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetAcceleratorTable"><strong>SetAcceleratorTable</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetAcceleratorTable">SetAcceleratorTable</a>(self, AcceleratorTable accel)<br>
|
|
<br>
|
|
Sets the accelerator table for this window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetAutoLayout"><strong>SetAutoLayout</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetAutoLayout">SetAutoLayout</a>(self, bool autoLayout)<br>
|
|
<br>
|
|
Determines whether the Layout function will be called automatically<br>
|
|
when the window is resized. lease note that this only happens for the<br>
|
|
windows usually used to contain children, namely `wx.<a href="wx._windows.html#Panel">Panel</a>` and<br>
|
|
`wx.TopLevelWindow` (and the classes deriving from them).<br>
|
|
<br>
|
|
This method is called implicitly by `SetSizer` but if you use<br>
|
|
`SetConstraints` you should call it manually or otherwise the window<br>
|
|
layout won't be correctly updated when its size changes.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetBackgroundColour"><strong>SetBackgroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetBackgroundColour">SetBackgroundColour</a>(self, Colour colour) -> bool<br>
|
|
<br>
|
|
Sets the background colour of the window. Returns True if the colour<br>
|
|
was changed. The background colour is usually painted by the default<br>
|
|
EVT_ERASE_BACKGROUND event handler function under Windows and<br>
|
|
automatically under GTK. Using `wx.NullColour` will reset the window<br>
|
|
to the default background colour.<br>
|
|
<br>
|
|
Note that setting the background colour may not cause an immediate<br>
|
|
refresh, so you may wish to call `ClearBackground` or `Refresh` after<br>
|
|
calling this function.<br>
|
|
<br>
|
|
Using this function will disable attempts to use themes for this<br>
|
|
window, if the system supports them. Use with care since usually the<br>
|
|
themes represent the appearance chosen by the user to be used for all<br>
|
|
applications on the system.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetBackgroundStyle"><strong>SetBackgroundStyle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetBackgroundStyle">SetBackgroundStyle</a>(self, int style) -> bool<br>
|
|
<br>
|
|
Returns the background style of the window. The background style<br>
|
|
indicates how the background of the window is drawn.<br>
|
|
<br>
|
|
====================== ========================================<br>
|
|
wx.BG_STYLE_SYSTEM The background colour or pattern should<br>
|
|
be determined by the system<br>
|
|
wx.BG_STYLE_COLOUR The background should be a solid colour<br>
|
|
wx.BG_STYLE_CUSTOM The background will be implemented by the<br>
|
|
application.<br>
|
|
====================== ========================================<br>
|
|
<br>
|
|
On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of<br>
|
|
a custom background, such as a tiled bitmap. Currently the style has<br>
|
|
no effect on other platforms.<br>
|
|
<br>
|
|
:see: `GetBackgroundStyle`, `SetBackgroundColour`</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetBestFittingSize"><strong>SetBestFittingSize</strong></a> = deprecatedWrapper(*args, **kwargs)</dt><dd><tt>Use `SetInitialSize`</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetCaret"><strong>SetCaret</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetCaret">SetCaret</a>(self, Caret caret)<br>
|
|
<br>
|
|
Sets the caret associated with the window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetClientRect"><strong>SetClientRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetClientRect">SetClientRect</a>(self, Rect rect)<br>
|
|
<br>
|
|
This sets the size of the window client area in pixels. Using this<br>
|
|
function to size a window tends to be more device-independent than<br>
|
|
wx.Window.SetSize, since the application need not worry about what<br>
|
|
dimensions the border or title bar have when trying to fit the window<br>
|
|
around panel items, for example.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetClientSize"><strong>SetClientSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetClientSize">SetClientSize</a>(self, Size size)<br>
|
|
<br>
|
|
This sets the size of the window client area in pixels. Using this<br>
|
|
function to size a window tends to be more device-independent than<br>
|
|
wx.Window.SetSize, since the application need not worry about what<br>
|
|
dimensions the border or title bar have when trying to fit the window<br>
|
|
around panel items, for example.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetClientSizeWH"><strong>SetClientSizeWH</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetClientSizeWH">SetClientSizeWH</a>(self, int width, int height)<br>
|
|
<br>
|
|
This sets the size of the window client area in pixels. Using this<br>
|
|
function to size a window tends to be more device-independent than<br>
|
|
wx.Window.SetSize, since the application need not worry about what<br>
|
|
dimensions the border or title bar have when trying to fit the window<br>
|
|
around panel items, for example.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetConstraints"><strong>SetConstraints</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetConstraints">SetConstraints</a>(self, LayoutConstraints constraints)<br>
|
|
<br>
|
|
Sets the window to have the given layout constraints. If an existing<br>
|
|
layout constraints object is already owned by the window, it will be<br>
|
|
deleted. Pass None to disassociate and delete the window's current<br>
|
|
constraints.<br>
|
|
<br>
|
|
You must call SetAutoLayout to tell a window to use the constraints<br>
|
|
automatically in its default EVT_SIZE handler; otherwise, you must<br>
|
|
handle EVT_SIZE yourself and call <a href="#wxSDLPanel-Layout">Layout</a>() explicitly. When setting<br>
|
|
both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have<br>
|
|
effect.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetContainingSizer"><strong>SetContainingSizer</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetContainingSizer">SetContainingSizer</a>(self, Sizer sizer)<br>
|
|
<br>
|
|
This normally does not need to be called by application code. It is<br>
|
|
called internally when a window is added to a sizer, and is used so<br>
|
|
the window can remove itself from the sizer when it is destroyed.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetCursor"><strong>SetCursor</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetCursor">SetCursor</a>(self, Cursor cursor) -> bool<br>
|
|
<br>
|
|
Sets the window's cursor. Notice that the window cursor also sets it<br>
|
|
for the children of the window implicitly.<br>
|
|
<br>
|
|
The cursor may be wx.NullCursor in which case the window cursor will<br>
|
|
be reset back to default.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetDimensions"><strong>SetDimensions</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetDimensions">SetDimensions</a>(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)<br>
|
|
<br>
|
|
Sets the position and size of the window in pixels. The sizeFlags<br>
|
|
parameter indicates the interpretation of the other params if they are<br>
|
|
equal to -1.<br>
|
|
<br>
|
|
======================== ======================================<br>
|
|
wx.SIZE_AUTO A -1 indicates that a class-specific<br>
|
|
default should be used.<br>
|
|
wx.SIZE_USE_EXISTING Axisting dimensions should be used if<br>
|
|
-1 values are supplied.<br>
|
|
wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be<br>
|
|
interpreted as real dimensions, not<br>
|
|
default values.<br>
|
|
======================== ======================================</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetDoubleBuffered"><strong>SetDoubleBuffered</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetDoubleBuffered">SetDoubleBuffered</a>(self, bool on)<br>
|
|
<br>
|
|
Currently wxGTK2 only.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetDropTarget"><strong>SetDropTarget</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetDropTarget">SetDropTarget</a>(self, DropTarget dropTarget)<br>
|
|
<br>
|
|
Associates a drop target with this window. If the window already has<br>
|
|
a drop target, it is deleted.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetEventHandler"><strong>SetEventHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetEventHandler">SetEventHandler</a>(self, EvtHandler handler)<br>
|
|
<br>
|
|
Sets the event handler for this window. An event handler is an object<br>
|
|
that is capable of processing the events sent to a window. (In other<br>
|
|
words, is able to dispatch the events to handler function.) By<br>
|
|
default, the window is its own event handler, but an application may<br>
|
|
wish to substitute another, for example to allow central<br>
|
|
implementation of event-handling for a variety of different window<br>
|
|
classes.<br>
|
|
<br>
|
|
It is usually better to use `wx.Window.PushEventHandler` since this sets<br>
|
|
up a chain of event handlers, where an event not handled by one event<br>
|
|
handler is handed off to the next one in the chain.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetExtraStyle"><strong>SetExtraStyle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetExtraStyle">SetExtraStyle</a>(self, long exStyle)<br>
|
|
<br>
|
|
Sets the extra style bits for the window. Extra styles are the less<br>
|
|
often used style bits which can't be set with the constructor or with<br>
|
|
<a href="#wxSDLPanel-SetWindowStyleFlag">SetWindowStyleFlag</a>()</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetFocus"><strong>SetFocus</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetFocus">SetFocus</a>(self)<br>
|
|
<br>
|
|
Set's the focus to this window, allowing it to receive keyboard input.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetFocusFromKbd"><strong>SetFocusFromKbd</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetFocusFromKbd">SetFocusFromKbd</a>(self)<br>
|
|
<br>
|
|
Set focus to this window as the result of a keyboard action. Normally<br>
|
|
only called internally.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetFont"><strong>SetFont</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetFont">SetFont</a>(self, Font font) -> bool<br>
|
|
<br>
|
|
Sets the font for this window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetForegroundColour"><strong>SetForegroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetForegroundColour">SetForegroundColour</a>(self, Colour colour) -> bool<br>
|
|
<br>
|
|
Sets the foreground colour of the window. Returns True is the colour<br>
|
|
was changed. The interpretation of foreground colour is dependent on<br>
|
|
the window class; it may be the text colour or other colour, or it may<br>
|
|
not be used at all.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetHelpText"><strong>SetHelpText</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetHelpText">SetHelpText</a>(self, String text)<br>
|
|
<br>
|
|
Sets the help text to be used as context-sensitive help for this<br>
|
|
window. Note that the text is actually stored by the current<br>
|
|
`wx.HelpProvider` implementation, and not in the window object itself.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetHelpTextForId"><strong>SetHelpTextForId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetHelpTextForId">SetHelpTextForId</a>(self, String text)<br>
|
|
<br>
|
|
Associate this help text with all windows with the same id as this<br>
|
|
one.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetId"><strong>SetId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetId">SetId</a>(self, int winid)<br>
|
|
<br>
|
|
Sets the identifier of the window. Each window has an integer<br>
|
|
identifier. If the application has not provided one, an identifier<br>
|
|
will be generated. Normally, the identifier should be provided on<br>
|
|
creation and should not be modified subsequently.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetInitialSize"><strong>SetInitialSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetInitialSize">SetInitialSize</a>(self, Size size=DefaultSize)<br>
|
|
<br>
|
|
A 'Smart' SetSize that will fill in default size components with the<br>
|
|
window's *best size* values. Also set's the minsize for use with sizers.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetLabel"><strong>SetLabel</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetLabel">SetLabel</a>(self, String label)<br>
|
|
<br>
|
|
Set the text which the window shows in its label if applicable.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetLayoutDirection"><strong>SetLayoutDirection</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetLayoutDirection">SetLayoutDirection</a>(self, int dir)<br>
|
|
<br>
|
|
Set the layout direction (LTR or RTL) for this window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetMaxSize"><strong>SetMaxSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetMaxSize">SetMaxSize</a>(self, Size maxSize)<br>
|
|
<br>
|
|
A more convenient method than `SetSizeHints` for setting just the<br>
|
|
max size.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetMinSize"><strong>SetMinSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetMinSize">SetMinSize</a>(self, Size minSize)<br>
|
|
<br>
|
|
A more convenient method than `SetSizeHints` for setting just the<br>
|
|
min size.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetName"><strong>SetName</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetName">SetName</a>(self, String name)<br>
|
|
<br>
|
|
Sets the window's name. The window name is used for ressource setting<br>
|
|
in X, it is not the same as the window title/label</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetOwnBackgroundColour"><strong>SetOwnBackgroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetOwnBackgroundColour">SetOwnBackgroundColour</a>(self, Colour colour)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetOwnFont"><strong>SetOwnFont</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetOwnFont">SetOwnFont</a>(self, Font font)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetOwnForegroundColour"><strong>SetOwnForegroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetOwnForegroundColour">SetOwnForegroundColour</a>(self, Colour colour)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetPosition"><strong>SetPosition</strong></a> = Move(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Move">Move</a>(self, Point pt, int flags=SIZE_USE_EXISTING)<br>
|
|
<br>
|
|
Moves the window to the given position.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetRect"><strong>SetRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetRect">SetRect</a>(self, Rect rect, int sizeFlags=SIZE_AUTO)<br>
|
|
<br>
|
|
Sets the position and size of the window in pixels using a wx.Rect.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetScrollPos"><strong>SetScrollPos</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetScrollPos">SetScrollPos</a>(self, int orientation, int pos, bool refresh=True)<br>
|
|
<br>
|
|
Sets the position of one of the built-in scrollbars.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetScrollbar"><strong>SetScrollbar</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetScrollbar">SetScrollbar</a>(self, int orientation, int position, int thumbSize, int range, <br>
|
|
bool refresh=True)<br>
|
|
<br>
|
|
Sets the scrollbar properties of a built-in scrollbar.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetSize"><strong>SetSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetSize">SetSize</a>(self, Size size)<br>
|
|
<br>
|
|
Sets the size of the window in pixels.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetSizeHints"><strong>SetSizeHints</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetSizeHints">SetSizeHints</a>(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, <br>
|
|
int incH=-1)<br>
|
|
<br>
|
|
Allows specification of minimum and maximum window sizes, and window<br>
|
|
size increments. If a pair of values is not set (or set to -1), the<br>
|
|
default values will be used. If this function is called, the user<br>
|
|
will not be able to size the window outside the given bounds (if it is<br>
|
|
a top-level window.) Sizers will also inspect the minimum window size<br>
|
|
and will use that value if set when calculating layout.<br>
|
|
<br>
|
|
The resizing increments are only significant under Motif or Xt.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetSizeHintsSz"><strong>SetSizeHintsSz</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetSizeHintsSz">SetSizeHintsSz</a>(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)<br>
|
|
<br>
|
|
Allows specification of minimum and maximum window sizes, and window<br>
|
|
size increments. If a pair of values is not set (or set to -1), the<br>
|
|
default values will be used. If this function is called, the user<br>
|
|
will not be able to size the window outside the given bounds (if it is<br>
|
|
a top-level window.) Sizers will also inspect the minimum window size<br>
|
|
and will use that value if set when calculating layout.<br>
|
|
<br>
|
|
The resizing increments are only significant under Motif or Xt.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetSizeWH"><strong>SetSizeWH</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetSizeWH">SetSizeWH</a>(self, int width, int height)<br>
|
|
<br>
|
|
Sets the size of the window in pixels.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetSizer"><strong>SetSizer</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetSizer">SetSizer</a>(self, Sizer sizer, bool deleteOld=True)<br>
|
|
<br>
|
|
Sets the window to have the given layout sizer. The window will then<br>
|
|
own the object, and will take care of its deletion. If an existing<br>
|
|
layout sizer object is already owned by the window, it will be deleted<br>
|
|
if the deleteOld parameter is true. Note that this function will also<br>
|
|
call SetAutoLayout implicitly with a True parameter if the sizer is<br>
|
|
non-None, and False otherwise.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetSizerAndFit"><strong>SetSizerAndFit</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetSizerAndFit">SetSizerAndFit</a>(self, Sizer sizer, bool deleteOld=True)<br>
|
|
<br>
|
|
The same as SetSizer, except it also sets the size hints for the<br>
|
|
window based on the sizer's minimum size.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetThemeEnabled"><strong>SetThemeEnabled</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetThemeEnabled">SetThemeEnabled</a>(self, bool enableTheme)<br>
|
|
<br>
|
|
This function tells a window if it should use the system's "theme"<br>
|
|
code to draw the windows' background instead if its own background<br>
|
|
drawing code. This will only have an effect on platforms that support<br>
|
|
the notion of themes in user defined windows. One such platform is<br>
|
|
GTK+ where windows can have (very colourful) backgrounds defined by a<br>
|
|
user's selected theme.<br>
|
|
<br>
|
|
Dialogs, notebook pages and the status bar have this flag set to true<br>
|
|
by default so that the default look and feel is simulated best.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetToolTip"><strong>SetToolTip</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetToolTip">SetToolTip</a>(self, ToolTip tip)<br>
|
|
<br>
|
|
Attach a tooltip to the window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetToolTipString"><strong>SetToolTipString</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetToolTipString">SetToolTipString</a>(self, String tip)<br>
|
|
<br>
|
|
Attach a tooltip to the window.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetTransparent"><strong>SetTransparent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetTransparent">SetTransparent</a>(self, byte alpha) -> bool<br>
|
|
<br>
|
|
Attempt to set the transparency of this window to the ``alpha`` value,<br>
|
|
returns True on success. The ``alpha`` value is an integer in the<br>
|
|
range of 0 to 255, where 0 is fully transparent and 255 is fully<br>
|
|
opaque.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetValidator"><strong>SetValidator</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetValidator">SetValidator</a>(self, Validator validator)<br>
|
|
<br>
|
|
Deletes the current validator (if any) and sets the window validator,<br>
|
|
having called wx.Validator.Clone to create a new validator of this<br>
|
|
type.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetVirtualSize"><strong>SetVirtualSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetVirtualSize">SetVirtualSize</a>(self, Size size)<br>
|
|
<br>
|
|
Set the the virtual size of a window in pixels. For most windows this<br>
|
|
is just the client area of the window, but for some like scrolled<br>
|
|
windows it is more or less independent of the screen window size.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetVirtualSizeHints"><strong>SetVirtualSizeHints</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetVirtualSizeHints">SetVirtualSizeHints</a>(self, int minW, int minH, int maxW=-1, int maxH=-1)<br>
|
|
<br>
|
|
Allows specification of minimum and maximum virtual window sizes. If a<br>
|
|
pair of values is not set (or set to -1), the default values will be<br>
|
|
used. If this function is called, the user will not be able to size<br>
|
|
the virtual area of the window outside the given bounds.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetVirtualSizeHintsSz"><strong>SetVirtualSizeHintsSz</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetVirtualSizeHintsSz">SetVirtualSizeHintsSz</a>(self, Size minSize, Size maxSize=DefaultSize)<br>
|
|
<br>
|
|
Allows specification of minimum and maximum virtual window sizes. If a<br>
|
|
pair of values is not set (or set to -1), the default values will be<br>
|
|
used. If this function is called, the user will not be able to size<br>
|
|
the virtual area of the window outside the given bounds.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetVirtualSizeWH"><strong>SetVirtualSizeWH</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetVirtualSizeWH">SetVirtualSizeWH</a>(self, int w, int h)<br>
|
|
<br>
|
|
Set the the virtual size of a window in pixels. For most windows this<br>
|
|
is just the client area of the window, but for some like scrolled<br>
|
|
windows it is more or less independent of the screen window size.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetWindowStyle"><strong>SetWindowStyle</strong></a> = SetWindowStyleFlag(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetWindowStyleFlag">SetWindowStyleFlag</a>(self, long style)<br>
|
|
<br>
|
|
Sets the style of the window. Please note that some styles cannot be<br>
|
|
changed after the window creation and that <a href="#wxSDLPanel-Refresh">Refresh</a>() might need to be<br>
|
|
called after changing the others for the change to take place<br>
|
|
immediately.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetWindowStyleFlag"><strong>SetWindowStyleFlag</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetWindowStyleFlag">SetWindowStyleFlag</a>(self, long style)<br>
|
|
<br>
|
|
Sets the style of the window. Please note that some styles cannot be<br>
|
|
changed after the window creation and that <a href="#wxSDLPanel-Refresh">Refresh</a>() might need to be<br>
|
|
called after changing the others for the change to take place<br>
|
|
immediately.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetWindowVariant"><strong>SetWindowVariant</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetWindowVariant">SetWindowVariant</a>(self, int variant)<br>
|
|
<br>
|
|
Sets the variant of the window/font size to use for this window, if<br>
|
|
the platform supports variants, for example, wxMac.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ShouldInheritColours"><strong>ShouldInheritColours</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ShouldInheritColours">ShouldInheritColours</a>(self) -> bool<br>
|
|
<br>
|
|
Return true from here to allow the colours of this window to be<br>
|
|
changed by InheritAttributes, returning false forbids inheriting them<br>
|
|
from the parent window.<br>
|
|
<br>
|
|
The base class version returns false, but this method is overridden in<br>
|
|
wxControl where it returns true.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Show"><strong>Show</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Show">Show</a>(self, bool show=True) -> bool<br>
|
|
<br>
|
|
Shows or hides the window. You may need to call Raise for a top level<br>
|
|
window if you want to bring it to top, although this is not needed if<br>
|
|
Show is called immediately after the frame creation. Returns True if<br>
|
|
the window has been shown or hidden or False if nothing was done<br>
|
|
because it already was in the requested state.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Thaw"><strong>Thaw</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Thaw">Thaw</a>(self)<br>
|
|
<br>
|
|
Reenables window updating after a previous call to Freeze. Calls to<br>
|
|
Freeze/Thaw may be nested, so Thaw must be called the same number of<br>
|
|
times that Freeze was before the window will be updated.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ToggleWindowStyle"><strong>ToggleWindowStyle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ToggleWindowStyle">ToggleWindowStyle</a>(self, int flag) -> bool<br>
|
|
<br>
|
|
Turn the flag on if it had been turned off before and vice versa,<br>
|
|
returns True if the flag is turned on by this function call.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-TransferDataFromWindow"><strong>TransferDataFromWindow</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-TransferDataFromWindow">TransferDataFromWindow</a>(self) -> bool<br>
|
|
<br>
|
|
Transfers values from child controls to data areas specified by their<br>
|
|
validators. Returns false if a transfer failed. If the window has<br>
|
|
wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will<br>
|
|
also call <a href="#wxSDLPanel-TransferDataFromWindow">TransferDataFromWindow</a>() of all child windows.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-TransferDataToWindow"><strong>TransferDataToWindow</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-TransferDataToWindow">TransferDataToWindow</a>(self) -> bool<br>
|
|
<br>
|
|
Transfers values to child controls from data areas specified by their<br>
|
|
validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra<br>
|
|
style flag set, the method will also call <a href="#wxSDLPanel-TransferDataToWindow">TransferDataToWindow</a>() of<br>
|
|
all child windows.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-UnregisterHotKey"><strong>UnregisterHotKey</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-UnregisterHotKey">UnregisterHotKey</a>(self, int hotkeyId) -> bool<br>
|
|
<br>
|
|
Unregisters a system wide hotkey.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Update"><strong>Update</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Update">Update</a>(self)<br>
|
|
<br>
|
|
Calling this method immediately repaints the invalidated area of the<br>
|
|
window instead of waiting for the EVT_PAINT event to happen, (normally<br>
|
|
this would usually only happen when the flow of control returns to the<br>
|
|
event loop.) Notice that this function doesn't refresh the window and<br>
|
|
does nothing if the window has been already repainted. Use `Refresh`<br>
|
|
first if you want to immediately redraw the window (or some portion of<br>
|
|
it) unconditionally.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-UpdateWindowUI"><strong>UpdateWindowUI</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-UpdateWindowUI">UpdateWindowUI</a>(self, long flags=UPDATE_UI_NONE)<br>
|
|
<br>
|
|
This function sends EVT_UPDATE_UI events to the window. The particular<br>
|
|
implementation depends on the window; for example a wx.ToolBar will<br>
|
|
send an update UI event for each toolbar button, and a wx.Frame will<br>
|
|
send an update UI event for each menubar menu item. You can call this<br>
|
|
function from your application to ensure that your UI is up-to-date at<br>
|
|
a particular point in time (as far as your EVT_UPDATE_UI handlers are<br>
|
|
concerned). This may be necessary if you have called<br>
|
|
`wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to<br>
|
|
limit the overhead that wxWindows incurs by sending update UI events<br>
|
|
in idle time.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-UseBgCol"><strong>UseBgCol</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-UseBgCol">UseBgCol</a>(self) -> bool</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Validate"><strong>Validate</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Validate">Validate</a>(self) -> bool<br>
|
|
<br>
|
|
Validates the current values of the child controls using their<br>
|
|
validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra<br>
|
|
style flag set, the method will also call <a href="#wxSDLPanel-Validate">Validate</a>() of all child<br>
|
|
windows. Returns false if any of the validations failed.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-WarpPointer"><strong>WarpPointer</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-WarpPointer">WarpPointer</a>(self, int x, int y)<br>
|
|
<br>
|
|
Moves the pointer to the given position on the window.<br>
|
|
<br>
|
|
NOTE: This function is not supported under Mac because Apple Human<br>
|
|
Interface Guidelines forbid moving the mouse cursor programmatically.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Static methods inherited from <a href="wx._core.html#Window">wx._core.Window</a>:<br>
|
|
<dl><dt><a name="wxSDLPanel-FindFocus"><strong>FindFocus</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-FindFocus">FindFocus</a>() -> Window<br>
|
|
<br>
|
|
Returns the window or control that currently has the keyboard focus,<br>
|
|
or None.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetCapture"><strong>GetCapture</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetCapture">GetCapture</a>() -> Window<br>
|
|
<br>
|
|
Returns the window which currently captures the mouse or None</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-NewControlId"><strong>NewControlId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-NewControlId">NewControlId</a>() -> int<br>
|
|
<br>
|
|
Generate a control id for the controls which were not given one.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-NextControlId"><strong>NextControlId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-NextControlId">NextControlId</a>(int winid) -> int<br>
|
|
<br>
|
|
Get the id of the control following the one with the given<br>
|
|
autogenerated) id</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-PrevControlId"><strong>PrevControlId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-PrevControlId">PrevControlId</a>(int winid) -> int<br>
|
|
<br>
|
|
Get the id of the control preceding the one with the given<br>
|
|
autogenerated) id</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="wx._core.html#Window">wx._core.Window</a>:<br>
|
|
<dl><dt><strong>AcceleratorTable</strong></dt>
|
|
<dd><tt>See `GetAcceleratorTable` and `SetAcceleratorTable`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>AutoLayout</strong></dt>
|
|
<dd><tt>See `GetAutoLayout` and `SetAutoLayout`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>BackgroundColour</strong></dt>
|
|
<dd><tt>See `GetBackgroundColour` and `SetBackgroundColour`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>BackgroundStyle</strong></dt>
|
|
<dd><tt>See `GetBackgroundStyle` and `SetBackgroundStyle`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>BestSize</strong></dt>
|
|
<dd><tt>See `GetBestSize`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>BestVirtualSize</strong></dt>
|
|
<dd><tt>See `GetBestVirtualSize`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Border</strong></dt>
|
|
<dd><tt>See `GetBorder`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Caret</strong></dt>
|
|
<dd><tt>See `GetCaret` and `SetCaret`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>CharHeight</strong></dt>
|
|
<dd><tt>See `GetCharHeight`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>CharWidth</strong></dt>
|
|
<dd><tt>See `GetCharWidth`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Children</strong></dt>
|
|
<dd><tt>See `GetChildren`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>ClientAreaOrigin</strong></dt>
|
|
<dd><tt>See `GetClientAreaOrigin`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>ClientRect</strong></dt>
|
|
<dd><tt>See `GetClientRect` and `SetClientRect`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>ClientSize</strong></dt>
|
|
<dd><tt>See `GetClientSize` and `SetClientSize`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Constraints</strong></dt>
|
|
<dd><tt>See `GetConstraints` and `SetConstraints`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>ContainingSizer</strong></dt>
|
|
<dd><tt>See `GetContainingSizer` and `SetContainingSizer`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Cursor</strong></dt>
|
|
<dd><tt>See `GetCursor` and `SetCursor`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>DefaultAttributes</strong></dt>
|
|
<dd><tt>See `GetDefaultAttributes`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>DropTarget</strong></dt>
|
|
<dd><tt>See `GetDropTarget` and `SetDropTarget`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>EffectiveMinSize</strong></dt>
|
|
<dd><tt>See `GetEffectiveMinSize`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Enabled</strong></dt>
|
|
<dd><tt>See `IsEnabled` and `Enable`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>EventHandler</strong></dt>
|
|
<dd><tt>See `GetEventHandler` and `SetEventHandler`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>ExtraStyle</strong></dt>
|
|
<dd><tt>See `GetExtraStyle` and `SetExtraStyle`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Font</strong></dt>
|
|
<dd><tt>See `GetFont` and `SetFont`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>ForegroundColour</strong></dt>
|
|
<dd><tt>See `GetForegroundColour` and `SetForegroundColour`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>GrandParent</strong></dt>
|
|
<dd><tt>See `GetGrandParent`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>GtkWidget</strong></dt>
|
|
<dd><tt>GetGtkWidget(self) -> long<br>
|
|
<br>
|
|
On wxGTK returns a pointer to the GtkWidget for this window as a long<br>
|
|
integer. On the other platforms this method returns zero.</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Handle</strong></dt>
|
|
<dd><tt>See `GetHandle`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>HelpText</strong></dt>
|
|
<dd><tt>See `GetHelpText` and `SetHelpText`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Id</strong></dt>
|
|
<dd><tt>See `GetId` and `SetId`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Label</strong></dt>
|
|
<dd><tt>See `GetLabel` and `SetLabel`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>LayoutDirection</strong></dt>
|
|
<dd><tt>See `GetLayoutDirection` and `SetLayoutDirection`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>MaxHeight</strong></dt>
|
|
<dd><tt>See `GetMaxHeight`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>MaxSize</strong></dt>
|
|
<dd><tt>See `GetMaxSize` and `SetMaxSize`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>MaxWidth</strong></dt>
|
|
<dd><tt>See `GetMaxWidth`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>MinHeight</strong></dt>
|
|
<dd><tt>See `GetMinHeight`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>MinSize</strong></dt>
|
|
<dd><tt>See `GetMinSize` and `SetMinSize`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>MinWidth</strong></dt>
|
|
<dd><tt>See `GetMinWidth`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Name</strong></dt>
|
|
<dd><tt>See `GetName` and `SetName`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Parent</strong></dt>
|
|
<dd><tt>See `GetParent`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Position</strong></dt>
|
|
<dd><tt>See `GetPosition` and `SetPosition`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Rect</strong></dt>
|
|
<dd><tt>See `GetRect` and `SetRect`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>ScreenPosition</strong></dt>
|
|
<dd><tt>See `GetScreenPosition`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>ScreenRect</strong></dt>
|
|
<dd><tt>See `GetScreenRect`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Shown</strong></dt>
|
|
<dd><tt>See `IsShown` and `Show`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Size</strong></dt>
|
|
<dd><tt>See `GetSize` and `SetSize`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Sizer</strong></dt>
|
|
<dd><tt>See `GetSizer` and `SetSizer`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>ThemeEnabled</strong></dt>
|
|
<dd><tt>See `GetThemeEnabled` and `SetThemeEnabled`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>ToolTip</strong></dt>
|
|
<dd><tt>See `GetToolTip` and `SetToolTip`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>TopLevel</strong></dt>
|
|
<dd><tt>See `IsTopLevel`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>TopLevelParent</strong></dt>
|
|
<dd><tt>See `GetTopLevelParent`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>UpdateClientRect</strong></dt>
|
|
<dd><tt>See `GetUpdateClientRect`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>UpdateRegion</strong></dt>
|
|
<dd><tt>See `GetUpdateRegion`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>Validator</strong></dt>
|
|
<dd><tt>See `GetValidator` and `SetValidator`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>VirtualSize</strong></dt>
|
|
<dd><tt>See `GetVirtualSize` and `SetVirtualSize`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>WindowStyle</strong></dt>
|
|
<dd><tt>See `GetWindowStyle` and `SetWindowStyle`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>WindowStyleFlag</strong></dt>
|
|
<dd><tt>See `GetWindowStyleFlag` and `SetWindowStyleFlag`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>WindowVariant</strong></dt>
|
|
<dd><tt>See `GetWindowVariant` and `SetWindowVariant`</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods inherited from <a href="wx._core.html#EvtHandler">wx._core.EvtHandler</a>:<br>
|
|
<dl><dt><a name="wxSDLPanel-AddPendingEvent"><strong>AddPendingEvent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-AddPendingEvent">AddPendingEvent</a>(self, Event event)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Bind"><strong>Bind</strong></a>(self, event, handler, source<font color="#909090">=None</font>, id<font color="#909090">=-1</font>, id2<font color="#909090">=-1</font>)</dt><dd><tt>Bind an event to an event handler.<br>
|
|
<br>
|
|
:param event: One of the EVT_* objects that specifies the<br>
|
|
type of event to bind,<br>
|
|
<br>
|
|
:param handler: A callable object to be invoked when the<br>
|
|
event is delivered to self. Pass None to<br>
|
|
disconnect an event handler.<br>
|
|
<br>
|
|
:param source: Sometimes the event originates from a<br>
|
|
different window than self, but you still<br>
|
|
want to catch it in self. (For example, a<br>
|
|
button event delivered to a frame.) By<br>
|
|
passing the source of the event, the event<br>
|
|
handling system is able to differentiate<br>
|
|
between the same event type from different<br>
|
|
controls.<br>
|
|
<br>
|
|
:param id: Used to spcify the event source by ID instead<br>
|
|
of instance.<br>
|
|
<br>
|
|
:param id2: Used when it is desirable to bind a handler<br>
|
|
to a range of IDs, such as with EVT_MENU_RANGE.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Connect"><strong>Connect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Connect">Connect</a>(self, int id, int lastId, int eventType, PyObject func)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Disconnect"><strong>Disconnect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-Disconnect">Disconnect</a>(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetEvtHandlerEnabled"><strong>GetEvtHandlerEnabled</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetEvtHandlerEnabled">GetEvtHandlerEnabled</a>(self) -> bool</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetNextHandler"><strong>GetNextHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetNextHandler">GetNextHandler</a>(self) -> EvtHandler</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-GetPreviousHandler"><strong>GetPreviousHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetPreviousHandler">GetPreviousHandler</a>(self) -> EvtHandler</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ProcessEvent"><strong>ProcessEvent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ProcessEvent">ProcessEvent</a>(self, Event event) -> bool</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-ProcessPendingEvents"><strong>ProcessPendingEvents</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-ProcessPendingEvents">ProcessPendingEvents</a>(self)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetEvtHandlerEnabled"><strong>SetEvtHandlerEnabled</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetEvtHandlerEnabled">SetEvtHandlerEnabled</a>(self, bool enabled)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetNextHandler"><strong>SetNextHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetNextHandler">SetNextHandler</a>(self, EvtHandler handler)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-SetPreviousHandler"><strong>SetPreviousHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-SetPreviousHandler">SetPreviousHandler</a>(self, EvtHandler handler)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-Unbind"><strong>Unbind</strong></a>(self, event, source<font color="#909090">=None</font>, id<font color="#909090">=-1</font>, id2<font color="#909090">=-1</font>)</dt><dd><tt>Disconencts the event handler binding for event from self.<br>
|
|
Returns True if successful.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="wx._core.html#EvtHandler">wx._core.EvtHandler</a>:<br>
|
|
<dl><dt><strong>EvtHandlerEnabled</strong></dt>
|
|
<dd><tt>See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>NextHandler</strong></dt>
|
|
<dd><tt>See `GetNextHandler` and `SetNextHandler`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>PreviousHandler</strong></dt>
|
|
<dd><tt>See `GetPreviousHandler` and `SetPreviousHandler`</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods inherited from <a href="wx._core.html#Object">wx._core.Object</a>:<br>
|
|
<dl><dt><a name="wxSDLPanel-GetClassName"><strong>GetClassName</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-GetClassName">GetClassName</a>(self) -> String<br>
|
|
<br>
|
|
Returns the class name of the C++ class using wxRTTI.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="wxSDLPanel-IsSameAs"><strong>IsSameAs</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#wxSDLPanel-IsSameAs">IsSameAs</a>(self, Object p) -> bool<br>
|
|
<br>
|
|
For wx.Objects that use C++ reference counting internally, this method<br>
|
|
can be used to determine if two objects are referencing the same data<br>
|
|
object.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="wx._core.html#Object">wx._core.Object</a>:<br>
|
|
<dl><dt><strong>ClassName</strong></dt>
|
|
<dd><tt>See `GetClassName`</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
</td></tr></table></td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#55aa55">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
|
<td width="100%"><strong>__author__</strong> = 'Stefan Blanke (greenarrow) (greenarrow@users.sourceforge.net)'<br>
|
|
<strong>__credits__</strong> = 'Daniel Keep for his wx BufferedCanvas that showed me how to make a pyGame wx canvas'<br>
|
|
<strong>__licence__</strong> = '<font color="#c040c0">\n</font>pyRepRap is free software: you can redistribute...ap. If not, see <http://www.gnu.org/licenses/>.<font color="#c040c0">\n</font>'<br>
|
|
<strong>__license__</strong> = 'GPL 3.0'</td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#7799ee">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
|
|
<td width="100%">Stefan Blanke (greenarrow) (greenarrow@users.sourceforge.net)</td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#7799ee">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Credits</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
|
|
<td width="100%">Daniel Keep for his wx BufferedCanvas that showed me how to make a pyGame wx canvas</td></tr></table>
|
|
</body></html> |