PreviewTk

class lib.training.preview_tk.PreviewTk(preview_buffer: PreviewBuffer, parent: tk.Widget | None = None, taskbar: ttk.Frame | None = None, triggers: TriggerType | None = None)

Bases: PreviewBase

Holds a preview window for displaying the pop out preview.

Parameters:
  • preview_buffer (PreviewBuffer) – The thread safe object holding the preview images

  • parent (tk.Widget | None) – If this viewer is being called from the GUI the parent widget should be passed in here. If this is a standalone pop-up window then pass None. Default: None

  • taskbar (ttk.Frame | None) – If this viewer is being called from the GUI the parent’s option frame should be passed in here. If this is a standalone pop-up window then pass None. Default: None

  • triggers (TriggerType | None) – Dictionary of event triggers for pop-up preview. Not required when running inside the GUI. Default: None

Attributes Summary

master_frame

The master frame that holds the preview window

Methods Summary

pack(*args, **kwargs)

Redirect calls to pack the widget to pack the actual _master_frame.

remove_option_controls()

Remove the taskbar options controls when the preview is disabled in the GUI

save(location)

Save action to be performed when save button pressed from the GUI.

Attributes Documentation

master_frame

The master frame that holds the preview window

Methods Documentation

pack(*args, **kwargs)

Redirect calls to pack the widget to pack the actual _master_frame.

Takes standard tkinter.Frame pack arguments

remove_option_controls() None

Remove the taskbar options controls when the preview is disabled in the GUI

Return type:

None

save(location: str) None

Save action to be performed when save button pressed from the GUI.

Parameters:

location (str) – Full path to the folder to save the preview image to

Return type:

None

property master_frame: Frame

The master frame that holds the preview window

pack(*args, **kwargs)

Redirect calls to pack the widget to pack the actual _master_frame.

Takes standard tkinter.Frame pack arguments

remove_option_controls() None

Remove the taskbar options controls when the preview is disabled in the GUI

Return type:

None

save(location: str) None

Save action to be performed when save button pressed from the GUI.

Parameters:

location (str) – Full path to the folder to save the preview image to

Return type:

None