icons: Set of icons

Set of icons for buttons.

Use getQIcon() to create Qt QIcon from the name identifying an icon.

getIconCache()[source]

Get access to all cached icons

Return type:dict
cleanIconCache()[source]

Clean up the icon cache

class AbstractAnimatedIcon(parent=None)[source]

Store an animated icon.

It provides an event containing the new icon everytime it is updated.

iconChanged

Signal sent with a QIcon everytime the animation changed.

register(obj)[source]

Register an object to the AnimatedIcon. If no object are registred, the animation is paused. Object are stored in a weaked list.

Parameters:obj (object) – An object
unregister(obj)[source]

Remove the object from the registration. If no object are registred the animation is paused.

Parameters:obj (object) – A registered object
hasRegistredObjects()[source]

Returns true if any object is registred.

Return type:bool
isRegistered(obj)[source]

Returns true if the object is registred in the AnimatedIcon.

Parameters:obj (object) – An object
Return type:bool
currentIcon()[source]

Returns the icon of the current frame.

Return type:qt.QIcon
class MovieAnimatedIcon(filename, parent=None)[source]

Store a looping QMovie to provide icons for each frames. Provides an event with the new icon everytime the movie frame is updated.

class MultiImageAnimatedIcon(filename, parent=None)[source]

Store a looping QMovie to provide icons for each frames. Provides an event with the new icon everytime the movie frame is updated.

class AnimatedIcon(filename, parent=None)[source]

Store a looping QMovie to provide icons for each frames. Provides an event with the new icon everytime the movie frame is updated.

It may not be available anymore for the silx release 0.6.

Deprecated since version 0.5: Use MovieAnimatedIcon instead.

getWaitIcon()[source]

Returns a cached version of the waiting AbstractAnimatedIcon.

Return type:AbstractAnimatedIcon
getAnimatedIcon(name)[source]

Create an AbstractAnimatedIcon from a resource name.

The resource name can be prefixed by the name of a resource directory. For example “silx:foo.png” identify the resource “foo.png” from the resource directory “silx”.

If no prefix are specified, the file with be returned from the silx resource directory with a specific path “gui/icons”.

See also silx.resources.register_resource_directory().

Try to load a mng or a gif file, then try to load a multi-image animated icon.

In Qt5 mng or gif are not used, because the transparency is not very well managed.

Parameters:name (str) – Name of the icon, in one of the defined icons in this module.
Returns:Corresponding AbstractAnimatedIcon
Raises:ValueError when name is not known
getQIcon(name)[source]

Create a QIcon from its name.

The resource name can be prefixed by the name of a resource directory. For example “silx:foo.png” identify the resource “foo.png” from the resource directory “silx”.

If no prefix are specified, the file with be returned from the silx resource directory with a specific path “gui/icons”.

See also silx.resources.register_resource_directory().

Parameters:name (str) – Name of the icon, in one of the defined icons in this module.
Returns:Corresponding QIcon
Raises:ValueError when name is not known
getQPixmap(name)[source]

Create a QPixmap from its name.

The resource name can be prefixed by the name of a resource directory. For example “silx:foo.png” identify the resource “foo.png” from the resource directory “silx”.

If no prefix are specified, the file with be returned from the silx resource directory with a specific path “gui/icons”.

See also silx.resources.register_resource_directory().

Parameters:name (str) – Name of the icon, in one of the defined icons in this module.
Returns:Corresponding QPixmap
Raises:ValueError when name is not known
getQFile(name)[source]

Create a QFile from an icon name. Filename is found according to supported Qt formats.

The resource name can be prefixed by the name of a resource directory. For example “silx:foo.png” identify the resource “foo.png” from the resource directory “silx”.

If no prefix are specified, the file with be returned from the silx resource directory with a specific path “gui/icons”.

See also silx.resources.register_resource_directory().

Parameters:name (str) – Name of the icon, in one of the defined icons in this module.
Returns:Corresponding QFile
Return type:qt.QFile
Raises:ValueError when name is not known

Available icons

