Panneau#

Fonctionnalités de base#

cdl.core.gui.panel.base.is_plot_item_serializable(item: ShapeTypes) → bool[source]#

Renvoie True si l’élément de tracé est sérialisable

class cdl.core.gui.panel.base.ObjectProp(panel: BaseDataPanel, paramclass: SignalObj | ImageObj)[source]#

Objet gérant les propriétés du panneau

add_button(button)[source]#

Add additional button on bottom of properties panel

set_param_label(param: SignalObj | ImageObj)[source]#

Set computing parameters label

update_properties_from(param: SignalObj | ImageObj | None = None)[source]#

Update properties from signal/image dataset

class cdl.core.gui.panel.base.AbstractPanelMeta(name, bases, namespace, /, **kwargs)[source]#

Mixed metaclass to avoid conflicts

class cdl.core.gui.panel.base.AbstractPanel(parent)[source]#

Object defining DataLab panel interface, based on a vertical QSplitter widget

A panel handle an object list (objects are signals, images, macros…). Each object must implement cdl.core.gui.ObjItf interface

get_serializable_name(obj: ObjItf) → str[source]#

Return serializable name of object

serialize_object_to_hdf5(obj: ObjItf, writer: NativeH5Writer) → None[source]#

Serialize object to HDF5 file

deserialize_object_from_hdf5(reader: NativeH5Reader, name: str) → ObjItf[source]#

Deserialize object from a HDF5 file

abstract serialize_to_hdf5(writer: NativeH5Writer) → None[source]#

Serialize whole panel to a HDF5 file

abstract deserialize_from_hdf5(reader: NativeH5Reader) → None[source]#

Deserialize whole panel from a HDF5 file

abstract create_object() → ObjItf[source]#

Create and return object

abstract add_object(obj: ObjItf) → None[source]#

Add object to panel

abstract remove_all_objects()[source]#

Remove all objects

class cdl.core.gui.panel.base.ResultData(results: list[ResultShape | ResultProperties] = None, xlabels: list[str] = None, ylabels: list[str] = None)[source]#

Result data associated to a shapetype

cdl.core.gui.panel.base.create_resultdata_dict(objs: list[SignalObj | ImageObj]) → dict[str, ResultData][source]#

Return result data dictionary

Paramètres:

objs – List of objects

Renvoie:

keys are result categories, values are ResultData

Type renvoyé:

Result data dictionary

class cdl.core.gui.panel.base.PasteMetadataParam[source]#

Paste metadata parameters

keep_roi#

Par défaut : True.

Type:

guidata.dataset.dataitems.BoolItem

keep_resultshapes#

Par défaut : False.

Type:

guidata.dataset.dataitems.BoolItem

keep_annotations#

Par défaut : True.

Type:

guidata.dataset.dataitems.BoolItem

keep_resultproperties#

Par défaut : False.

Type:

guidata.dataset.dataitems.BoolItem

keep_other#

Par défaut : True.

Type:

guidata.dataset.dataitems.BoolItem

classmethod create(keep_roi: bool, keep_resultshapes: bool, keep_annotations: bool, keep_resultproperties: bool, keep_other: bool) → cdl.core.gui.panel.base.PasteMetadataParam#

Renvoie une nouvelle instance de PasteMetadataParam avec les champs initialisés aux valeurs données.

Paramètres:

• keep_roi (bool) – Par défaut : True.

• keep_resultshapes (bool) – Par défaut : False.

• keep_annotations (bool) – Par défaut : True.

• keep_resultproperties (bool) – Par défaut : False.

• keep_other (bool) – Par défaut : True.

Renvoie:

Nouvelle instance de PasteMetadataParam.

class cdl.core.gui.panel.base.BaseDataPanel(parent: QWidget)[source]#

Object handling the item list, the selected item properties and plot

abstract static get_roieditor_class() → Type[TypeROIEditor][source]#

Return ROI editor class

closeEvent(event)[source]#

Reimplement QMainWindow method

plot_item_parameters_changed(item: CurveItem | MaskedImageItem | LabelItem) → None[source]#

Plot items changed: update metadata of all objects from plot items

plot_item_moved(item: LabelItem, x0: float, y0: float, x1: float, y1: float) → None[source]#

Plot item moved: update metadata of all objects from plot items

Paramètres:

• item – Plot item

• x0 – new x0 coordinate

• y0 – new y0 coordinate

• x1 – new x1 coordinate

