X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/248ed9435a7aa3454bbeed1156bc4302581f99a2..f454e36230616babf19866effc05765e5b00e64a:/wxPython/src/msw/_core.py diff --git a/wxPython/src/msw/_core.py b/wxPython/src/msw/_core.py index da20c4e590..dd021fce57 100644 --- a/wxPython/src/msw/_core.py +++ b/wxPython/src/msw/_core.py @@ -1322,11 +1322,19 @@ class Point2D(object): 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): @@ -1950,7 +1958,13 @@ class ImageHistogram(object): 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) @@ -2037,7 +2051,13 @@ class Image(Object): 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): @@ -4251,7 +4271,7 @@ class NavigationKeyEvent(Event): return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs) def SetDirection(*args, **kwargs): - """SetDirection(self, bool bForward)""" + """SetDirection(self, bool forward)""" return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs) def IsWindowChange(*args, **kwargs): @@ -4259,9 +4279,13 @@ class NavigationKeyEvent(Event): return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs) def SetWindowChange(*args, **kwargs): - """SetWindowChange(self, bool bIs)""" + """SetWindowChange(self, bool ischange)""" return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs) + def SetFlags(*args, **kwargs): + """SetFlags(self, long flags)""" + return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs) + def GetCurrentFocus(*args, **kwargs): """GetCurrentFocus(self) -> Window""" return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs) @@ -4270,6 +4294,8 @@ class NavigationKeyEvent(Event): """SetCurrentFocus(self, Window win)""" return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs) + IsForward = _core_.NavigationKeyEvent_IsForward + WinChange = _core_.NavigationKeyEvent_WinChange class NavigationKeyEventPtr(NavigationKeyEvent): def __init__(self, this): @@ -5645,6 +5671,15 @@ class Window(EvtHandler): """ 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) @@ -5803,6 +5838,26 @@ class Window(EvtHandler): """ 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 @@ -5876,22 +5931,25 @@ class Window(EvtHandler): def SetSizeHints(*args): """ + SetSizeHints(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize) SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1) - SetSizeHints(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize) Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user - will not be able to size the window outside the given bounds. The - resizing increments are only significant under Motif or Xt. + will not be able to size the window outside the given bounds (if it is + a top-level window.) Sizers will also inspect the minimum window size + and will use that value if set when calculating layout. + + The resizing increments are only significant under Motif or Xt. """ return _core_.Window_SetSizeHints(*args) def SetVirtualSizeHints(*args): """ - SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1) SetVirtualSizeHints(self, Size minSize, Size maxSize=DefaultSize) + SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1) Allows specification of minimum and maximum virtual window sizes. If a pair of values is not set (or set to -1), the default values will be @@ -5900,6 +5958,32 @@ class Window(EvtHandler): """ return _core_.Window_SetVirtualSizeHints(*args) + def GetMaxSize(*args, **kwargs): + """GetMaxSize(self) -> Size""" + return _core_.Window_GetMaxSize(*args, **kwargs) + + def GetMinSize(*args, **kwargs): + """GetMinSize(self) -> Size""" + return _core_.Window_GetMinSize(*args, **kwargs) + + def SetMinSize(*args, **kwargs): + """ + SetMinSize(self, Size minSize) + + A more convenient method than `SetSizeHints` for setting just the + min size. + """ + return _core_.Window_SetMinSize(*args, **kwargs) + + def SetMaxSize(*args, **kwargs): + """ + SetMaxSize(self, Size maxSize) + + A more convenient method than `SetSizeHints` for setting just the + max size. + """ + return _core_.Window_SetMaxSize(*args, **kwargs) + def GetMinWidth(*args, **kwargs): """GetMinWidth(self) -> int""" return _core_.Window_GetMinWidth(*args, **kwargs) @@ -5916,14 +6000,6 @@ class Window(EvtHandler): """GetMaxHeight(self) -> int""" return _core_.Window_GetMaxHeight(*args, **kwargs) - def GetMaxSize(*args, **kwargs): - """GetMaxSize(self) -> Size""" - return _core_.Window_GetMaxSize(*args, **kwargs) - - def GetMinSize(*args, **kwargs): - """GetMinSize(self) -> Size""" - return _core_.Window_GetMinSize(*args, **kwargs) - def SetVirtualSize(*args, **kwargs): """ SetVirtualSize(self, Size size) @@ -6189,6 +6265,15 @@ class Window(EvtHandler): """ return _core_.Window_SetTmpDefaultItem(*args, **kwargs) + def Navigate(*args, **kwargs): + """ + Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool + + Does keyboard navigation from this window to another, by sending a + `wx.NavigationKeyEvent`. + """ + return _core_.Window_Navigate(*args, **kwargs) + def GetChildren(*args, **kwargs): """ GetChildren(self) -> PyObject @@ -6716,16 +6801,17 @@ class Window(EvtHandler): 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) @@ -6839,7 +6925,11 @@ class Window(EvtHandler): 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): @@ -6928,23 +7018,25 @@ class Window(EvtHandler): def PopupMenuXY(*args, **kwargs): """ - PopupMenuXY(self, Menu menu, int x, int y) -> bool + PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool - Pops up the given menu at the specified coordinates, relative to this - window, and returns control when the user has dismissed the menu. If a - menu item is selected, the corresponding menu event is generated and - will be processed as usual. + Pops up the given menu at the specified coordinates, relative to this window, + and returns control when the user has dismissed the menu. If a menu item is + selected, the corresponding menu event is generated and will be processed as + usual. If the default position is given then the current position of the + mouse cursor will be used. """ return _core_.Window_PopupMenuXY(*args, **kwargs) def PopupMenu(*args, **kwargs): """ - PopupMenu(self, Menu menu, Point pos) -> bool + PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool - Pops up the given menu at the specified coordinates, relative to this - window, and returns control when the user has dismissed the menu. If a - menu item is selected, the corresponding menu event is generated and - will be processed as usual. + Pops up the given menu at the specified coordinates, relative to this window, + and returns control when the user has dismissed the menu. If a menu item is + selected, the corresponding menu event is generated and will be processed as + usual. If the default position is given then the current position of the + mouse cursor will be used. """ return _core_.Window_PopupMenu(*args, **kwargs) @@ -8502,6 +8594,15 @@ class SizerItem(Object): """ 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) @@ -9527,11 +9628,21 @@ class FlexGridSizer(GridSizer): 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) @@ -10402,7 +10513,7 @@ def CallAfter(callable, *args, **kw): :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: