spyder.api.widgets

Widgets to extend Spyder through its API.

Classes

PluginMainWidgetActions()	Common menu actions for SpyderDockablePlugins.
PluginMainWidgetWidgets()	Basic widgets any SpyderDockablePlugin has.

class spyder.api.widgets.PluginMainWidgetWidgets

Bases: object

Basic widgets any SpyderDockablePlugin has.

CornerWidget: str = 'corner_widget'

Right-corner pane toolbar buttons, just left of the options button.

MainToolbar: str = 'main_toolbar_widget'

The primary pane toolbar, left-aligned.

OptionsToolButton: str = 'options_button_widget'

The pane’s “hamburger menu”, on the very right of the toolbar area.

Spinner: str = 'spinner_widget'

An optional progress spinner widget in the toolbar.

class spyder.api.widgets.PluginMainWidgetActions

Bases: object

Common menu actions for SpyderDockablePlugins.

ClosePane: str = 'close_pane'

Close the plugin’s pane.

DockPane: str = 'dock_pane'

Re-dock a popped-out pane to the Spyder main window.

UndockPane: str = 'undock_pane'

Pop out a plugin’s pane into a separate floating window.

LockUnlockPosition: str = 'lock_unlock_position'

Toggle whether a pane can be freely moved around the Spyder window.

Modules

auxiliary_widgets	Spyder API auxiliary widgets.
comboboxes	Spyder combobox widgets.
dialogs	Spyder dialog widgets.
main_container	Main container widget.
main_widget	Main plugin widget.
menus	Spyder API menu widgets.
mixins	Spyder API Mixins.
status	Status bar widgets.
toolbars	Spyder API toolbar widgets.