• y1 – new y1 coordinate

serialize_object_to_hdf5(obj: TypeObj, writer: NativeH5Writer) → None[source]#

Serialize object to HDF5 file

serialize_to_hdf5(writer: NativeH5Writer) → None[source]#

Serialize whole panel to a HDF5 file

deserialize_from_hdf5(reader: NativeH5Reader) → None[source]#

Deserialize whole panel from a HDF5 file

create_object() → TypeObj[source]#

Create object (signal or image)

Renvoie:

SignalObj or ImageObj object

add_object(obj: TypeObj, group_id: str | None = None, set_current: bool = True) → None[source]#

Add object

Paramètres:

• obj – SignalObj or ImageObj object

• group_id – group id

• set_current – if True, set the added object as current

remove_all_objects() → None[source]#

Remove all objects

setup_panel() → None[source]#

Setup panel

refresh_plot(what: str, update_items: bool = True, force: bool = False) → None[source]#

Refresh plot. This method simply emits the signal SIG_REFRESH_PLOT which is connected to the method PlotHandler.refresh_plot.

Paramètres:

• what – string describing the objects to refresh. Valid values are « selected » (refresh the selected objects), « all » (refresh all objects), « existing » (refresh existing plot items), or an object uuid.

• update_items – if True, update the items. If False, only show the items (do not update them, except if the option « Use reference item LUT range » is enabled and more than one item is selected). Defaults to True.

• force – if True, force refresh even if auto refresh is disabled, and refresh all items associated to objects (even the hidden ones, e.g. when selecting multiple images of the same size and position). Defaults to False.

Lève:

ValueError – if what is not a valid value

manual_refresh() → None[source]#

Manual refresh

get_category_actions(category: ActionCategory) → list[QAction][source]#

Return actions for category

get_context_menu() → QMenu[source]#

Update and return context menu

add_group(title: str, select: bool = False) → ObjectGroup[source]#

Add group

Paramètres:

• title – group title

• select – if True, select the group in the tree view. Defaults to False.

Renvoie:

Created group object

duplicate_object() → None[source]#

Duplication signal/image object

copy_metadata() → None[source]#

Copy object metadata

paste_metadata(param: PasteMetadataParam | None = None) → None[source]#

Paste metadata to selected object(s)

remove_object(force: bool = False) → None[source]#

Remove signal/image object

Paramètres:

force – if True, remove object without confirmation. Defaults to False.

delete_all_objects() → None[source]#

Confirm before removing all objects

delete_metadata(refresh_plot: bool = True, keep_roi: bool | None = None) → None[source]#

Delete metadata of selected objects

Paramètres:

• refresh_plot – Refresh plot. Defaults to True.

• keep_roi – Keep regions of interest, if any. Defaults to None (ask user).

add_annotations_from_items(items: list, refresh_plot: bool = True) → None[source]#

Add object annotations (annotation plot items).

Paramètres:

• items – annotation plot items

• refresh_plot – refresh plot. Defaults to True.

update_metadata_view_settings() → None[source]#

Update metadata view settings

copy_titles_to_clipboard() → None[source]#

Copy object titles to clipboard (for reproducibility)

new_group() → None[source]#

Create a new group

rename_selected_object_or_group(new_name: str | None = None) → None[source]#

Rename selected object or group

Paramètres:

new_name – new name (default: None, i.e. ask user)

abstract get_newparam_from_current(newparam: NewSignalParam | NewImageParam | None = None) → NewSignalParam | NewImageParam | None[source]#

Get new object parameters from the current object.

Paramètres:

newparam – new object parameters. If None, create a new one.

Renvoie:

New object parameters

abstract new_object(newparam: NewSignalParam | NewImageParam | None = None, addparam: gds.DataSet | None = None, edit: bool = True, add_to_panel: bool = True) → TypeObj | None[source]#

Create a new object (signal/image).

Paramètres:

• newparam – new object parameters

• addparam – additional parameters

• edit – Open a dialog box to edit parameters (default: True)

• add_to_panel – Add object to panel (default: True)

Renvoie:

New object

set_current_object_title(title: str) → None[source]#

Set current object title

load_from_directory(directory: str | None = None) → list[TypeObj][source]#

Open objects from directory (signals or images, depending on the panel), add them to DataLab and return them. If the directory is not specified, ask the user to select a directory.

Paramètres:

directory – directory name

Renvoie:

list of new objects