Icon Name
3d-plane-normal-x 3d-plane-normal-x
3d-plane-normal-y 3d-plane-normal-y
3d-plane-normal-z 3d-plane-normal-z
3d-plane-pan 3d-plane-pan
3d-plane 3d-plane
add-range-horizontal add-range-horizontal
add-shape-arc add-shape-arc
add-shape-circle add-shape-circle
add-shape-cross add-shape-cross
add-shape-diagonal add-shape-diagonal
add-shape-ellipse add-shape-ellipse
add-shape-horizontal add-shape-horizontal
add-shape-point add-shape-point
add-shape-polygon add-shape-polygon
add-shape-rectangle add-shape-rectangle
add-shape-unknown add-shape-unknown
add-shape-vertical add-shape-vertical
add add
aggregation-mode aggregation-mode
arrow-keys arrow-keys
axis axis
backend-opengl backend-opengl
camera camera
clipboard clipboard
close close
colorbar colorbar
colormap-histogram colormap-histogram
colormap-none colormap-none
colormap-norm-arcsinh colormap-norm-arcsinh
colormap-norm-gamma colormap-norm-gamma
colormap-norm-linear colormap-norm-linear
colormap-norm-log colormap-norm-log
colormap-norm-sqrt colormap-norm-sqrt
colormap-range colormap-range
colormap colormap
compare-align-auto compare-align-auto
compare-align-center compare-align-center
compare-align-origin compare-align-origin
compare-align-stretch compare-align-stretch
compare-keypoints compare-keypoints
compare-mode-a-minus-b compare-mode-a-minus-b
compare-mode-a compare-mode-a
compare-mode-b compare-mode-b
compare-mode-hline compare-mode-hline
compare-mode-rb-channel compare-mode-rb-channel
compare-mode-rbneg-channel compare-mode-rbneg-channel
compare-mode-vline compare-mode-vline
crop crop
crosshair crosshair
cube-back cube-back
cube-bottom cube-bottom
cube-front cube-front
cube-left cube-left
cube-right cube-right
cube-rotate cube-rotate
cube-top cube-top
cube cube
description-description description-description
description-error description-error
description-name description-name
description-program description-program
description-title description-title
description-value description-value
document-open document-open
document-print document-print
document-save document-save
draw-brush draw-brush
draw-pencil draw-pencil
draw-rubber draw-rubber
edit-copy edit-copy
eye eye
first first
folder folder
image-mask image-mask
image-select-add image-select-add
image-select-box image-select-box
image-select-brush image-select-brush
image-select-erase-rubber image-select-erase-rubber
image-select-erase image-select-erase
image image
item-0dim item-0dim
item-1dim item-1dim
item-2dim item-2dim
item-3dim item-3dim
item-ndim item-ndim
item-none item-none
item-object item-object
last last
layer-nx layer-nx
mask-clear-all mask-clear-all
mask-clear mask-clear
mask-invert mask-invert
math-amplitude math-amplitude
math-average math-average
math-derive math-derive
math-energy math-energy
math-fit math-fit
math-imaginary math-imaginary
math-mean math-mean
math-normalize math-normalize
math-peak-reset math-peak-reset
math-peak-search math-peak-search
math-peak math-peak
math-phase-color-log math-phase-color-log
math-phase-color math-phase-color
math-phase math-phase
math-real math-real
math-sigma math-sigma
math-smooth math-smooth
math-square-amplitude math-square-amplitude
math-substract math-substract
math-swap-sign math-swap-sign
math-ymin-to-zero math-ymin-to-zero
median-filter median-filter
next next
normal normal
nxdata-axis-add nxdata-axis-add
nxdata-axis-remove nxdata-axis-remove
nxdata-create nxdata-create
nxdata-remove nxdata-remove
pan pan
pixel-intensities pixel-intensities
plot-grid plot-grid
plot-roi-above plot-roi-above
plot-roi-below plot-roi-below
plot-roi-between plot-roi-between
plot-roi-reset plot-roi-reset
plot-roi plot-roi
plot-symbols plot-symbols
plot-toggle-points plot-toggle-points
plot-widget plot-widget
plot-window-image plot-window-image
plot-window plot-window
plot-xauto plot-xauto
plot-xlog plot-xlog
plot-yauto plot-yauto
plot-ydown plot-ydown
plot-ylog plot-ylog
plot-yup plot-yup
pointing-hand pointing-hand
previous previous
profile-clear profile-clear
profile1D profile1D
profile2D profile2D
remove remove
rm rm
rotate-3d rotate-3d
rudder rudder
selected selected
shape-circle-solid shape-circle-solid
shape-circle shape-circle
shape-cross shape-cross
shape-diagonal-directed shape-diagonal-directed
shape-diagonal shape-diagonal
shape-ellipse-solid shape-ellipse-solid
shape-ellipse shape-ellipse
shape-horizontal shape-horizontal
shape-polygon shape-polygon
shape-rectangle shape-rectangle
shape-square shape-square
shape-vertical shape-vertical
side-histograms side-histograms
silx silx
slice-cross slice-cross
slice-horizontal slice-horizontal
slice-vertical slice-vertical
sliders-off sliders-off
sliders-on sliders-on
spec spec
stats-active-items stats-active-items
stats-visible-data stats-visible-data
stats-whole-data stats-whole-data
stats-whole-items stats-whole-items
tree-collapse-all tree-collapse-all
tree-expand-all tree-expand-all
tree-sort tree-sort
view-1d view-1d
view-2d-stack view-2d-stack
view-2d view-2d
view-3d view-3d
view-fullscreen view-fullscreen
view-hdf5 view-hdf5
view-nexus view-nexus
view-nofullscreen view-nofullscreen
view-raw view-raw
view-refresh view-refresh
view-text view-text
window-new window-new
zoom-back zoom-back
zoom-in zoom-in
zoom-original zoom-original
zoom-out zoom-out
zoom zoom