wx.WithImages¶
A mixin class to be used with other classes that use a wx.ImageList.
This class is used by classes such as wx.Notebook and wx.TreeCtrl, that use image indices to specify the icons used for their items (page icons for the former or the items inside the control for the latter).
The icon index can either be a special value wx.NO_IMAGE
to indicate that an item doesn’t use an image at all or a small positive integer to specify the index of the icon in the list of images maintained by this class. Note that for many controls, either none of the items should have an icon or all of them should have one, i.e. mixing the items with and without an icon doesn’t always work well and may result in less than ideal appearance.
To initialize the list of icons used, call SetImages
method passing it a vector of wx.BitmapBundle objects which can, in the simplest case, be just wx.Bitmap or wx.Icon objects – however, as always with wx.BitmapBundle, either more than one bitmap or icon needs to be specified or the bitmap bundle needs to be created from SVG
to obtain better appearance in high DPI
.
Alternative, traditional API which was the only one available until wxWidgets 3.1.6, is based on the use of wx.ImageList class. To use it, you need to create an object of this class and then call either AssignImageList
to set this image list and give the control its ownership or SetImageList
to retain the ownership of the image list, which can be useful if the same image list is shared by multiple controls, but requires deleting the image list later.
Note
ImageList-based API is not formally deprecated, but its use is discouraged because it is more complicated than simply providing a vector of bitmaps and it doesn’t allow specifying multiple images or using SVG
, which is required for good high DPI
support. Please don’t use AssignImageList
and SetImageList
in the new code and use SetImages
instead.
Class Hierarchy¶
Known Subclasses¶
Methods Summary¶
Sets the image list for the page control and takes ownership of the list. |
|
Return the number of images in this control. |
|
Returns the associated image list, may be |
|
Returns the image list updated to reflect the |
|
Return |
|
Sets the image list to use. |
|
Set the images to use for the items in the control. |
Properties Summary¶
See |
|
See |
Class API¶
- class wx.WithImages(object)¶
Possible constructors:
WithImages() -> None
A mixin class to be used with other classes that use a ImageList.
Methods¶
- __init__(self)¶
- Return type:
None
- AssignImageList(self, imageList)¶
Sets the image list for the page control and takes ownership of the list.
This function exists for compatibility only, please use
SetImages
in the new code.- Parameters:
imageList (wx.ImageList)
- Return type:
None
See also
- GetImageCount(self)¶
Return the number of images in this control.
The returned value may be 0 if there are no images associated with the control.
- Return type:
int
Added in version 4.1/wxWidgets-3.1.6.
See also
- GetImageList(self)¶
Returns the associated image list, may be
None
.Note that the new code should use
GetUpdatedImageListFor
instead.- Return type:
See also
- GetUpdatedImageListFor(self, win)¶
Returns the image list updated to reflect the
DPI
scaling used for the given window if possible.If
SetImages
has been called, this function creates the image list containing the images using theDPI
scaling in effect for the provided win, which must be valid.Otherwise it behaves as
GetImageList
, i.e. returns the image list previously set usingSetImageList
orAssignImageList
, and just returnsNone
if none of them had been called.- Parameters:
win (wx.Window)
- Return type:
- Returns:
Possibly null pointer owned by this object, i.e. which must not be deleted by the caller.
Added in version 4.1/wxWidgets-3.1.6.
- HasImages(self)¶
Return
True
if the control has any images associated with it.- Return type:
bool
Added in version 4.1/wxWidgets-3.1.6.
See also
- SetImageList(self, imageList)¶
Sets the image list to use.
It does not take ownership of the image list, you must delete it yourself.
This function exists for compatibility only, please use
SetImages
in the new code.- Parameters:
imageList (wx.ImageList)
- Return type:
None
See also
- SetImages(self, images)¶
Set the images to use for the items in the control.
This function allows to specify the images to use in multiple different resolutions, letting the control to select the appropriate one for its
DPI
scaling. For this reason, it should be preferred to using the functions taking wx.ImageList, which has a fixed size, in the new code.- Parameters:
images (Vector) – Non empty vector of bitmap bundles. Valid image indexes for the items in this control are determined by the size of this vector.
- Return type:
None
Added in version 4.1/wxWidgets-3.1.6.
Properties¶
- ImageCount¶
See
GetImageCount
- ImageList¶
See
GetImageList
andSetImageList