load_from_files(filenames: list[str] | None = None, ignore_unknown: bool = False) → list[TypeObj][source]#

Open objects from file (signals/images), add them to DataLab and return them.

Paramètres:

• filenames – File names

• ignore_unknown – if True, ignore unknown file types (default: False)

Renvoie:

list of new objects

save_to_files(filenames: list[str] | str | None = None) → None[source]#

Save selected objects to files (signal/image).

Paramètres:

filenames – File names

handle_dropped_files(filenames: list[str] | None = None) → None[source]#

Handle dropped files

Paramètres:

filenames – File names

Renvoie:

None

exec_import_wizard() → None[source]#

Execute import wizard

import_metadata_from_file(filename: str | None = None) → None[source]#

Import metadata from file (JSON).

Paramètres:

filename – File name

export_metadata_from_file(filename: str | None = None) → None[source]#

Export metadata to file (JSON).

Paramètres:

filename – File name

selection_changed(update_items: bool = False) → None[source]#

Object selection changed: update object properties, refresh plot and update object view.

Paramètres:

update_items – Update plot items (default: False)

properties_changed() → None[source]#

The properties “Apply” button was clicked: update object properties, refresh plot and update object view.

add_plot_items_to_dialog(dlg: PlotDialog, oids: list[str]) → None[source]#

Add plot items to dialog

Paramètres:

• dlg – Dialog

• oids – Object IDs

open_separate_view(oids: list[str] | None = None, edit_annotations: bool = False) → PlotDialog | None[source]#

Open separate view for visualizing selected objects

Paramètres:

• oids – Object IDs (default: None)

• edit_annotations – Edit annotations (default: False)

Renvoie:

Instance of PlotDialog

create_new_dialog(edit: bool = False, toolbar: bool = True, title: str | None = None, name: str | None = None, options: dict | None = None) → PlotDialog | None[source]#

Create new pop-up signal/image plot dialog.

Paramètres:

• edit – Edit mode

• toolbar – Show toolbar

• title – Dialog title

• name – Dialog object name

• options – Plot options

Renvoie:

Plot dialog instance

get_roi_editor_output(extract: bool) → tuple[TypeROI, bool] | None[source]#

Get ROI data (array) from specific dialog box.

Paramètres:

extract – Extract ROI from data

Renvoie:

A tuple containing the ROI object and a boolean indicating whether the dialog was accepted or not.

get_objects_with_dialog(title: str, comment: str = '', nb_objects: int = 1, parent: QWidget | None = None) → TypeObj | None[source]#

Get object with dialog box.

Paramètres:

• title – Dialog title

• comment – Optional dialog comment

• nb_objects – Number of objects to select

• parent – Parent widget

Renvoie:

Object(s) (signal(s) or image(s), or None if dialog was canceled)

add_objprop_buttons() → None[source]#

Insert additional buttons in object properties panel

show_results() → None[source]#

Show results

plot_results() → None[source]#

Plot results

delete_results() → None[source]#

Delete results

add_label_with_title(title: str | None = None) → None[source]#

Add a label with object title on the associated plot

Paramètres:

title – Label title. Defaults to None. If None, the title is the object title.

Signal panel#

class cdl.core.gui.panel.signal.SignalPanel(parent: QW.QWidget, dockableplotwidget: DockablePlotWidget, panel_toolbar: QW.QToolBar)[source]#

Object handling the item list, the selected item properties and plot, specialized for Signal objects

PARAMCLASS#

Signal object

uuid#

Par défaut : None.

Type:

guidata.dataset.dataitems.StringItem

xydata#

Données. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatArrayItem

metadata#

Métadonnées. Par défaut : {}.

Type:

guidata.dataset.dataitems.DictItem

title#

Titre du signal. Par défaut : “Sans titre”.

Type:

guidata.dataset.dataitems.StringItem

xlabel#

Titre. Par défaut : “”.

Type:

guidata.dataset.dataitems.StringItem

xunit#

Unité. Par défaut : “”.

Type:

guidata.dataset.dataitems.StringItem

ylabel#

Titre. Par défaut : “”.

Type:

guidata.dataset.dataitems.StringItem

yunit#

Unité. Par défaut : “”.

Type:

guidata.dataset.dataitems.StringItem

autoscale#

Par défaut : True.

Type:

guidata.dataset.dataitems.BoolItem

xscalelog#

Par défaut : False.

Type:

guidata.dataset.dataitems.BoolItem

xscalemin#

Borne inférieure. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatItem

