class Size(object):
"""
- wx.Size is a useful data structure used to represent the size of something.
- It simply contians integer width and height proprtites. In most places in
- wxPython where a wx.Size is expected a (width,height) tuple can be used
- instead.
+ wx.Size is a useful data structure used to represent the size of
+ something. It simply contians integer width and height proprtites.
+ In most places in wxPython where a wx.Size is expected a
+ (width,height) tuple can be used instead.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""
SetDefaults(self, Size size)
- Combine this size with the other one replacing the default
- components of this object (i.e. equal to -1) with those of the
- other.
+ Combine this size with the other one replacing the default components
+ of this object (i.e. equal to -1) with those of the other.
"""
return _core_.Size_SetDefaults(*args, **kwargs)
"""
return _core_.Size_Get(*args, **kwargs)
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.Size'+str(self.Get())
def __len__(self): return len(self.Get())
class RealPoint(object):
"""
- A data structure for representing a point or position with floating point x
- and y properties. In wxPython most places that expect a wx.RealPoint can also
- accept a (x,y) tuple.
+ A data structure for representing a point or position with floating
+ point x and y properties. In wxPython most places that expect a
+ wx.RealPoint can also accept a (x,y) tuple.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""
return _core_.RealPoint_Get(*args, **kwargs)
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.RealPoint'+str(self.Get())
def __len__(self): return len(self.Get())
class Point(object):
"""
- A data structure for representing a point or position with integer x and y
- properties. Most places in wxPython that expect a wx.Point can also accept a
- (x,y) tuple.
+ A data structure for representing a point or position with integer x
+ and y properties. Most places in wxPython that expect a wx.Point can
+ also accept a (x,y) tuple.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""
return _core_.Point_Get(*args, **kwargs)
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.Point'+str(self.Get())
def __len__(self): return len(self.Get())
class Rect(object):
"""
- A class for representing and manipulating rectangles. It has x, y, width and
- height properties. In wxPython most palces that expect a wx.Rect can also
- accept a (x,y,width,height) tuple.
+ A class for representing and manipulating rectangles. It has x, y,
+ width and height properties. In wxPython most palces that expect a
+ wx.Rect can also accept a (x,y,width,height) tuple.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""
Inflate(self, int dx, int dy) -> Rect
- Increase the rectangle size by dx in x direction and dy in y direction. Both
- (or one of) parameters may be negative to decrease the rectangle size.
+ Increase the rectangle size by dx in x direction and dy in y
+ direction. Both or one of) parameters may be negative to decrease the
+ rectangle size.
"""
return _core_.Rect_Inflate(*args, **kwargs)
"""
Deflate(self, int dx, int dy) -> Rect
- Decrease the rectangle size by dx in x direction and dy in y direction. Both
- (or one of) parameters may be negative to increase the rectngle size. This
- method is the opposite of Inflate.
+ Decrease the rectangle size by dx in x direction and dy in y
+ direction. Both or one of) parameters may be negative to increase the
+ rectngle size. This method is the opposite of Inflate.
"""
return _core_.Rect_Deflate(*args, **kwargs)
"""
OffsetXY(self, int dx, int dy)
- Moves the rectangle by the specified offset. If dx is positive, the rectangle
- is moved to the right, if dy is positive, it is moved to the bottom, otherwise
- it is moved to the left or top respectively.
+ Moves the rectangle by the specified offset. If dx is positive, the
+ rectangle is moved to the right, if dy is positive, it is moved to the
+ bottom, otherwise it is moved to the left or top respectively.
"""
return _core_.Rect_OffsetXY(*args, **kwargs)
"""
return _core_.Rect_Get(*args, **kwargs)
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.Rect'+str(self.Get())
def __len__(self): return len(self.Get())
#---------------------------------------------------------------------------
class Point2D(object):
- """wx.Point2Ds represent a point or a vector in a 2d coordinate system with floating point values."""
+ """
+ wx.Point2Ds represent a point or a vector in a 2d coordinate system
+ with floating point values.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
self.thisown = 1
del newobj.thisown
def GetFloor(*args, **kwargs):
- """
- GetFloor() -> (x,y)
-
- Convert to integer
- """
+ """GetFloor() -> (x,y)"""
return _core_.Point2D_GetFloor(*args, **kwargs)
def GetRounded(*args, **kwargs):
- """
- GetRounded() -> (x,y)
-
- Convert to integer
- """
+ """GetRounded() -> (x,y)"""
return _core_.Point2D_GetRounded(*args, **kwargs)
def GetVectorLength(*args, **kwargs):
"""
return _core_.Point2D_Get(*args, **kwargs)
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.Point2D'+str(self.Get())
def __len__(self): return len(self.Get())
MakeKey = staticmethod(MakeKey)
def FindFirstUnusedColour(*args, **kwargs):
- """
- 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.
- """
+ """FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)"""
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)
-
- 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.
- """
+ """FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)"""
return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
def SetMaskFromImage(*args, **kwargs):
"""Image_GetImageExtWildcard() -> String"""
return _core_.Image_GetImageExtWildcard(*args, **kwargs)
+def InitAllImageHandlers():
+ """
+ The former functionality of InitAllImageHanders is now done internal to
+ the _core_ extension module and so this function has become a simple NOP.
+ """
+ pass
-def InitAllImageHandlers(*args, **kwargs):
- """InitAllImageHandlers()"""
- return _core_.InitAllImageHandlers(*args, **kwargs)
IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
BMP_24BPP = _core_.BMP_24BPP
"""
Bind an event to an event handler.
- event One of the EVT_* objects that specifies the
- type of event to bind,
+ :param event: One of the EVT_* objects that specifies the
+ type of event to bind,
- handler A callable object to be invoked when the event
- is delivered to self. Pass None to disconnect an
- event handler.
+ :param handler: A callable object to be invoked when the
+ event is delivered to self. Pass None to
+ disconnect an event handler.
- source Sometimes the event originates from a different window
- than self, but you still want to catch it in self. (For
- example, a button event delivered to a frame.) By
- passing the source of the event, the event handling
- system is able to differentiate between the same event
- type from different controls.
+ :param source: Sometimes the event originates from a
+ different window than self, but you still
+ want to catch it in self. (For example, a
+ button event delivered to a frame.) By
+ passing the source of the event, the event
+ handling system is able to differentiate
+ between the same event type from different
+ controls.
- id,id2 Used for menu IDs or for event types that require a
- range of IDs
+ :param id: Used to spcify the event source by ID instead
+ of instance.
+
+ :param id2: Used when it is desirable to bind a handler
+ to a range of IDs, such as with EVT_MENU_RANGE.
"""
if source is not None:
id = source.GetId()
"""
GetPosition(self) -> Point
- Returns the position of the mouse in window coordinates when the event happened.
+ Returns the position of the mouse in window coordinates when the event
+ happened.
"""
return _core_.MouseEvent_GetPosition(*args, **kwargs)
"""
GetPositionTuple() -> (x,y)
- Returns the position of the mouse in window coordinates when the event happened.
+ Returns the position of the mouse in window coordinates when the event
+ happened.
"""
return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
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):
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)
"""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):
recursively unless the value of ``onlyIfNeeded`` is True.
:warning: This function is dangerous as it can lead to unexpected
- reentrancies (i.e. when called from an event handler it may
- result in calling the same event handler again), use with
- _extreme_ care or, better, don't use at all!
+ reentrancies (i.e. when called from an event handler it may
+ result in calling the same event handler again), use with
+ extreme care or, better, don't use at all!
:see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
+
"""
return _core_.PyApp_Yield(*args, **kwargs)
"""
SetAssertMode(self, int mode)
- Set the OnAssert behaviour for debug and hybrid builds. The following
- flags may be or'd together:
-
- ========================= =======================================
- wx.PYAPP_ASSERT_SUPPRESS Don't do anything
- wx.PYAPP_ASSERT_EXCEPTION Turn it into a Python exception if possible
- (default)
- wx.PYAPP_ASSERT_DIALOG Display a message dialog
- wx.PYAPP_ASSERT_LOG Write the assertion info to the wx.Log
- ========================= =======================================
-
-
+ Set the OnAssert behaviour for debug and hybrid builds.
"""
return _core_.PyApp_SetAssertMode(*args, **kwargs)
"""
App_CleanUp()
- For internal use only, it is used to cleanup after wxWindows when
+ For internal use only, it is used to cleanup after wxWidgets when
Python shuts down.
"""
return _core_.App_CleanUp(*args, **kwargs)
``self.SetTopWindow(frame)``.
:see: `wx.PySimpleApp` for a simpler app class that can be used
- directly.
+ directly.
"""
outputWindowClass = PyOnDemandOutputWindow
not 'python', and only when you are logged in on the main display of
your Mac."""
_sys.exit(1)
+ except SystemExit:
+ raise
except:
pass
wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
def OnInit(self):
- wx.InitAllImageHandlers()
return True
A class used to define items in an `wx.AcceleratorTable`. wxPython
programs can choose to use wx.AcceleratorEntry objects, but using a
list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
- as well. See `__init__` for details of the tuple values.
+ as well. See `__init__` for of the tuple values.
:see: `wx.AcceleratorTable`
"""
__init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
Construct a wx.AcceleratorEntry.
-
- :param flags: A bitmask of wx.ACCEL_ALT, wx.ACCEL_SHIFT,
- wx.ACCEL_CTRL or wx.ACCEL_NORMAL used to specify
- which modifier keys are held down.
- :param keyCode: The keycode to be detected
- :param cmdID: The menu or control command ID to use for the
- accellerator event.
-
"""
newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
self.this = newobj.this
keyboard shortcuts for menus or other commands. On Windows, menu or
button commands are supported; on GTK, only menu commands are
supported.
-
- The object ``wx.NullAcceleratorTable`` is defined to be a table with
- no data, and is the initial accelerator table for a window.
-
- An accelerator takes precedence over normal processing and can be a
- convenient way to program some event handling. For example, you can
- use an accelerator table to make a hotkey generate an event no matter
- which window within a frame has the focus.
-
- Foe example::
-
- aTable = wx.AcceleratorTable([(wx.ACCEL_ALT, ord('X'), exitID),
- (wx.ACCEL_CTRL, ord('H'), helpID),
- (wx.ACCEL_CTRL, ord('F'), findID),
- (wx.ACCEL_NORMAL, wx.WXK_F3, findnextID)
- ])
- self.SetAcceleratorTable(aTable)
-
-
- :see: `wx.AcceleratorEntry`, `wx.Window.SetAcceleratorTable`
-
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
tries to close the window. It doesn't close the window itself,
however. If force is False (the default) then the window's close
handler will be allowed to veto the destruction of the window.
-
- Usually Close is only used with the top level windows (wx.Frame and
- wx.Dialog classes) as the others are not supposed to have any special
- EVT_CLOSE logic.
-
- The close handler should check whether the window is being deleted
- forcibly, using wx.CloseEvent.GetForce, in which case it should
- destroy the window using wx.Window.Destroy.
-
- Note that calling Close does not guarantee that the window will be
- destroyed; but it provides a way to simulate a manual close of a
- window, which may or may not be implemented by destroying the
- window. The default EVT_CLOSE handler for wx.Dialog does not
- necessarily delete the dialog, since it will simply simulate an
- wxID_CANCEL event which is handled by the appropriate button event
- handler and may do anything at all.
-
- To guarantee that the window will be destroyed, call wx.Window.Destroy
- instead.
"""
return _core_.Window_Close(*args, **kwargs)
"""
DestroyChildren(self) -> bool
- Destroys all children of a window. Called automatically by the destructor.
+ Destroys all children of a window. Called automatically by the
+ destructor.
"""
return _core_.Window_DestroyChildren(*args, **kwargs)
"""
GetLabel(self) -> String
- Generic way of getting a label from any window, for
- identification purposes. The interpretation of this function
- differs from class to class. For frames and dialogs, the value
- returned is the title. For buttons or static text controls, it is
- the button text. This function can be useful for meta-programs
- such as testing tools or special-needs access programs)which
- need to identify windows by name.
+ Generic way of getting a label from any window, for identification
+ purposes. The interpretation of this function differs from class to
+ class. For frames and dialogs, the value returned is the title. For
+ buttons or static text controls, it is the button text. This function
+ can be useful for meta-programs such as testing tools or special-needs
+ access programs)which need to identify windows by name.
"""
return _core_.Window_GetLabel(*args, **kwargs)
"""
SetName(self, String name)
- Sets the window's name. The window name is used for ressource
- setting in X, it is not the same as the window title/label
+ Sets the window's name. The window name is used for ressource setting
+ in X, it is not the same as the window title/label
"""
return _core_.Window_SetName(*args, **kwargs)
"""
GetName(self) -> String
- Returns the windows name. This name is not guaranteed to be
- unique; it is up to the programmer to supply an appropriate name
- in the window constructor or via wx.Window.SetName.
+ Returns the windows name. This name is not guaranteed to be unique;
+ it is up to the programmer to supply an appropriate name in the window
+ constructor or via wx.Window.SetName.
"""
return _core_.Window_GetName(*args, **kwargs)
"""
SetWindowVariant(self, int variant)
- Sets the variant of the window/font size to use for this window,
- if the platform supports variants, for example, wxMac. Variant values are:
-
- wx.WINDOW_VARIANT_NORMAL Normal size
- wx.WINDOW_VARIANT_SMALL Smaller size (about 25 % smaller than normal)
- wx.WINDOW_VARIANT_MINI Mini size (about 33 % smaller than normal)
- wx.WINDOW_VARIANT_LARGE Large size (about 25 % larger than normal)
-
+ Sets the variant of the window/font size to use for this window, if
+ the platform supports variants, for example, wxMac.
"""
return _core_.Window_SetWindowVariant(*args, **kwargs)
NextControlId(int winid) -> int
Get the id of the control following the one with the given
- (autogenerated) id
+ autogenerated) id
"""
return _core_.Window_NextControlId(*args, **kwargs)
PrevControlId(int winid) -> int
Get the id of the control preceding the one with the given
- (autogenerated) id
+ autogenerated) id
"""
return _core_.Window_PrevControlId(*args, **kwargs)
"""
GetClientRect(self) -> Rect
- Get the client area position and size as a wx.Rect object.
+ Get the client area position and size as a `wx.Rect` object.
"""
return _core_.Window_GetClientRect(*args, **kwargs)
"""
GetBestSize(self) -> Size
- This functions returns the best acceptable minimal size for the
- window, if applicable. For example, for a static text control, it will be
- the minimal size such that the control label is not truncated. For
- windows containing subwindows (suzh aswx.Panel), the size returned
- by this function will be the same as the size the window would have
- had after calling Fit.
+ This function returns the best acceptable minimal size for the
+ window, if applicable. For example, for a static text control, it will
+ be the minimal size such that the control label is not truncated. For
+ windows containing subwindows (suzh aswx.Panel), the size returned by
+ this function will be the same as the size the window would have had
+ after calling Fit.
"""
return _core_.Window_GetBestSize(*args, **kwargs)
"""
GetBestSizeTuple() -> (width, height)
- This functions returns the best acceptable minimal size for the
- window, if applicable. For example, for a static text control, it will be
- the minimal size such that the control label is not truncated. For
- windows containing subwindows (suzh aswx.Panel), the size returned
- by this function will be the same as the size the window would have
- had after calling Fit.
+ This function returns the best acceptable minimal size for the
+ window, if applicable. For example, for a static text control, it will
+ be the minimal size such that the control label is not truncated. For
+ windows containing subwindows (suzh aswx.Panel), the size returned by
+ this function will be the same as the size the window would have had
+ after calling Fit.
"""
return _core_.Window_GetBestSizeTuple(*args, **kwargs)
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
"""
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)
"""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)
"""
SetWindowStyleFlag(self, long style)
- Sets the style of the window. Please note that some styles cannot
- be changed after the window creation and that Refresh() might
- need to be called after changing the others for the change to
- take place immediately.
+ Sets the style of the window. Please note that some styles cannot be
+ changed after the window creation and that Refresh() might need to be
+ called after changing the others for the change to take place
+ immediately.
"""
return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
"""
return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
+ def Navigate(*args, **kwargs):
+ """
+ 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.
+ """
+ return _core_.Window_Navigate(*args, **kwargs)
+
def GetChildren(*args, **kwargs):
"""
GetChildren(self) -> PyObject
"""
GetGrandParent(self) -> Window
- Returns the parent of the parent of this window, or None if there isn't one.
+ Returns the parent of the parent of this window, or None if there
+ isn't one.
"""
return _core_.Window_GetGrandParent(*args, **kwargs)
substitute another, for example to allow central implementation of
event-handling for a variety of different window classes.
- It is usually better to use wx.Window.PushEventHandler since this sets
+ It is usually better to use `wx.Window.PushEventHandler` since this sets
up a chain of event handlers, where an event not handled by one event
handler is handed to the next one in the chain.
"""
wx.Window.PushEventHandler allows an application to set up a chain of
event handlers, where an event not handled by one event handler is
- handed to the next one in the chain. Use wx.Window.PopEventHandler to
+ handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
remove the event handler.
"""
return _core_.Window_PushEventHandler(*args, **kwargs)
"""
RemoveEventHandler(self, EvtHandler handler) -> bool
- Find the given handler in the event handler chain and remove (but
- not delete) it from the event handler chain, return True if it was
- found and False otherwise (this also results in an assert failure so
- this function should only be called when the handler is supposed to
- be there.)
+ Find the given handler in the event handler chain and remove (but not
+ delete) it from the event handler chain, return True if it was found
+ and False otherwise (this also results in an assert failure so this
+ function should only be called when the handler is supposed to be
+ there.)
"""
return _core_.Window_RemoveEventHandler(*args, **kwargs)
Validate(self) -> bool
Validates the current values of the child controls using their
- validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY
- extra style flag set, the method will also call Validate() of all
- child windows. Returns false if any of the validations failed.
+ validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
+ style flag set, the method will also call Validate() of all child
+ windows. Returns false if any of the validations failed.
"""
return _core_.Window_Validate(*args, **kwargs)
"""
TransferDataToWindow(self) -> bool
- Transfers values to child controls from data areas specified by
- their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY
- extra style flag set, the method will also call
- TransferDataToWindow() of all child windows.
+ Transfers values to child controls from data areas specified by their
+ validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
+ style flag set, the method will also call TransferDataToWindow() of
+ all child windows.
"""
return _core_.Window_TransferDataToWindow(*args, **kwargs)
"""
TransferDataFromWindow(self) -> bool
- Transfers values from child controls to data areas specified by
- their validators. Returns false if a transfer failed. If the
- window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the
- method will also call TransferDataFromWindow() of all child
- windows.
+ Transfers values from child controls to data areas specified by their
+ validators. Returns false if a transfer failed. If the window has
+ wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
+ also call TransferDataFromWindow() of all child windows.
"""
return _core_.Window_TransferDataFromWindow(*args, **kwargs)
"""
InitDialog(self)
- Sends an EVT_INIT_DIALOG event, whose handler usually transfers
- data to the dialog via validators.
+ Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
+ to the dialog via validators.
"""
return _core_.Window_InitDialog(*args, **kwargs)
"""
Freeze(self)
- Freezes the window or, in other words, prevents any updates from taking place
- on screen, the window is not redrawn at all. Thaw must be called to reenable
- window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw
- being delayed until all the nesting has been undone.
+ Freezes the window or, in other words, prevents any updates from
+ taking place on screen, the window is not redrawn at all. Thaw must be
+ called to reenable window redrawing. Calls to Freeze/Thaw may be
+ nested, with the actual Thaw being delayed until all the nesting has
+ been undone.
This method is useful for visual appearance optimization (for example,
it is a good idea to use it before inserting large amount of text into
Thaw(self)
Reenables window updating after a previous call to Freeze. Calls to
- Freeze/Thaw may be nested, so Thaw must be called the same number of times
- that Freeze was before the window will be updated.
+ Freeze/Thaw may be nested, so Thaw must be called the same number of
+ times that Freeze was before the window will be updated.
"""
return _core_.Window_Thaw(*args, **kwargs)
"""
GetDefaultAttributes(self) -> VisualAttributes
- Get the default attributes for an instance of this class. This
- is useful if you want to use the same font or colour in your own
- control as in a standard control -- which is a much better idea
- than hard coding specific colours or fonts which might look
- completely out of place on the users system, especially if it
- uses themes.
+ Get the default attributes for an instance of this class. This is
+ useful if you want to use the same font or colour in your own control
+ as in a standard control -- which is a much better idea than hard
+ coding specific colours or fonts which might look completely out of
+ place on the user's system, especially if it uses themes.
"""
return _core_.Window_GetDefaultAttributes(*args, **kwargs)
"""
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 users system, especially if it uses themes.
+ 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 SetWindowVariant for more about this.
+ 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_.Window_GetClassDefaultAttributes(*args, **kwargs)
EVT_ERASE_BACKGROUND event handler function under Windows and
automatically under GTK.
- Note that setting the background colour does not cause an immediate
+ Note that setting the background colour may not cause an immediate
refresh, so you may wish to call ClearBackground or Refresh after
calling this function.
return _core_.Window_GetCharWidth(*args, **kwargs)
def GetTextExtent(*args, **kwargs):
- """
- GetTextExtent(String string) -> (width, height)
-
- Get the width and height of the text using the current font.
- """
+ """GetTextExtent(String string) -> (width, height)"""
return _core_.Window_GetTextExtent(*args, **kwargs)
def GetFullTextExtent(*args, **kwargs):
wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
limit the overhead that wxWindows incurs by sending update UI events
in idle time.
-
- The flags should be a bitlist of one or more of the following values:
-
- wx.UPDATE_UI_NONE No particular value
- wx.UPDATE_UI_RECURSE Call the function for descendants
- wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
-
- If you are calling this function from an OnIdle function, make sure
- you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window to
- only update the UI elements that need to be updated in idle time. Some
- windows update their elements only when necessary, for example when a
- menu is about to be shown. The following is an example of how to call
- UpdateWindowUI from an idle function.
-
- def OnIdle(self, evt):
- if wx.UpdateUIEvent.CanUpdate(self):
- self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
-
"""
return _core_.Window_UpdateWindowUI(*args, **kwargs)
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)
def SetScrollbar(*args, **kwargs):
"""
- SetScrollbar(self, int orientation, int pos, int thumbvisible, int range,
+ SetScrollbar(self, int orientation, int position, int thumbSize, int range,
bool refresh=True)
Sets the scrollbar properties of a built-in scrollbar.
-
- orientation: Determines the scrollbar whose page size is to be
- set. May be wx.HORIZONTAL or wx.VERTICAL.
-
- position: The position of the scrollbar in scroll units.
-
- thumbSize: The size of the thumb, or visible portion of the
- scrollbar, in scroll units.
-
- range: The maximum position of the scrollbar.
-
- refresh: True to redraw the scrollbar, false otherwise.
"""
return _core_.Window_SetScrollbar(*args, **kwargs)
accordingly. Use this function to optimise your scrolling
implementations, to minimise the area that must be redrawn. Note that
it is rarely required to call this function from a user program.
-
- dx: Amount to scroll horizontally.
-
- dy: Amount to scroll vertically.
-
- rect: Rectangle to invalidate. If this is None, the whole window
- is invalidated. If you pass a rectangle corresponding to the
- area of the window exposed by the scroll, your painting
- handler can optimize painting by checking for the
- invalidated region.
"""
return _core_.Window_ScrollWindow(*args, **kwargs)
"""
ScrollPages(self, int pages) -> bool
- If the platform and window class supports it, scrolls the window by
+ If the platform and window class supports it, scrolls the window by
the given number of pages down, if pages is positive, or up if pages
is negative. Returns True if the window was scrolled, False if it was
already on top/bottom and nothing was done.
"""
InheritAttributes(self)
- This function is (or should be, in case of custom controls)
- called during window creation to intelligently set up the window
- visual attributes, that is the font and the foreground and
- background colours.
-
- By 'intelligently' the following is meant: by default, all
- windows use their own default attributes. However if some of the
- parent's attributes are explicitly changed (that is, using
- SetFont and not SetDefaultFont) and if the corresponding
- attribute hadn't been explicitly set for this window itself, then
- this window takes the same value as used by the parent. In
- addition, if the window overrides ShouldInheritColours to return
- false, the colours will not be changed no matter what and only
- the font might.
-
- This rather complicated logic is necessary in order to accomodate
- the different usage scenarius. The most common one is when all
- default attributes are used and in this case, nothing should be
- inherited as in modern GUIs different controls use different
- fonts (and colours) than their siblings so they can't inherit the
- same value from the parent. However it was also deemed desirable
- to allow to simply change the attributes of all children at once
- by just changing the font or colour of their common parent, hence
- in this case we do inherit the parents attributes.
+ This function is (or should be, in case of custom controls) called
+ during window creation to intelligently set up the window visual
+ attributes, that is the font and the foreground and background
+ colours.
+
+ By 'intelligently' the following is meant: by default, all windows use
+ their own default attributes. However if some of the parent's
+ attributes are explicitly changed (that is, using SetFont and not
+ SetDefaultFont) and if the corresponding attribute hadn't been
+ explicitly set for this window itself, then this window takes the same
+ value as used by the parent. In addition, if the window overrides
+ ShouldInheritColours to return false, the colours will not be changed
+ no matter what and only the font might.
+
+ This rather complicated logic is necessary in order to accomodate the
+ different usage scenarius. The most common one is when all default
+ attributes are used and in this case, nothing should be inherited as
+ in modern GUIs different controls use different fonts (and colours)
+ than their siblings so they can't inherit the same value from the
+ parent. However it was also deemed desirable to allow to simply change
+ the attributes of all children at once by just changing the font or
+ colour of their common parent, hence in this case we do inherit the
+ parents attributes.
+
"""
return _core_.Window_InheritAttributes(*args, **kwargs)
ShouldInheritColours(self) -> bool
Return true from here to allow the colours of this window to be
- changed by InheritAttributes, returning false forbids inheriting
- them from the parent window.
+ changed by InheritAttributes, returning false forbids inheriting them
+ from the parent window.
- The base class version returns false, but this method is
- overridden in wxControl where it returns true.
+ The base class version returns false, but this method is overridden in
+ wxControl where it returns true.
"""
return _core_.Window_ShouldInheritColours(*args, **kwargs)
Window_NextControlId(int winid) -> int
Get the id of the control following the one with the given
- (autogenerated) id
+ autogenerated) id
"""
return _core_.Window_NextControlId(*args, **kwargs)
Window_PrevControlId(int winid) -> int
Get the id of the control preceding the one with the given
- (autogenerated) id
+ autogenerated) id
"""
return _core_.Window_PrevControlId(*args, **kwargs)
"""
Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
- Get the default attributes for this class. This is useful if
- you want to use the same font or colour in your own control as
- in a standard control -- which is a much better idea than hard
- coding specific colours or fonts which might look completely out
- of place on the users system, especially if it uses themes.
+ 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 SetWindowVariant for more about this.
+ 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_.Window_GetClassDefaultAttributes(*args, **kwargs)
"""
This is the base class for a control or 'widget'.
- A control is generally a small window which processes user input and/or
- displays one or more item of data.
+ A control is generally a small window which processes user input
+ and/or displays one or more item of data.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
"""
- __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, Validator validator=DefaultValidator,
+ __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
String name=ControlNameStr) -> Control
- Create a Control. Normally you should only call this from a
- subclass' __init__ as a plain old wx.Control is not very useful.
+ Create a Control. Normally you should only call this from a subclass'
+ __init__ as a plain old wx.Control is not very useful.
"""
newobj = _core_.new_Control(*args, **kwargs)
self.this = newobj.this
def Create(*args, **kwargs):
"""
- Create(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, Validator validator=DefaultValidator,
+ Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
String name=ControlNameStr) -> bool
Do the 2nd phase and create the GUI control.
"""
Command(self, CommandEvent event)
- Simulates the effect of the user issuing a command to the
- item. See wx.CommandEvent.
+ Simulates the effect of the user issuing a command to the item.
+
+ :see: `wx.CommandEvent`
+
"""
return _core_.Control_Command(*args, **kwargs)
return _core_.Control_SetLabel(*args, **kwargs)
def GetClassDefaultAttributes(*args, **kwargs):
- """
- 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 users 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 SetWindowVariant for more about this.
- """
+ """GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
return val
def Control_GetClassDefaultAttributes(*args, **kwargs):
- """
- 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 users 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 SetWindowVariant for more about this.
- """
+ """Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes"""
return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
class ItemContainer(object):
"""
wx.ItemContainer defines an interface which is implemented by all
- controls which have string subitems, each of which may be
- selected, such as wx.ListBox, wx.CheckListBox, wx.Choice and
- wx.ComboBox (which implements an extended interface deriving from
- this one)
+ controls which have string subitems, each of which may be selected,
+ such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
+ `wx.ComboBox` which implements an extended interface deriving from
+ this one.
- It defines the methods for accessing the control's items and
- although each of the derived classes implements them differently,
- they still all conform to the same interface.
+ It defines the methods for accessing the control's items and although
+ each of the derived classes implements them differently, they still
+ all conform to the same interface.
- The items in a wx.ItemContainer have (non empty) string labels
- and, optionally, client data associated with them.
+ The items in a wx.ItemContainer have (non empty) string labels and,
+ optionally, client data associated with them.
"""
def __init__(self): raise RuntimeError, "No constructor defined"
"""
Append(self, String item, PyObject clientData=None) -> int
- Adds the item to the control, associating the given data with the
- item if not None. The return value is the index of the newly
- added item which may be different from the last one if the
- control is sorted (e.g. has wx.LB_SORT or wx.CB_SORT style).
+ Adds the item to the control, associating the given data with the item
+ if not None. The return value is the index of the newly added item
+ which may be different from the last one if the control is sorted (e.g.
+ has wx.LB_SORT or wx.CB_SORT style).
"""
return _core_.ItemContainer_Append(*args, **kwargs)
"""
AppendItems(self, wxArrayString strings)
- Apend several items at once to the control. Notice that calling
- this method may be much faster than appending the items one by
- one if you need to add a lot of items.
+ Apend several items at once to the control. Notice that calling this
+ method may be much faster than appending the items one by one if you
+ need to add a lot of items.
"""
return _core_.ItemContainer_AppendItems(*args, **kwargs)
"""
Insert(self, String item, int pos, PyObject clientData=None) -> int
- Insert an item into the control before the item at the pos index,
+ Insert an item into the control before the item at the ``pos`` index,
optionally associating some data object with the item.
"""
return _core_.ItemContainer_Insert(*args, **kwargs)
"""
Delete(self, int n)
- Deletes the item at the zero-based index 'n' from the control.
- Note that it is an error (signalled by a PyAssertionError
- exception if enabled) to remove an item with the index negative
- or greater or equal than the number of items in the control.
+ Deletes the item at the zero-based index 'n' from the control. Note
+ that it is an error (signalled by a `wx.PyAssertionError` exception if
+ enabled) to remove an item with the index negative or greater or equal
+ than the number of items in the control.
"""
return _core_.ItemContainer_Delete(*args, **kwargs)
FindString(self, String s) -> int
Finds an item whose label matches the given string. Returns the
- zero-based position of the item, or wx.NOT_FOUND if the string
- was not found.
+ zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
+ found.
"""
return _core_.ItemContainer_FindString(*args, **kwargs)
"""
GetSelection(self) -> int
- Returns the index of the selected item or wx.NOT_FOUND if no item is selected.
+ Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
+ is selected.
"""
return _core_.ItemContainer_GetSelection(*args, **kwargs)
"""
GetStringSelection(self) -> String
- Returns the label of the selected item or an empty string if no item is selected.
+ Returns the label of the selected item or an empty string if no item
+ is selected.
"""
return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
class ControlWithItems(Control,ItemContainer):
"""
- wx.ControlWithItems combines the wx.ItemContainer class with the
- wx.Control class, and is used for the base class of various
- controls that have items.
+ wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
+ wx.Control class, and is used for the base class of various controls
+ that have items.
"""
def __init__(self): raise RuntimeError, "No constructor defined"
def __repr__(self):
#---------------------------------------------------------------------------
class SizerItem(Object):
+ """
+ The wx.SizerItem class is used to track the position, size and other
+ attributes of each item managed by a `wx.Sizer`. In normal usage user
+ code should never need to deal directly with a wx.SizerItem, but
+ custom classes derived from `wx.PySizer` will probably need to use the
+ collection of wx.SizerItems held by wx.Sizer when calculating layout.
+
+ :see: `wx.Sizer`, `wx.GBSizerItem`
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self) -> SizerItem"""
+ """
+ __init__(self) -> SizerItem
+
+ Constructs an empty wx.SizerItem. Either a window, sizer or spacer
+ size will need to be set before this item can be used in a Sizer.
+
+ You will probably never need to create a wx.SizerItem directly as they
+ are created automatically when the sizer's Add, Insert or Prepend
+ methods are called.
+
+ :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
+ """
newobj = _core_.new_SizerItem(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
def DeleteWindows(*args, **kwargs):
- """DeleteWindows(self)"""
+ """
+ DeleteWindows(self)
+
+ Destroy the window or the windows in a subsizer, depending on the type
+ of item.
+ """
return _core_.SizerItem_DeleteWindows(*args, **kwargs)
def DetachSizer(*args, **kwargs):
- """DetachSizer(self)"""
+ """
+ DetachSizer(self)
+
+ Enable deleting the SizerItem without destroying the contained sizer.
+ """
return _core_.SizerItem_DetachSizer(*args, **kwargs)
def GetSize(*args, **kwargs):
- """GetSize(self) -> Size"""
+ """
+ GetSize(self) -> Size
+
+ Get the current size of the item, as set in the last Layout.
+ """
return _core_.SizerItem_GetSize(*args, **kwargs)
def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
+ """
+ CalcMin(self) -> Size
+
+ Calculates the minimum desired size for the item, including any space
+ needed by borders.
+ """
return _core_.SizerItem_CalcMin(*args, **kwargs)
def SetDimension(*args, **kwargs):
- """SetDimension(self, Point pos, Size size)"""
+ """
+ SetDimension(self, Point pos, Size size)
+
+ Set the position and size of the space allocated for this item by the
+ sizer, and adjust the position and size of the item (window or
+ subsizer) to be within that space taking alignment and borders into
+ account.
+ """
return _core_.SizerItem_SetDimension(*args, **kwargs)
def GetMinSize(*args, **kwargs):
- """GetMinSize(self) -> Size"""
+ """
+ GetMinSize(self) -> Size
+
+ Get the minimum size needed for the item.
+ """
return _core_.SizerItem_GetMinSize(*args, **kwargs)
def SetInitSize(*args, **kwargs):
return _core_.SizerItem_SetInitSize(*args, **kwargs)
def SetRatioWH(*args, **kwargs):
- """SetRatioWH(self, int width, int height)"""
+ """
+ SetRatioWH(self, int width, int height)
+
+ Set the ratio item attribute.
+ """
return _core_.SizerItem_SetRatioWH(*args, **kwargs)
def SetRatioSize(*args, **kwargs):
- """SetRatioSize(self, Size size)"""
+ """
+ SetRatioSize(self, Size size)
+
+ Set the ratio item attribute.
+ """
return _core_.SizerItem_SetRatioSize(*args, **kwargs)
def SetRatio(*args, **kwargs):
- """SetRatio(self, float ratio)"""
+ """
+ SetRatio(self, float ratio)
+
+ Set the ratio item attribute.
+ """
return _core_.SizerItem_SetRatio(*args, **kwargs)
def GetRatio(*args, **kwargs):
- """GetRatio(self) -> float"""
+ """
+ GetRatio(self) -> float
+
+ Set the ratio item attribute.
+ """
return _core_.SizerItem_GetRatio(*args, **kwargs)
def IsWindow(*args, **kwargs):
- """IsWindow(self) -> bool"""
+ """
+ IsWindow(self) -> bool
+
+ Is this sizer item a window?
+ """
return _core_.SizerItem_IsWindow(*args, **kwargs)
def IsSizer(*args, **kwargs):
- """IsSizer(self) -> bool"""
+ """
+ IsSizer(self) -> bool
+
+ Is this sizer item a subsizer?
+ """
return _core_.SizerItem_IsSizer(*args, **kwargs)
def IsSpacer(*args, **kwargs):
- """IsSpacer(self) -> bool"""
+ """
+ IsSpacer(self) -> bool
+
+ Is this sizer item a spacer?
+ """
return _core_.SizerItem_IsSpacer(*args, **kwargs)
def SetProportion(*args, **kwargs):
- """SetProportion(self, int proportion)"""
+ """
+ SetProportion(self, int proportion)
+
+ Set the proportion value for this item.
+ """
return _core_.SizerItem_SetProportion(*args, **kwargs)
def GetProportion(*args, **kwargs):
- """GetProportion(self) -> int"""
+ """
+ GetProportion(self) -> int
+
+ Get the proportion value for this item.
+ """
return _core_.SizerItem_GetProportion(*args, **kwargs)
- SetOption = SetProportion
- GetOption = GetProportion
+ SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
+ GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
def SetFlag(*args, **kwargs):
- """SetFlag(self, int flag)"""
+ """
+ SetFlag(self, int flag)
+
+ Set the flag value for this item.
+ """
return _core_.SizerItem_SetFlag(*args, **kwargs)
def GetFlag(*args, **kwargs):
- """GetFlag(self) -> int"""
+ """
+ GetFlag(self) -> int
+
+ Get the flag value for this item.
+ """
return _core_.SizerItem_GetFlag(*args, **kwargs)
def SetBorder(*args, **kwargs):
- """SetBorder(self, int border)"""
+ """
+ SetBorder(self, int border)
+
+ Set the border value for this item.
+ """
return _core_.SizerItem_SetBorder(*args, **kwargs)
def GetBorder(*args, **kwargs):
- """GetBorder(self) -> int"""
+ """
+ GetBorder(self) -> int
+
+ Get the border value for this item.
+ """
return _core_.SizerItem_GetBorder(*args, **kwargs)
def GetWindow(*args, **kwargs):
- """GetWindow(self) -> Window"""
+ """
+ GetWindow(self) -> Window
+
+ Get the window (if any) that is managed by this sizer item.
+ """
return _core_.SizerItem_GetWindow(*args, **kwargs)
def SetWindow(*args, **kwargs):
- """SetWindow(self, Window window)"""
+ """
+ SetWindow(self, Window window)
+
+ Set the window to be managed by this sizer item.
+ """
return _core_.SizerItem_SetWindow(*args, **kwargs)
def GetSizer(*args, **kwargs):
- """GetSizer(self) -> Sizer"""
+ """
+ GetSizer(self) -> Sizer
+
+ Get the subsizer (if any) that is managed by this sizer item.
+ """
return _core_.SizerItem_GetSizer(*args, **kwargs)
def SetSizer(*args, **kwargs):
- """SetSizer(self, Sizer sizer)"""
+ """
+ SetSizer(self, Sizer sizer)
+
+ Set the subsizer to be managed by this sizer item.
+ """
return _core_.SizerItem_SetSizer(*args, **kwargs)
def GetSpacer(*args, **kwargs):
- """GetSpacer(self) -> Size"""
+ """
+ GetSpacer(self) -> Size
+
+ Get the size of the spacer managed by this sizer item.
+ """
return _core_.SizerItem_GetSpacer(*args, **kwargs)
def SetSpacer(*args, **kwargs):
- """SetSpacer(self, Size size)"""
+ """
+ SetSpacer(self, Size size)
+
+ Set the size of the spacer to be managed by this sizer item.
+ """
return _core_.SizerItem_SetSpacer(*args, **kwargs)
def Show(*args, **kwargs):
- """Show(self, bool show)"""
+ """
+ Show(self, bool show)
+
+ Set the show item attribute, which sizers use to determine if the item
+ is to be made part of the layout or not. If the item is tracking a
+ window then it is shown or hidden as needed.
+ """
return _core_.SizerItem_Show(*args, **kwargs)
def IsShown(*args, **kwargs):
- """IsShown(self) -> bool"""
+ """
+ IsShown(self) -> bool
+
+ Is the item to be shown in the layout?
+ """
return _core_.SizerItem_IsShown(*args, **kwargs)
def GetPosition(*args, **kwargs):
- """GetPosition(self) -> Point"""
+ """
+ GetPosition(self) -> Point
+
+ Returns the current position of the item, as set in the last Layout.
+ """
return _core_.SizerItem_GetPosition(*args, **kwargs)
def GetUserData(*args, **kwargs):
- """GetUserData(self) -> PyObject"""
+ """
+ GetUserData(self) -> PyObject
+
+ Returns the userData associated with this sizer item, or None if there
+ isn't any.
+ """
return _core_.SizerItem_GetUserData(*args, **kwargs)
self.__class__ = SizerItem
_core_.SizerItem_swigregister(SizerItemPtr)
-def SizerItemSpacer(*args, **kwargs):
+def SizerItemWindow(*args, **kwargs):
"""
- SizerItemSpacer(int width, int height, int proportion, int flag, int border,
- Object userData) -> SizerItem
+ SizerItemWindow(Window window, int proportion, int flag, int border,
+ PyObject userData=None) -> SizerItem
+
+ Constructs a `wx.SizerItem` for tracking a window.
"""
- val = _core_.new_SizerItemSpacer(*args, **kwargs)
+ val = _core_.new_SizerItemWindow(*args, **kwargs)
val.thisown = 1
return val
-def SizerItemWindow(*args, **kwargs):
+def SizerItemSpacer(*args, **kwargs):
"""
- SizerItemWindow(Window window, int proportion, int flag, int border,
- Object userData) -> SizerItem
+ SizerItemSpacer(int width, int height, int proportion, int flag, int border,
+ PyObject userData=None) -> SizerItem
+
+ Constructs a `wx.SizerItem` for tracking a spacer.
"""
- val = _core_.new_SizerItemWindow(*args, **kwargs)
+ val = _core_.new_SizerItemSpacer(*args, **kwargs)
val.thisown = 1
return val
def SizerItemSizer(*args, **kwargs):
"""
SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
- Object userData) -> SizerItem
+ PyObject userData=None) -> SizerItem
+
+ Constructs a `wx.SizerItem` for tracking a subsizer
"""
val = _core_.new_SizerItemSizer(*args, **kwargs)
val.thisown = 1
return val
class Sizer(Object):
+ """
+ wx.Sizer is the abstract base class used for laying out subwindows in
+ a window. You cannot use wx.Sizer directly; instead, you will have to
+ use one of the sizer classes derived from it such as `wx.BoxSizer`,
+ `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
+ and `wx.GridBagSizer`.
+
+ The concept implemented by sizers in wxWidgets is closely related to
+ layout tools in other GUI toolkits, such as Java's AWT, the GTK
+ toolkit or the Qt toolkit. It is based upon the idea of the individual
+ subwindows reporting their minimal required size and their ability to
+ get stretched if the size of the parent window has changed. This will
+ most often mean that the programmer does not set the original size of
+ a dialog in the beginning, rather the dialog will assigned a sizer and
+ this sizer will be queried about the recommended size. The sizer in
+ turn will query its children, which can be normal windows or contorls,
+ empty space or other sizers, so that a hierarchy of sizers can be
+ constructed. Note that wxSizer does not derive from wxWindow and thus
+ do not interfere with tab ordering and requires very little resources
+ compared to a real window on screen.
+
+ What makes sizers so well fitted for use in wxWidgets is the fact that
+ every control reports its own minimal size and the algorithm can
+ handle differences in font sizes or different window (dialog item)
+ sizes on different platforms without problems. If for example the
+ standard font as well as the overall design of Mac widgets requires
+ more space than on Windows, then the initial size of a dialog using a
+ sizer will automatically be bigger on Mac than on Windows.
+ """
def __init__(self): raise RuntimeError, "No constructor defined"
def __repr__(self):
return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def Add(*args, **kwargs):
"""
- Add(self, PyObject item, int proportion=0, int flag=0, int border=0,
+ Add(self, item, int proportion=0, int flag=0, int border=0,
PyObject userData=None)
+
+ Appends a child item to the sizer.
"""
return _core_.Sizer_Add(*args, **kwargs)
def Insert(*args, **kwargs):
"""
- Insert(self, int before, PyObject item, int proportion=0, int flag=0,
- int border=0, PyObject userData=None)
+ Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
+ PyObject userData=None)
+
+ Inserts a new item into the list of items managed by this sizer before
+ the item at index *before*. See `Add` for a description of the parameters.
"""
return _core_.Sizer_Insert(*args, **kwargs)
def Prepend(*args, **kwargs):
"""
- Prepend(self, PyObject item, int proportion=0, int flag=0, int border=0,
+ Prepend(self, item, int proportion=0, int flag=0, int border=0,
PyObject userData=None)
+
+ Adds a new item to the begining of the list of sizer items managed by
+ this sizer. See `Add` for a description of the parameters.
"""
return _core_.Sizer_Prepend(*args, **kwargs)
def Remove(*args, **kwargs):
- """Remove(self, PyObject item) -> bool"""
+ """
+ Remove(self, item) -> bool
+
+ Removes an item from the sizer and destroys it. This method does not
+ cause any layout or resizing to take place, call `Layout` to update
+ the layout on screen after removing a child from the sizer. The
+ *item* parameter can be either a window, a sizer, or the zero-based
+ index of an item to remove. Returns True if the child item was found
+ and removed.
+ """
return _core_.Sizer_Remove(*args, **kwargs)
+ def Detach(*args, **kwargs):
+ """
+ Detach(self, item) -> bool
+
+ Detaches an item from the sizer without destroying it. This method
+ does not cause any layout or resizing to take place, call `Layout` to
+ do so. The *item* parameter can be either a window, a sizer, or the
+ zero-based index of the item to be detached. Returns True if the child item
+ was found and detached.
+ """
+ return _core_.Sizer_Detach(*args, **kwargs)
+
def _SetItemMinSize(*args, **kwargs):
"""_SetItemMinSize(self, PyObject item, Size size)"""
return _core_.Sizer__SetItemMinSize(*args, **kwargs)
+ def SetItemMinSize(self, item, *args):
+ """
+ SetItemMinSize(self, item, Size size)
+
+ Sets the minimum size that will be allocated for an item in the sizer.
+ The *item* parameter can be either a window, a sizer, or the
+ zero-based index of the item. If a window or sizer is given then it
+ will be searched for recursivly in subsizers if neccessary.
+ """
+ if len(args) == 2:
+ # for backward compatibility accept separate width,height args too
+ return self._SetItemMinSize(item, args)
+ else:
+ return self._SetItemMinSize(item, args[0])
+
def AddItem(*args, **kwargs):
- """AddItem(self, SizerItem item)"""
+ """
+ AddItem(self, SizerItem item)
+
+ Adds a `wx.SizerItem` to the sizer.
+ """
return _core_.Sizer_AddItem(*args, **kwargs)
def InsertItem(*args, **kwargs):
- """InsertItem(self, size_t index, SizerItem item)"""
+ """
+ InsertItem(self, int index, SizerItem item)
+
+ Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
+ """
return _core_.Sizer_InsertItem(*args, **kwargs)
def PrependItem(*args, **kwargs):
- """PrependItem(self, SizerItem item)"""
+ """
+ PrependItem(self, SizerItem item)
+
+ Prepends a `wx.SizerItem` to the sizer.
+ """
return _core_.Sizer_PrependItem(*args, **kwargs)
- def AddMany(self, widgets):
+ def AddMany(self, items):
"""
AddMany is a convenience method for adding several items
to a sizer at one time. Simply pass it a list of tuples,
where each tuple consists of the parameters that you
would normally pass to the `Add` method.
"""
- for childinfo in widgets:
- if type(childinfo) != type(()) or (len(childinfo) == 2 and type(childinfo[0]) == type(1)):
- childinfo = (childinfo, )
- self.Add(*childinfo)
+ for item in items:
+ if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
+ item = (item, )
+ self.Add(*item)
# for backwards compatibility only, please do not use in new code
AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
- def SetItemMinSize(self, item, *args):
- if len(args) == 2:
- return self._SetItemMinSize(item, args)
- else:
- return self._SetItemMinSize(item, args[0])
-
def SetDimension(*args, **kwargs):
- """SetDimension(self, int x, int y, int width, int height)"""
+ """
+ SetDimension(self, int x, int y, int width, int height)
+
+ Call this to force the sizer to take the given dimension and thus
+ force the items owned by the sizer to resize themselves according to
+ the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
+ methods.
+ """
return _core_.Sizer_SetDimension(*args, **kwargs)
def SetMinSize(*args, **kwargs):
- """SetMinSize(self, Size size)"""
+ """
+ SetMinSize(self, Size size)
+
+ Call this to give the sizer a minimal size. Normally, the sizer will
+ calculate its minimal size based purely on how much space its children
+ need. After calling this method `GetMinSize` will return either the
+ minimal size as requested by its children or the minimal size set
+ here, depending on which is bigger.
+ """
return _core_.Sizer_SetMinSize(*args, **kwargs)
def GetSize(*args, **kwargs):
- """GetSize(self) -> Size"""
+ """
+ GetSize(self) -> Size
+
+ Returns the current size of the space managed by the sizer.
+ """
return _core_.Sizer_GetSize(*args, **kwargs)
def GetPosition(*args, **kwargs):
- """GetPosition(self) -> Point"""
+ """
+ GetPosition(self) -> Point
+
+ Returns the current position of the sizer's managed space.
+ """
return _core_.Sizer_GetPosition(*args, **kwargs)
def GetMinSize(*args, **kwargs):
- """GetMinSize(self) -> Size"""
+ """
+ GetMinSize(self) -> Size
+
+ Returns the minimal size of the sizer. This is either the combined
+ minimal size of all the children and their borders or the minimal size
+ set by SetMinSize, depending on which is bigger.
+ """
return _core_.Sizer_GetMinSize(*args, **kwargs)
def GetSizeTuple(self):
- return self.GetSize().asTuple()
+ return self.GetSize().Get()
def GetPositionTuple(self):
- return self.GetPosition().asTuple()
+ return self.GetPosition().Get()
def GetMinSizeTuple(self):
- return self.GetMinSize().asTuple()
+ return self.GetMinSize().Get()
def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
+ """
+ RecalcSizes(self)
+
+ Using the sizes calculated by `CalcMin` reposition and resize all the
+ items managed by this sizer. You should not need to call this directly as
+ it is called by `Layout`.
+ """
return _core_.Sizer_RecalcSizes(*args, **kwargs)
def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
+ """
+ CalcMin(self) -> Size
+
+ This method is where the sizer will do the actual calculation of its
+ children's minimal sizes. You should not need to call this directly as
+ it is called by `Layout`.
+ """
return _core_.Sizer_CalcMin(*args, **kwargs)
def Layout(*args, **kwargs):
- """Layout(self)"""
+ """
+ Layout(self)
+
+ This method will force the recalculation and layout of the items
+ controlled by the sizer using the current space allocated to the
+ sizer. Normally this is called automatically from the owning window's
+ EVT_SIZE handler, but it is also useful to call it from user code when
+ one of the items in a sizer change size, or items are added or
+ removed.
+ """
return _core_.Sizer_Layout(*args, **kwargs)
def Fit(*args, **kwargs):
- """Fit(self, Window window) -> Size"""
+ """
+ Fit(self, Window window) -> Size
+
+ Tell the sizer to resize the *window* to match the sizer's minimal
+ size. This is commonly done in the constructor of the window itself in
+ order to set its initial size to match the needs of the children as
+ determined by the sizer. Returns the new size.
+
+ For a top level window this is the total window size, not the client size.
+ """
return _core_.Sizer_Fit(*args, **kwargs)
def FitInside(*args, **kwargs):
- """FitInside(self, Window window)"""
+ """
+ FitInside(self, Window window)
+
+ Tell the sizer to resize the *virtual size* of the *window* to match the
+ sizer's minimal size. This will not alter the on screen size of the
+ window, but may cause the addition/removal/alteration of scrollbars
+ required to view the virtual area in windows which manage it.
+
+ :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
+
+ """
return _core_.Sizer_FitInside(*args, **kwargs)
def SetSizeHints(*args, **kwargs):
- """SetSizeHints(self, Window window)"""
+ """
+ SetSizeHints(self, Window window)
+
+ Tell the sizer to set (and `Fit`) the minimal size of the *window* to
+ match the sizer's minimal size. This is commonly done in the
+ constructor of the window itself if the window is resizable (as are
+ many dialogs under Unix and frames on probably all platforms) in order
+ to prevent the window from being sized smaller than the minimal size
+ required by the sizer.
+ """
return _core_.Sizer_SetSizeHints(*args, **kwargs)
def SetVirtualSizeHints(*args, **kwargs):
- """SetVirtualSizeHints(self, Window window)"""
+ """
+ SetVirtualSizeHints(self, Window window)
+
+ Tell the sizer to set the minimal size of the window virtual area to
+ match the sizer's minimal size. For windows with managed scrollbars
+ this will set them appropriately.
+
+ :see: `wx.ScrolledWindow.SetScrollbars`
+
+ """
return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
def Clear(*args, **kwargs):
- """Clear(self, bool delete_windows=False)"""
+ """
+ Clear(self, bool deleteWindows=False)
+
+ Clear all items from the sizer, optionally destroying the window items
+ as well.
+ """
return _core_.Sizer_Clear(*args, **kwargs)
def DeleteWindows(*args, **kwargs):
- """DeleteWindows(self)"""
+ """
+ DeleteWindows(self)
+
+ Destroy all windows managed by the sizer.
+ """
return _core_.Sizer_DeleteWindows(*args, **kwargs)
def GetChildren(*args, **kwargs):
- """GetChildren(self) -> PyObject"""
+ """
+ GetChildren(sefl) -> list
+
+ Returns a list of all the `wx.SizerItem` objects managed by the sizer.
+ """
return _core_.Sizer_GetChildren(*args, **kwargs)
def Show(*args, **kwargs):
- """Show(self, PyObject item, bool show=True)"""
- return _core_.Sizer_Show(*args, **kwargs)
+ """
+ Show(self, item, bool show=True)
- def Hide(*args, **kwargs):
- """Hide(self, PyObject item)"""
- return _core_.Sizer_Hide(*args, **kwargs)
+ Shows or hides an item managed by the sizer. To make a sizer item
+ disappear or reappear, use Show followed by `Layout`. The *item*
+ parameter can be either a window, a sizer, or the zero-based index of
+ the item.
+ """
+ return _core_.Sizer_Show(*args, **kwargs)
def IsShown(*args, **kwargs):
- """IsShown(self, PyObject item) -> bool"""
+ """
+ IsShown(self, item)
+
+ Determines if the item is currently shown. sizer. To make a sizer
+ item disappear or reappear, use Show followed by `Layout`. The *item*
+ parameter can be either a window, a sizer, or the zero-based index of
+ the item.
+ """
return _core_.Sizer_IsShown(*args, **kwargs)
+ def Hide(self, item):
+ """
+ A convenience method for Show(item, False).
+ """
+ self.Show(item, False)
+
def ShowItems(*args, **kwargs):
- """ShowItems(self, bool show)"""
+ """
+ ShowItems(self, bool show)
+
+ Recursively call `wx.Window.Show` on all sizer items.
+ """
return _core_.Sizer_ShowItems(*args, **kwargs)
_core_.Sizer_swigregister(SizerPtr)
class PySizer(Sizer):
+ """
+ wx.PySizer is a special version of `wx.Sizer` that has been
+ instrumented to allow the C++ virtual methods to be overloaded in
+ Python derived classes. You would derive from this class if you are
+ wanting to implement a custom sizer in Python code. Simply implement
+ `CalcMin` and `RecalcSizes` in the derived class and you're all set.
+ For example::
+
+ class MySizer(wx.PySizer):
+ def __init__(self):
+ wx.PySizer.__init__(self)
+
+ def CalcMin(self):
+ for item in self.GetChildren():
+ # calculate the total minimum width and height needed
+ # by all items in the sizer according to this sizer's
+ # layout algorithm.
+ ...
+ return wx.Size(width, height)
+
+ def RecalcSizes(self):
+ # find the space allotted to this sizer
+ pos = self.GetPosition()
+ size = self.GetSize()
+ for item in self.GetChildren():
+ # Recalculate (if necessary) the position and size of
+ # each item and then call item.SetDimension to do the
+ # actual positioning and sizing of the items within the
+ # space alloted to this sizer.
+ ...
+ item.SetDimension(itemPos, itemSize)
+
+
+ When `Layout` is called it first calls `CalcMin` followed by
+ `RecalcSizes` so you can optimize a bit by saving the results of
+ `CalcMin` and resuing them in `RecalcSizes`.
+
+ :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
+
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self) -> PySizer"""
+ """
+ __init__(self) -> PySizer
+
+ Creates a wx.PySizer. Must be called from the __init__ in the derived
+ class.
+ """
newobj = _core_.new_PySizer(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
#---------------------------------------------------------------------------
class BoxSizer(Sizer):
+ """
+ The basic idea behind a box sizer is that windows will most often be
+ laid out in rather simple basic geometry, typically in a row or a
+ column or nested hierarchies of either. A wx.BoxSizer will lay out
+ its items in a simple row or column, depending on the orientation
+ parameter passed to the constructor.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, int orient=HORIZONTAL) -> BoxSizer"""
+ """
+ __init__(self, int orient=HORIZONTAL) -> BoxSizer
+
+ Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
+ or ``wx.HORIZONTAL`` for creating either a column sizer or a row
+ sizer.
+ """
newobj = _core_.new_BoxSizer(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
self._setOORInfo(self)
def GetOrientation(*args, **kwargs):
- """GetOrientation(self) -> int"""
+ """
+ GetOrientation(self) -> int
+
+ Returns the current orientation of the sizer.
+ """
return _core_.BoxSizer_GetOrientation(*args, **kwargs)
def SetOrientation(*args, **kwargs):
- """SetOrientation(self, int orient)"""
- return _core_.BoxSizer_SetOrientation(*args, **kwargs)
-
- def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
- return _core_.BoxSizer_RecalcSizes(*args, **kwargs)
+ """
+ SetOrientation(self, int orient)
- def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
- return _core_.BoxSizer_CalcMin(*args, **kwargs)
+ Resets the orientation of the sizer.
+ """
+ return _core_.BoxSizer_SetOrientation(*args, **kwargs)
class BoxSizerPtr(BoxSizer):
#---------------------------------------------------------------------------
class StaticBoxSizer(BoxSizer):
+ """
+ wx.StaticBoxSizer derives from and functions identically to the
+ `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
+ manages. Note that this static box must be created separately and
+ passed to the sizer constructor.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, wxStaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer"""
+ """
+ __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
+
+ Constructor. It takes an associated static box and the orientation
+ *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
+ ``wx.HORIZONTAL``.
+ """
newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
self._setOORInfo(self)
def GetStaticBox(*args, **kwargs):
- """GetStaticBox(self) -> wxStaticBox"""
- return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
-
- def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
- return _core_.StaticBoxSizer_RecalcSizes(*args, **kwargs)
+ """
+ GetStaticBox(self) -> StaticBox
- def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
- return _core_.StaticBoxSizer_CalcMin(*args, **kwargs)
+ Returns the static box associated with this sizer.
+ """
+ return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
class StaticBoxSizerPtr(StaticBoxSizer):
#---------------------------------------------------------------------------
class GridSizer(Sizer):
+ """
+ A grid sizer is a sizer which lays out its children in a
+ two-dimensional table with all cells having the same size. In other
+ words, the width of each cell within the grid is the width of the
+ widest item added to the sizer and the height of each grid cell is the
+ height of the tallest item. An optional vertical and/or horizontal
+ gap between items can also be specified (in pixels.)
+
+ Items are placed in the cells of the grid in the order they are added,
+ in row-major order. In other words, the first row is filled first,
+ then the second, and so on until all items have been added. (If
+ neccessary, additional rows will be added as items are added.) If you
+ need to have greater control over the cells that items are placed in
+ then use the `wx.GridBagSizer`.
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer"""
+ """
+ __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
+
+ Constructor for a wx.GridSizer. *rows* and *cols* determine the number
+ of columns and rows in the sizer - if either of the parameters is
+ zero, it will be calculated to from the total number of children in
+ the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
+ define extra space between all children.
+ """
newobj = _core_.new_GridSizer(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
self._setOORInfo(self)
- def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
- return _core_.GridSizer_RecalcSizes(*args, **kwargs)
-
- def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
- return _core_.GridSizer_CalcMin(*args, **kwargs)
-
def SetCols(*args, **kwargs):
- """SetCols(self, int cols)"""
+ """
+ SetCols(self, int cols)
+
+ Sets the number of columns in the sizer.
+ """
return _core_.GridSizer_SetCols(*args, **kwargs)
def SetRows(*args, **kwargs):
- """SetRows(self, int rows)"""
+ """
+ SetRows(self, int rows)
+
+ Sets the number of rows in the sizer.
+ """
return _core_.GridSizer_SetRows(*args, **kwargs)
def SetVGap(*args, **kwargs):
- """SetVGap(self, int gap)"""
+ """
+ SetVGap(self, int gap)
+
+ Sets the vertical gap (in pixels) between the cells in the sizer.
+ """
return _core_.GridSizer_SetVGap(*args, **kwargs)
def SetHGap(*args, **kwargs):
- """SetHGap(self, int gap)"""
+ """
+ SetHGap(self, int gap)
+
+ Sets the horizontal gap (in pixels) between cells in the sizer
+ """
return _core_.GridSizer_SetHGap(*args, **kwargs)
def GetCols(*args, **kwargs):
- """GetCols(self) -> int"""
+ """
+ GetCols(self) -> int
+
+ Returns the number of columns in the sizer.
+ """
return _core_.GridSizer_GetCols(*args, **kwargs)
def GetRows(*args, **kwargs):
- """GetRows(self) -> int"""
+ """
+ GetRows(self) -> int
+
+ Returns the number of rows in the sizer.
+ """
return _core_.GridSizer_GetRows(*args, **kwargs)
def GetVGap(*args, **kwargs):
- """GetVGap(self) -> int"""
+ """
+ GetVGap(self) -> int
+
+ Returns the vertical gap (in pixels) between the cells in the sizer.
+ """
return _core_.GridSizer_GetVGap(*args, **kwargs)
def GetHGap(*args, **kwargs):
- """GetHGap(self) -> int"""
+ """
+ GetHGap(self) -> int
+
+ Returns the horizontal gap (in pixels) between cells in the sizer.
+ """
return _core_.GridSizer_GetHGap(*args, **kwargs)
FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
class FlexGridSizer(GridSizer):
+ """
+ A flex grid sizer is a sizer which lays out its children in a
+ two-dimensional table with all table cells in one row having the same
+ height and all cells in one column having the same width, but all
+ rows or all columns are not necessarily the same height or width as in
+ the `wx.GridSizer`.
+
+ wx.FlexGridSizer can also size items equally in one direction but
+ unequally ("flexibly") in the other. If the sizer is only flexible
+ in one direction (this can be changed using `SetFlexibleDirection`), it
+ needs to be decided how the sizer should grow in the other ("non
+ flexible") direction in order to fill the available space. The
+ `SetNonFlexibleGrowMode` method serves this purpose.
+
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer"""
+ """
+ __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
+
+ Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
+ number of columns and rows in the sizer - if either of the parameters
+ is zero, it will be calculated to from the total number of children in
+ the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
+ define extra space between all children.
+ """
newobj = _core_.new_FlexGridSizer(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
self._setOORInfo(self)
- def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
- return _core_.FlexGridSizer_RecalcSizes(*args, **kwargs)
+ def AddGrowableRow(*args, **kwargs):
+ """
+ AddGrowableRow(self, size_t idx, int proportion=0)
- def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
- return _core_.FlexGridSizer_CalcMin(*args, **kwargs)
+ Specifies that row *idx* (starting from zero) should be grown if there
+ is extra space available to the sizer.
- def AddGrowableRow(*args, **kwargs):
- """AddGrowableRow(self, size_t idx, int proportion=0)"""
+ The *proportion* parameter has the same meaning as the stretch factor
+ for the box sizers except that if all proportions are 0, then all
+ columns are resized equally (instead of not being resized at all).
+ """
return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
def RemoveGrowableRow(*args, **kwargs):
- """RemoveGrowableRow(self, size_t idx)"""
+ """
+ RemoveGrowableRow(self, size_t idx)
+
+ Specifies that row *idx* is no longer growable.
+ """
return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
def AddGrowableCol(*args, **kwargs):
- """AddGrowableCol(self, size_t idx, int proportion=0)"""
+ """
+ AddGrowableCol(self, size_t idx, int proportion=0)
+
+ Specifies that column *idx* (starting from zero) should be grown if
+ there is extra space available to the sizer.
+
+ The *proportion* parameter has the same meaning as the stretch factor
+ for the box sizers except that if all proportions are 0, then all
+ columns are resized equally (instead of not being resized at all).
+ """
return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
def RemoveGrowableCol(*args, **kwargs):
- """RemoveGrowableCol(self, size_t idx)"""
+ """
+ RemoveGrowableCol(self, size_t idx)
+
+ Specifies that column *idx* is no longer growable.
+ """
return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
def SetFlexibleDirection(*args, **kwargs):
- """SetFlexibleDirection(self, int direction)"""
+ """
+ SetFlexibleDirection(self, int direction)
+
+ Specifies whether the sizer should flexibly resize its columns, rows,
+ or both. Argument *direction* can be one of the following values. Any
+ other value is ignored.
+
+ ============== =======================================
+ wx.VERTICAL Rows are flexibly sized.
+ wx.HORIZONTAL Columns are flexibly sized.
+ wx.BOTH Both rows and columns are flexibly sized
+ (this is the default value).
+ ============== =======================================
+
+ Note that this method does not trigger relayout.
+
+ """
return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
def GetFlexibleDirection(*args, **kwargs):
- """GetFlexibleDirection(self) -> int"""
+ """
+ GetFlexibleDirection(self) -> int
+
+ Returns a value that specifies whether the sizer
+ flexibly resizes its columns, rows, or both (default).
+
+ :see: `SetFlexibleDirection`
+ """
return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
def SetNonFlexibleGrowMode(*args, **kwargs):
- """SetNonFlexibleGrowMode(self, int mode)"""
+ """
+ SetNonFlexibleGrowMode(self, int mode)
+
+ Specifies how the sizer should grow in the non-flexible direction if
+ there is one (so `SetFlexibleDirection` must have been called
+ previously). Argument *mode* can be one of the following values:
+
+ ========================== =================================================
+ wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
+ wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
+ `AddGrowableCol` and `AddGrowableRow`. In this
+ case equal sizing applies to minimum sizes of
+ columns or rows (this is the default value).
+ wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
+ the non flexible direction, whether they are
+ growable or not in the flexbile direction.
+ ========================== =================================================
+
+ Note that this method does not trigger relayout.
+
+
+ """
return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
def GetNonFlexibleGrowMode(*args, **kwargs):
- """GetNonFlexibleGrowMode(self) -> int"""
+ """
+ GetNonFlexibleGrowMode(self) -> int
+
+ Returns the value that specifies how the sizer grows in the
+ non-flexible direction if there is one.
+
+ :see: `SetNonFlexibleGrowMode`
+ """
return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
def GetRowHeights(*args, **kwargs):
- """GetRowHeights(self) -> wxArrayInt"""
+ """GetRowHeights(self) -> list"""
return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
def GetColWidths(*args, **kwargs):
- """GetColWidths(self) -> wxArrayInt"""
+ """GetColWidths(self) -> list"""
return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
#---------------------------------------------------------------------------
class GBPosition(object):
+ """
+ This class represents the position of an item in a virtual grid of
+ rows and columns managed by a `wx.GridBagSizer`. wxPython has
+ typemaps that will automatically convert from a 2-element sequence of
+ integers to a wx.GBPosition, so you can use the more pythonic
+ representation of the position nearly transparently in Python code.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, int row=0, int col=0) -> GBPosition"""
+ """
+ __init__(self, int row=0, int col=0) -> GBPosition
+
+ This class represents the position of an item in a virtual grid of
+ rows and columns managed by a `wx.GridBagSizer`. wxPython has
+ typemaps that will automatically convert from a 2-element sequence of
+ integers to a wx.GBPosition, so you can use the more pythonic
+ representation of the position nearly transparently in Python code.
+ """
newobj = _core_.new_GBPosition(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
"""Get(self) -> PyObject"""
return _core_.GBPosition_Get(*args, **kwargs)
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.GBPosition'+str(self.Get())
def __len__(self): return len(self.Get())
_core_.GBPosition_swigregister(GBPositionPtr)
class GBSpan(object):
+ """
+ This class is used to hold the row and column spanning attributes of
+ items in a `wx.GridBagSizer`. wxPython has typemaps that will
+ automatically convert from a 2-element sequence of integers to a
+ wx.GBSpan, so you can use the more pythonic representation of the span
+ nearly transparently in Python code.
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, int rowspan=1, int colspan=1) -> GBSpan"""
+ """
+ __init__(self, int rowspan=1, int colspan=1) -> GBSpan
+
+ Construct a new wxGBSpan, optionally setting the rowspan and
+ colspan. The default is (1,1). (Meaning that the item occupies one
+ cell in each direction.
+ """
newobj = _core_.new_GBSpan(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
"""Get(self) -> PyObject"""
return _core_.GBSpan_Get(*args, **kwargs)
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.GBSpan'+str(self.Get())
def __len__(self): return len(self.Get())
_core_.GBSpan_swigregister(GBSpanPtr)
class GBSizerItem(SizerItem):
+ """
+ The wx.GBSizerItem class is used to track the additional data about
+ items in a `wx.GridBagSizer` such as the item's position in the grid
+ and how many rows or columns it spans.
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self) -> GBSizerItem"""
+ """
+ __init__(self) -> GBSizerItem
+
+ Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
+ size will need to be set, as well as a position and span before this
+ item can be used in a Sizer.
+
+ You will probably never need to create a wx.GBSizerItem directly as they
+ are created automatically when the sizer's Add method is called.
+ """
newobj = _core_.new_GBSizerItem(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
def GetPos(*args, **kwargs):
- """GetPos(self) -> GBPosition"""
+ """
+ GetPos(self) -> GBPosition
+
+ Get the grid position of the item
+ """
return _core_.GBSizerItem_GetPos(*args, **kwargs)
def GetPosTuple(self): return self.GetPos().Get()
def GetSpan(*args, **kwargs):
- """GetSpan(self) -> GBSpan"""
+ """
+ GetSpan(self) -> GBSpan
+
+ Get the row and column spanning of the item
+ """
return _core_.GBSizerItem_GetSpan(*args, **kwargs)
def GetSpanTuple(self): return self.GetSpan().Get()
def SetPos(*args, **kwargs):
- """SetPos(self, GBPosition pos) -> bool"""
+ """
+ SetPos(self, GBPosition pos) -> bool
+
+ If the item is already a member of a sizer then first ensure that
+ there is no other item that would intersect with this one at the new
+ position, then set the new position. Returns True if the change is
+ successful and after the next Layout() the item will be moved.
+ """
return _core_.GBSizerItem_SetPos(*args, **kwargs)
def SetSpan(*args, **kwargs):
- """SetSpan(self, GBSpan span) -> bool"""
+ """
+ SetSpan(self, GBSpan span) -> bool
+
+ If the item is already a member of a sizer then first ensure that
+ there is no other item that would intersect with this one with its new
+ spanning size, then set the new spanning. Returns True if the change
+ is successful and after the next Layout() the item will be resized.
+
+ """
return _core_.GBSizerItem_SetSpan(*args, **kwargs)
- def Intersects(*args):
+ def Intersects(*args, **kwargs):
"""
Intersects(self, GBSizerItem other) -> bool
- Intersects(self, GBPosition pos, GBSpan span) -> bool
+
+ Returns True if this item and the other item instersect.
+ """
+ return _core_.GBSizerItem_Intersects(*args, **kwargs)
+
+ def IntersectsPos(*args, **kwargs):
+ """
+ IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
+
+ Returns True if the given pos/span would intersect with this item.
"""
- return _core_.GBSizerItem_Intersects(*args)
+ return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
def GetEndPos(*args, **kwargs):
- """GetEndPos(self, int row, int col)"""
+ """
+ GetEndPos(self) -> GBPosition
+
+ Get the row and column of the endpoint of this item.
+ """
return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
def GetGBSizer(*args, **kwargs):
- """GetGBSizer(self) -> GridBagSizer"""
+ """
+ GetGBSizer(self) -> GridBagSizer
+
+ Get the sizer this item is a member of.
+ """
return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
def SetGBSizer(*args, **kwargs):
- """SetGBSizer(self, GridBagSizer sizer)"""
+ """
+ SetGBSizer(self, GridBagSizer sizer)
+
+ Set the sizer this item is a member of.
+ """
return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
def GBSizerItemWindow(*args, **kwargs):
"""
GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
- int border, Object userData) -> GBSizerItem
+ int border, PyObject userData=None) -> GBSizerItem
+
+ Construct a `wx.GBSizerItem` for a window.
"""
val = _core_.new_GBSizerItemWindow(*args, **kwargs)
val.thisown = 1
def GBSizerItemSizer(*args, **kwargs):
"""
GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
- int border, Object userData) -> GBSizerItem
+ int border, PyObject userData=None) -> GBSizerItem
+
+ Construct a `wx.GBSizerItem` for a sizer
"""
val = _core_.new_GBSizerItemSizer(*args, **kwargs)
val.thisown = 1
def GBSizerItemSpacer(*args, **kwargs):
"""
GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
- int flag, int border, Object userData) -> GBSizerItem
+ int flag, int border, PyObject userData=None) -> GBSizerItem
+
+ Construct a `wx.GBSizerItem` for a spacer.
"""
val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
val.thisown = 1
return val
class GridBagSizer(FlexGridSizer):
+ """
+ A `wx.Sizer` that can lay out items in a virtual grid like a
+ `wx.FlexGridSizer` but in this case explicit positioning of the items
+ is allowed using `wx.GBPosition`, and items can optionally span more
+ than one row and/or column using `wx.GBSpan`. The total size of the
+ virtual grid is determined by the largest row and column that items are
+ positioned at, adjusted for spanning.
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, int vgap=0, int hgap=0) -> GridBagSizer"""
+ """
+ __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
+
+ Constructor, with optional parameters to specify the gap between the
+ rows and columns.
+ """
newobj = _core_.new_GridBagSizer(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
def Add(*args, **kwargs):
"""
- Add(self, PyObject item, GBPosition pos, GBSpan span=DefaultSpan,
- int flag=0, int border=0, PyObject userData=None) -> bool
+ Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
+ int border=0, userData=None)
+
+ Adds an item to the sizer at the grid cell *pos*, optionally spanning
+ more than one row or column as specified with *span*. The remaining
+ args behave similarly to `wx.Sizer.Add`.
+
+ Returns True if the item was successfully placed at the given cell
+ position, False if something was already there.
+
"""
return _core_.GridBagSizer_Add(*args, **kwargs)
def AddItem(*args, **kwargs):
- """AddItem(self, GBSizerItem item) -> bool"""
+ """
+ Add(self, GBSizerItem item) -> bool
+
+ Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
+ the item was successfully placed at its given cell position, False if
+ something was already there.
+ """
return _core_.GridBagSizer_AddItem(*args, **kwargs)
def GetEmptyCellSize(*args, **kwargs):
- """GetEmptyCellSize(self) -> Size"""
+ """
+ GetEmptyCellSize(self) -> Size
+
+ Get the size used for cells in the grid with no item.
+ """
return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
def SetEmptyCellSize(*args, **kwargs):
- """SetEmptyCellSize(self, Size sz)"""
+ """
+ SetEmptyCellSize(self, Size sz)
+
+ Set the size used for cells in the grid with no item.
+ """
return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
def GetItemPosition(*args):
"""
- GetItemPosition(self, Window window) -> GBPosition
- GetItemPosition(self, Sizer sizer) -> GBPosition
- GetItemPosition(self, size_t index) -> GBPosition
+ GetItemPosition(self, item) -> GBPosition
+
+ Get the grid position of the specified *item* where *item* is either a
+ window or subsizer that is a member of this sizer, or a zero-based
+ index of an item.
"""
return _core_.GridBagSizer_GetItemPosition(*args)
def SetItemPosition(*args):
"""
- SetItemPosition(self, Window window, GBPosition pos) -> bool
- SetItemPosition(self, Sizer sizer, GBPosition pos) -> bool
- SetItemPosition(self, size_t index, GBPosition pos) -> bool
+ SetItemPosition(self, item, GBPosition pos) -> bool
+
+ Set the grid position of the specified *item* where *item* is either a
+ window or subsizer that is a member of this sizer, or a zero-based
+ index of an item. Returns True on success. If the move is not
+ allowed (because an item is already there) then False is returned.
+
"""
return _core_.GridBagSizer_SetItemPosition(*args)
def GetItemSpan(*args):
"""
- GetItemSpan(self, Window window) -> GBSpan
- GetItemSpan(self, Sizer sizer) -> GBSpan
- GetItemSpan(self, size_t index) -> GBSpan
+ GetItemSpan(self, item) -> GBSpan
+
+ Get the row/col spanning of the specified *item* where *item* is
+ either a window or subsizer that is a member of this sizer, or a
+ zero-based index of an item.
"""
return _core_.GridBagSizer_GetItemSpan(*args)
def SetItemSpan(*args):
"""
- SetItemSpan(self, Window window, GBSpan span) -> bool
- SetItemSpan(self, Sizer sizer, GBSpan span) -> bool
- SetItemSpan(self, size_t index, GBSpan span) -> bool
+ SetItemSpan(self, item, GBSpan span) -> bool
+
+ Set the row/col spanning of the specified *item* where *item* is
+ either a window or subsizer that is a member of this sizer, or a
+ zero-based index of an item. Returns True on success. If the move is
+ not allowed (because an item is already there) then False is returned.
"""
return _core_.GridBagSizer_SetItemSpan(*args)
def FindItem(*args):
"""
- FindItem(self, Window window) -> GBSizerItem
- FindItem(self, Sizer sizer) -> GBSizerItem
+ FindItem(self, item) -> GBSizerItem
+
+ Find the sizer item for the given window or subsizer, returns None if
+ not found. (non-recursive)
"""
return _core_.GridBagSizer_FindItem(*args)
def FindItemAtPosition(*args, **kwargs):
- """FindItemAtPosition(self, GBPosition pos) -> GBSizerItem"""
+ """
+ FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
+
+ Return the sizer item for the given grid cell, or None if there is no
+ item at that position. (non-recursive)
+ """
return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
def FindItemAtPoint(*args, **kwargs):
- """FindItemAtPoint(self, Point pt) -> GBSizerItem"""
+ """
+ FindItemAtPoint(self, Point pt) -> GBSizerItem
+
+ Return the sizer item located at the point given in *pt*, or None if
+ there is no item at that point. The (x,y) coordinates in pt correspond
+ to the client coordinates of the window using the sizer for
+ layout. (non-recursive)
+ """
return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
- def FindItemWithData(*args, **kwargs):
- """FindItemWithData(self, Object userData) -> GBSizerItem"""
- return _core_.GridBagSizer_FindItemWithData(*args, **kwargs)
+ def CheckForIntersection(*args, **kwargs):
+ """
+ CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
- def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
- return _core_.GridBagSizer_RecalcSizes(*args, **kwargs)
+ Look at all items and see if any intersect (or would overlap) the
+ given *item*. Returns True if so, False if there would be no overlap.
+ If an *excludeItem* is given then it will not be checked for
+ intersection, for example it may be the item we are checking the
+ position of.
- def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
- return _core_.GridBagSizer_CalcMin(*args, **kwargs)
+ """
+ return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
- def CheckForIntersection(*args):
+ def CheckForIntersectionPos(*args, **kwargs):
"""
- CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
- CheckForIntersection(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
+ CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
+
+ Look at all items and see if any intersect (or would overlap) the
+ given position and span. Returns True if so, False if there would be
+ no overlap. If an *excludeItem* is given then it will not be checked
+ for intersection, for example it may be the item we are checking the
+ position of.
"""
- return _core_.GridBagSizer_CheckForIntersection(*args)
+ return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
class GridBagSizerPtr(GridBagSizer):
Absolute = _core_.Absolute
class IndividualLayoutConstraint(Object):
"""
- Objects of this class are stored in the wx.LayoutConstraint class as one of
- eight possible constraints that a window can be involved in. You will never
- need to create an instance of wx.IndividualLayoutConstraint, rather you should
- use create a wx.LayoutContstraints instance and use the individual contstraints
+ Objects of this class are stored in the `wx.LayoutConstraints` class as
+ one of eight possible constraints that a window can be involved in.
+ You will never need to create an instance of
+ wx.IndividualLayoutConstraint, rather you should create a
+ `wx.LayoutConstraints` instance and use the individual contstraints
that it contains.
-
- Constraints are initially set to have the relationship wx.Unconstrained, which
- means that their values should be calculated by looking at known constraints.
-
- The Edge specifies the type of edge or dimension of a window.
-
- Edges
-
- wx.Left The left edge.
- wx.Top The top edge.
- wx.Right The right edge.
- wx.Bottom The bottom edge.
- wx.CentreX The x-coordinate of the centre of the window.
- wx.CentreY The y-coordinate of the centre of the window.
-
-
- The Relationship specifies the relationship that this edge or dimension has
- with another specified edge or dimension. Normally, the user doesn't use these
- directly because functions such as Below and RightOf are a convenience for
- using the more general Set function.
-
- Relationships
-
- wx.Unconstrained The edge or dimension is unconstrained
- (the default for edges.)
- wx.AsIs The edge or dimension is to be taken from the current
- window position or size (the default for dimensions.)
- wx.Above The edge should be above another edge.
- wx.Below The edge should be below another edge.
- wx.LeftOf The edge should be to the left of another edge.
- wx.RightOf The edge should be to the right of another edge.
- wx.SameAs The edge or dimension should be the same as another edge
- or dimension.
- wx.PercentOf The edge or dimension should be a percentage of another
- edge or dimension.
- wx.Absolute The edge or dimension should be a given absolute value.
-
-
"""
def __init__(self): raise RuntimeError, "No constructor defined"
def __repr__(self):
return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def Set(*args, **kwargs):
- """Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)"""
+ """
+ Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
+
+ Sets the properties of the constraint. Normally called by one of the
+ convenience functions such as Above, RightOf, SameAs.
+ """
return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
def LeftOf(*args, **kwargs):
"""
LeftOf(self, Window sibling, int marg=0)
- Sibling relationship
+ Constrains this edge to be to the left of the given window, with an
+ optional margin. Implicitly, this is relative to the left edge of the
+ other window.
"""
return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
"""
RightOf(self, Window sibling, int marg=0)
- Sibling relationship
+ Constrains this edge to be to the right of the given window, with an
+ optional margin. Implicitly, this is relative to the right edge of the
+ other window.
"""
return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
"""
Above(self, Window sibling, int marg=0)
- Sibling relationship
+ Constrains this edge to be above the given window, with an optional
+ margin. Implicitly, this is relative to the top edge of the other
+ window.
"""
return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
"""
Below(self, Window sibling, int marg=0)
- Sibling relationship
+ Constrains this edge to be below the given window, with an optional
+ margin. Implicitly, this is relative to the bottom edge of the other
+ window.
"""
return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
"""
SameAs(self, Window otherW, int edge, int marg=0)
- 'Same edge' alignment
+ Constrains this edge or dimension to be to the same as the edge of the
+ given window, with an optional margin.
"""
return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
"""
PercentOf(self, Window otherW, int wh, int per)
- The edge is a percentage of the other window's edge
+ Constrains this edge or dimension to be to a percentage of the given
+ window, with an optional margin.
"""
return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
"""
Absolute(self, int val)
- Edge has absolute value
+ Constrains this edge or dimension to be the given absolute value.
"""
return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
"""
Unconstrained(self)
- Dimension is unconstrained
+ Sets this edge or dimension to be unconstrained, that is, dependent on
+ other edges and dimensions from which this value can be deduced.
"""
return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
"""
AsIs(self)
- Dimension is 'as is' (use current size settings)
+ Sets this edge or constraint to be whatever the window's value is at
+ the moment. If either of the width and height constraints are *as is*,
+ the window will not be resized, but moved instead. This is important
+ when considering panel items which are intended to have a default
+ size, such as a button, which may take its size from the size of the
+ button label.
"""
return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
class LayoutConstraints(Object):
"""
- Note: constraints are now deprecated and you should use sizers instead.
+ **Note:** constraints are now deprecated and you should use sizers
+ instead.
- Objects of this class can be associated with a window to define its layout
- constraints, with respect to siblings or its parent.
+ Objects of this class can be associated with a window to define its
+ layout constraints, with respect to siblings or its parent.
The class consists of the following eight constraints of class
wx.IndividualLayoutConstraint, some or all of which should be accessed
* centreX: represents the horizontal centre point of the window
* centreY: represents the vertical centre point of the window
- Most constraints are initially set to have the relationship wxUnconstrained,
- which means that their values should be calculated by looking at known
- constraints. The exceptions are width and height, which are set to wxAsIs to
- ensure that if the user does not specify a constraint, the existing width and
- height will be used, to be compatible with panel items which often have take a
- default size. If the constraint is wxAsIs, the dimension will not be changed.
+ Most constraints are initially set to have the relationship
+ wxUnconstrained, which means that their values should be calculated by
+ looking at known constraints. The exceptions are width and height,
+ which are set to wxAsIs to ensure that if the user does not specify a
+ constraint, the existing width and height will be used, to be
+ compatible with panel items which often have take a default size. If
+ the constraint is ``wx.AsIs``, the dimension will not be changed.
+
+ :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
"""
def __repr__(self):
"""
Call the specified function after the current and pending event
handlers have been completed. This is also good for making GUI
- method calls from non-GUI threads.
+ method calls from non-GUI threads. Any extra positional or
+ keyword args are passed on to the callable when it is called.
+
+ :see: `wx.FutureCall`
"""
app = wx.GetApp()
assert app, 'No wxApp created yet'
A convenience class for wx.Timer, that calls the given callable
object once after the given amount of milliseconds, passing any
positional or keyword args. The return value of the callable is
- availbale after it has been run with the GetResult method.
+ availbale after it has been run with the `GetResult` method.
If you don't need to get the return value or restart the timer
then there is no need to hold a reference to this object. It will
has a reference to self.Notify) but the cycle will be broken when
the timer completes, automatically cleaning up the wx.FutureCall
object.
+
+ :see: `wx.CallAfter`
"""
def __init__(self, millis, callable, *args, **kwargs):
self.millis = millis
projects / wxWidgets.git / blobdiff