self.thisown = 1
del newobj.thisown
def GetFloor(*args, **kwargs):
- """GetFloor() -> (x,y)"""
+ """
+ GetFloor() -> (x,y)
+
+ Convert to integer
+ """
return _core_.Point2D_GetFloor(*args, **kwargs)
def GetRounded(*args, **kwargs):
- """GetRounded() -> (x,y)"""
+ """
+ GetRounded() -> (x,y)
+
+ Convert to integer
+ """
return _core_.Point2D_GetRounded(*args, **kwargs)
def GetVectorLength(*args, **kwargs):
MakeKey = staticmethod(MakeKey)
def FindFirstUnusedColour(*args, **kwargs):
- """FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)"""
+ """
+ FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
+
+ Find first colour that is not used in the image and has higher RGB
+ values than startR, startG, startB. Returns a tuple consisting of a
+ success flag and rgb values.
+ """
return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
return _core_.Image_HasAlpha(*args, **kwargs)
def FindFirstUnusedColour(*args, **kwargs):
- """FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)"""
+ """
+ FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
+
+ Find first colour that is not used in the image and has higher RGB
+ values than startR, startG, startB. Returns a tuple consisting of a
+ success flag and rgb values.
+ """
return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
def SetMaskFromImage(*args, **kwargs):
"""
return _core_.Window_MoveXY(*args, **kwargs)
+ def SetBestFittingSize(*args, **kwargs):
+ """
+ SetBestFittingSize(self, Size size=DefaultSize)
+
+ A 'Smart' SetSize that will fill in default size components with the
+ window's *best size* values. Also set's the minsize for use with sizers.
+ """
+ return _core_.Window_SetBestFittingSize(*args, **kwargs)
+
def Raise(*args, **kwargs):
"""
Raise(self)
"""
return _core_.Window_GetBestSizeTuple(*args, **kwargs)
+ def InvalidateBestSize(*args, **kwargs):
+ """
+ InvalidateBestSize(self)
+
+ Reset the cached best size value so it will be recalculated the next
+ time it is needed.
+ """
+ return _core_.Window_InvalidateBestSize(*args, **kwargs)
+
+ def GetBestFittingSize(*args, **kwargs):
+ """
+ GetBestFittingSize(self) -> Size
+
+ This function will merge the window's best size into the window's
+ minimum size, giving priority to the min size components, and returns
+ the results.
+
+ """
+ return _core_.Window_GetBestFittingSize(*args, **kwargs)
+
def GetAdjustedBestSize(*args, **kwargs):
"""
GetAdjustedBestSize(self) -> Size
"""
Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
- :param flags: A combination of the ``IsForward`` and ``WinChange``
- values in the `wx.NavigationKeyEvent` class, which
- determine if the navigation should be in forward or
- reverse order, and if it should be able to cross
- parent window boundaries, such as between notebook
- pages or MDI child frames. Typically the status of
- the Shift key (for forward or reverse) or the
- Control key (for WinChange) would be used to
- determine how to set the flags.
-
- situation in which you may wish to call this method is from a text
- rol custom keypress handler to do the default navigation behaviour
- the tab key, since the standard default behaviour for a multiline
- control with the wx.TE_PROCESS_TAB style is to insert a tab and
- navigate to the next control.
+ Does keyboard navigation from this window to another, by sending a
+ `wx.NavigationKeyEvent`.
"""
return _core_.Window_Navigate(*args, **kwargs)
Sets the background colour of the window. Returns True if the colour
was changed. The background colour is usually painted by the default
EVT_ERASE_BACKGROUND event handler function under Windows and
- automatically under GTK.
+ automatically under GTK. Using `wx.NullColour` will reset the window
+ to the default background colour.
Note that setting the background colour may not cause an immediate
- refresh, so you may wish to call ClearBackground or Refresh after
+ refresh, so you may wish to call `ClearBackground` or `Refresh` after
calling this function.
- Use this function with care under GTK+ as the new appearance of the
- window might not look equally well when used with themes, i.e GTK+'s
- ability to change its look as the user wishes with run-time loadable
- modules.
+ Using this function will disable attempts to use themes for this
+ window, if the system supports them. Use with care since usually the
+ themes represent the appearance chosen by the user to be used for all
+ applications on the system.
"""
return _core_.Window_SetBackgroundColour(*args, **kwargs)
return _core_.Window_GetCharWidth(*args, **kwargs)
def GetTextExtent(*args, **kwargs):
- """GetTextExtent(String string) -> (width, height)"""
+ """
+ GetTextExtent(String string) -> (width, height)
+
+ Get the width and height of the text using the current font.
+ """
return _core_.Window_GetTextExtent(*args, **kwargs)
def GetFullTextExtent(*args, **kwargs):
return _core_.Control_SetLabel(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
+ """
+ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def Control_GetClassDefaultAttributes(*args, **kwargs):
- """Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
+ """
+ Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+ Get the default attributes for this class. This is useful if you want
+ to use the same font or colour in your own control as in a standard
+ control -- which is a much better idea than hard coding specific
+ colours or fonts which might look completely out of place on the
+ user's system, especially if it uses themes.
+
+ The variant parameter is only relevant under Mac currently and is
+ ignore under other platforms. Under Mac, it will change the size of
+ the returned font. See `wx.Window.SetWindowVariant` for more about
+ this.
+ """
return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
"""
return _core_.SizerItem_GetMinSize(*args, **kwargs)
+ def GetMinSizeWithBorder(*args, **kwargs):
+ """
+ GetMinSizeWithBorder(self) -> Size
+
+ Get the minimum size needed for the item with space for the borders
+ added, if needed.
+ """
+ return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
+
def SetInitSize(*args, **kwargs):
"""SetInitSize(self, int x, int y)"""
return _core_.SizerItem_SetInitSize(*args, **kwargs)
return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
def GetRowHeights(*args, **kwargs):
- """GetRowHeights(self) -> list"""
+ """
+ GetRowHeights(self) -> list
+
+ Returns a list of integers representing the heights of each of the
+ rows in the sizer.
+ """
return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
def GetColWidths(*args, **kwargs):
- """GetColWidths(self) -> list"""
+ """
+ GetColWidths(self) -> list
+
+ Returns a list of integers representing the widths of each of the
+ columns in the sizer.
+ """
return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
:see: `wx.FutureCall`
"""
app = wx.GetApp()
- assert app, 'No wxApp created yet'
+ assert app is not None, 'No wx.App created yet'
global _wxPyCallAfterId
if _wxPyCallAfterId is None:
projects / wxWidgets.git / blobdiff