xscalemax#

Borne supérieure. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatItem

yscalelog#

Par défaut : False.

Type:

guidata.dataset.dataitems.BoolItem

yscalemin#

Borne inférieure. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatItem

yscalemax#

Borne supérieure. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatItem

alias de SignalObj

classmethod PARAMCLASS.create(uuid: str, xydata: numpy.ndarray, metadata: dict, title: str, xlabel: str, xunit: str, ylabel: str, yunit: str, autoscale: bool, xscalelog: bool, xscalemin: float, xscalemax: float, yscalelog: bool, yscalemin: float, yscalemax: float) → cdl.core.model.signal.SignalObj#

Renvoie une nouvelle instance de SignalObj avec les champs initialisés aux valeurs données.

Paramètres:

• uuid (str) – Par défaut : None.

• xydata (numpy.ndarray) – Données. Par défaut : None.

• metadata (dict) – Métadonnées. Par défaut : {}.

• title (str) – Titre du signal. Par défaut : “Sans titre”.

• xlabel (str) – Titre. Par défaut : “”.

• xunit (str) – Unité. Par défaut : “”.

• ylabel (str) – Titre. Par défaut : “”.

• yunit (str) – Unité. Par défaut : “”.

• autoscale (bool) – Par défaut : True.

• xscalelog (bool) – Par défaut : False.

• xscalemin (float) – Borne inférieure. Par défaut : None.

• xscalemax (float) – Borne supérieure. Par défaut : None.

• yscalelog (bool) – Par défaut : False.

• yscalemin (float) – Borne inférieure. Par défaut : None.

• yscalemax (float) – Borne supérieure. Par défaut : None.

Renvoie:

Nouvelle instance de SignalObj.

IO_REGISTRY#

alias de SignalIORegistry

static get_roieditor_class() → Type[SignalROIEditor][source]#

Return ROI editor class

get_newparam_from_current(newparam: NewSignalParam | None = None, title: str | None = None) → NewSignalParam | None[source]#

Get new object parameters from the current object.

Paramètres:

• newparam (guidata.dataset.DataSet) – new object parameters. If None, create a new one.

• title – new object title. If None, use the current object title, or the default title.

Renvoie:

New object parameters

new_object(newparam: NewSignalParam | None = None, addparam: gds.DataSet | None = None, edit: bool = True, add_to_panel: bool = True) → SignalObj | None[source]#

Create a new object (signal).

Paramètres:

• newparam (guidata.dataset.DataSet) – new object parameters

• addparam (guidata.dataset.DataSet) – additional parameters

• edit (bool) – Open a dialog box to edit parameters (default: True)

• add_to_panel (bool) – Add the new object to the panel (default: True)

Renvoie:

New object

toggle_anti_aliasing(state: bool) → None[source]#

Toggle anti-aliasing on/off

Paramètres:

state – state of the anti-aliasing

reset_curve_styles() → None[source]#

Reset curve styles

Image panel#

class cdl.core.gui.panel.image.ImagePanel(parent: QW.QWidget, dockableplotwidget: DockablePlotWidget, panel_toolbar: QW.QToolBar)[source]#

Object handling the item list, the selected item properties and plot, specialized for Image objects

PARAMCLASS#

Image object

uuid#

Par défaut : None.

Type:

guidata.dataset.dataitems.StringItem

data#

Données. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatArrayItem

metadata#

Métadonnées. Par défaut : {}.

Type:

guidata.dataset.dataitems.DictItem

x0#

X₀. Par défaut : 0.0.

Type:

guidata.dataset.dataitems.FloatItem

y0#

Y₀. Par défaut : 0.0.

Type:

guidata.dataset.dataitems.FloatItem

dx#

Δx. Flottant, non nul. Par défaut : 1.0.

Type:

guidata.dataset.dataitems.FloatItem

dy#

Δy. Flottant, non nul. Par défaut : 1.0.

Type:

guidata.dataset.dataitems.FloatItem

title#

Titre de l’image. Par défaut : “Sans titre”.

Type:

guidata.dataset.dataitems.StringItem

xlabel#

Titre. Par défaut : “”.

Type:

guidata.dataset.dataitems.StringItem

xunit#

Unité. Par défaut : “”.

Type:

guidata.dataset.dataitems.StringItem

ylabel#

Titre. Par défaut : “”.

Type:

guidata.dataset.dataitems.StringItem

yunit#

Unité. Par défaut : “”.

