IPluginPreview

class mobase.IPluginPreview

Bases: IPlugin

These plugins add support for previewing files in the data pane. Right now all image formats supported by qt are implemented (including dds) but no audio files and no 3d mesh formats.

Methods Summary

genDataPreview(file_data, filename, max_size)

Generate a preview widget from in-memory data.

genFilePreview(filename, max_size)

Generate a preview widget for the specified file.

supportedExtensions()

supportsArchives()

Check if this preview plugin supports preview from in-memory data.

Methods Documentation

abstract genDataPreview(file_data, filename, max_size)

Generate a preview widget from in-memory data.

Return type:

QWidget

Parameters:
  • file_data – In-memory data to preview.

  • filename – Name of the file the data comes from.

  • max_size – Maximum size of the generated widget.

Returns:

The widget showing a preview of the in-memory data.

abstract genFilePreview(filename, max_size)

Generate a preview widget for the specified file.

Return type:

QWidget

Parameters:
  • filename – Path to the file to preview.

  • max_size – Maximum size of the generated widget.

Returns:

The widget showing a preview of the file.

abstract supportedExtensions()
Return type:

set[str]

Returns:

The list of file extensions that are supported by this preview plugin.

abstract supportsArchives()

Check if this preview plugin supports preview from in-memory data.

Return type:

bool

Returns:

True if the plugin supports preview from raw data, False otherwise.