Type:

guidata.dataset.dataitems.StringItem

zlabel#

Titre. Par défaut : “”.

Type:

guidata.dataset.dataitems.StringItem

zunit#

Unité. Par défaut : “”.

Type:

guidata.dataset.dataitems.StringItem

autoscale#

Par défaut : True.

Type:

guidata.dataset.dataitems.BoolItem

xscalelog#

Par défaut : False.

Type:

guidata.dataset.dataitems.BoolItem

xscalemin#

Borne inférieure. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatItem

xscalemax#

Borne supérieure. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatItem

yscalelog#

Par défaut : False.

Type:

guidata.dataset.dataitems.BoolItem

yscalemin#

Borne inférieure. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatItem

yscalemax#

Borne supérieure. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatItem

zscalemin#

Borne inférieure. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatItem

zscalemax#

Borne supérieure. Par défaut : None.

Type:

guidata.dataset.dataitems.FloatItem

alias de ImageObj

classmethod PARAMCLASS.create(uuid: str, data: numpy.ndarray, metadata: dict, x0: float, y0: float, dx: float, dy: float, title: str, xlabel: str, xunit: str, ylabel: str, yunit: str, zlabel: str, zunit: str, autoscale: bool, xscalelog: bool, xscalemin: float, xscalemax: float, yscalelog: bool, yscalemin: float, yscalemax: float, zscalemin: float, zscalemax: float) → cdl.core.model.image.ImageObj#

Renvoie une nouvelle instance de ImageObj avec les champs initialisés aux valeurs données.

Paramètres:

• uuid (str) – Par défaut : None.

• data (numpy.ndarray) – Données. Par défaut : None.

• metadata (dict) – Métadonnées. Par défaut : {}.

• x0 (float) – X₀. Par défaut : 0.0.

• y0 (float) – Y₀. Par défaut : 0.0.

• dx (float) – Δx. Flottant, non nul. Par défaut : 1.0.

• dy (float) – Δy. Flottant, non nul. Par défaut : 1.0.

• title (str) – Titre de l’image. Par défaut : “Sans titre”.

• xlabel (str) – Titre. Par défaut : “”.

• xunit (str) – Unité. Par défaut : “”.

• ylabel (str) – Titre. Par défaut : “”.

• yunit (str) – Unité. Par défaut : “”.

• zlabel (str) – Titre. Par défaut : “”.

• zunit (str) – Unité. Par défaut : “”.

• autoscale (bool) – Par défaut : True.

• xscalelog (bool) – Par défaut : False.

• xscalemin (float) – Borne inférieure. Par défaut : None.

• xscalemax (float) – Borne supérieure. Par défaut : None.

• yscalelog (bool) – Par défaut : False.

• yscalemin (float) – Borne inférieure. Par défaut : None.

• yscalemax (float) – Borne supérieure. Par défaut : None.

• zscalemin (float) – Borne inférieure. Par défaut : None.

• zscalemax (float) – Borne supérieure. Par défaut : None.

Renvoie:

Nouvelle instance de ImageObj.

IO_REGISTRY#

alias de ImageIORegistry

static get_roieditor_class() → Type[ImageROIEditor][source]#

Return ROI editor class

plot_lut_changed(plot: BasePlot) → None[source]#

The LUT of the plot has changed: updating image objects accordingly

Paramètres:

plot – Plot object

get_newparam_from_current(newparam: NewImageParam | None = None, title: str | None = None) → NewImageParam | None[source]#

Get new object parameters from the current object.

Paramètres:

• newparam (guidata.dataset.DataSet) – new object parameters. If None, create a new one.

• title – new object title. If None, use the current object title, or the default title.

Renvoie:

New object parameters

new_object(newparam: NewImageParam | None = None, addparam: gds.DataSet | None = None, edit: bool = True, add_to_panel: bool = True) → ImageObj | None[source]#

Create a new object (image).

Paramètres:

• newparam (Daguidata.dataset.datatypes.DataSettaSet) – new object parameters

• addparam (guidata.dataset.DataSet) – additional parameters

• edit (bool) – Open a dialog box to edit parameters (default: True)

• add_to_panel (bool) – Add the object to the panel (default: True)

Renvoie:

New object

toggle_show_contrast(state: bool) → None[source]#

Toggle show contrast option

Macro panel#

class cdl.core.gui.panel.macro.MacroTabs(parent=None)[source]#

Macro tabwidget

Paramètres:

parent (QWidget) – Parent widget

clear() → None[source]#

Override Qt method

contextMenuEvent(event)[source]#

Override Qt method

add_tab(macro: Macro) → int[source]#

Add tab

Paramètres:

macro – Macro object

Renvoie:

Number of the tab (starting at 1)

Type renvoyé:

int

remove_tab(number: int) → None[source]#

Remove tab

Paramètres:

number – Number of the tab (starting at 1)

get_widget(number: int) → CodeEditor[source]#

Return macro editor widget at number

Paramètres:

number – Number of the tab (starting at 1)

Renvoie:

Macro editor widget

set_current_number(number: int) → None[source]#

Set current tab number

Paramètres:

number – Number of the tab (starting at 1)

get_current_number() → int[source]#

Return current tab number

Renvoie:

Number of the tab (starting at 1)

Type renvoyé:

int

set_tab_title(number: int, name: str) → None[source]#

Set tab title

Paramètres:

• number – Number of the tab (starting at 1)

• name – Macro name

class cdl.core.gui.panel.macro.MacroPanel(parent: QWidget | None = None)[source]#

Macro Panel widget

Paramètres:

parent (QWidget) – Parent widget

update_color_mode() → None[source]#

Update color mode according to the current theme

get_serializable_name(obj: Macro) → str[source]#

Return serializable name of object

serialize_to_hdf5(writer: NativeH5Writer) → None[source]#

Serialize whole panel to a HDF5 file

Paramètres:

writer – HDF5 writer

deserialize_from_hdf5(reader: NativeH5Reader) → None[source]#

Deserialize whole panel from a HDF5 file

Paramètres:

reader – HDF5 reader

create_object() → Macro[source]#

Create object.

Renvoie:

Macro object

add_object(obj: Macro) → None[source]#

Add object.

Paramètres:

obj – Macro object

remove_all_objects() → None[source]#

Remove all objects

setup_actions() → None[source]#

Setup macro menu actions

get_macro(number_or_title: int | str | None = None) → Macro | None[source]#

Return macro at number (if number is None, return current macro)

Paramètres:

number – Number of the macro (starting at 1) or title of the macro. Defaults to None (current macro).

Renvoie:

Macro object or None (if not found)

get_number_from_title(title: str) → int | None[source]#

Return macro number from title

Paramètres:

title – Title of the macro

Renvoie:

Number of the macro (starting at 1) or None (if not found)

get_number_from_macro(macro: Macro) → int | None[source]#

Return macro number from macro object

Paramètres:

macro – Macro object

Renvoie:

Number of the macro (starting at 1) or None (if not found)

get_macro_titles() → list[str][source]#

Return list of macro titles

macro_contents_changed() → None[source]#

One of the macro contents has changed

run_macro(number_or_title: int | str | None = None) → None[source]#

Run current macro

Paramètres:

number – Number of the macro (starting at 1). Defaults to None (run current macro, or does nothing if there is no macro).

stop_macro(number_or_title: int | str | None = None) → None[source]#

Stop current macro

Paramètres:

number – Number of the macro (starting at 1). Defaults to None (run current macro, or does nothing if there is no macro).

macro_state_changed(orig_macro: Macro, state: bool) → None[source]#

Macro state has changed (True: started, False: stopped)

Paramètres:

• orig_macro – Macro object

• state – State of the macro

add_macro() → Macro[source]#

Add macro, optionally with name

Renvoie:

Macro object

macro_name_changed(name: str) → None[source]#

Macro name has been changed

Paramètres:

name – New name of the macro

rename_macro(number: int | None = None, title: str | None = None) → None[source]#

Rename macro

Paramètres:

• number – Number of the macro (starting at 1). Defaults to None.

• title – Title of the macro. Defaults to None.

export_macro_to_file(number_or_title: int | str | None = None, filename: str | None = None) → None[source]#

Export macro to file

Paramètres:

• number_or_title – Number of the macro (starting at 1) or title of the macro. Defaults to None.

• filename – Filename. Defaults to None.

Lève:

ValueError – If title is not found

import_macro_from_file(filename: str | None = None) → int[source]#

Import macro from file

Paramètres:

filename – Filename. Defaults to None.

Renvoie:

Number of the macro (starting at 1)

remove_macro(number_or_title: int | str | None = None) → None[source]#

Remove macro

Paramètres:

number_or_title – Number of the macro (starting at 1) or title of the macro. Defaults to None.