Skip to content

Components

GUI components in PySide6.

Classes:

Name Description
BaseGroupBox

Base class for group boxes with common functionality.
PathSelectorWidget

Handles logic for selecting a path.
RootPathSelectorWidget

Handles logic for selecting a root path.
DestPathSelectorWidget

Handles logic for selecting a destination path.
FileCountWidget

Handles logic for file count settings.
FolderCreatorWidget

Handles logic for creating folders.
FilenameWidget

Handles logic for filename template settings.
TransferModeWidget

Handles logic for mode settings.
ListIncludeExcludeFilterWidget

Handles the Include/Exclude pattern for Keywords and Extensions.
ExtensionsFilterWidget

Handles the Include/Exclude pattern for file extensions.
KeywordsFilterWidget

Handles the Include/Exclude pattern for keywords.
MinMaxFilterWidget

Handles logic for ranges (Min/Max), e.g., Size or Duration.
SizeFilterWidget

Handles logic for size range filter.
DurationFilterWidget

Handles logic for duration range filter.
SizeLimitWidget

Handles logic for output folder size limit.
FolderSizeLimitWidget

Handles logic for per-folder size limit.
TotalSizeLimitWidget

Handles logic for total size limit across all folders.
OptionsWidget

Handles logic for miscellaneous options.
ProgressWidget

Progress bars and execution controls.
LoggingWidget

Logging widget.
ProgressBinder

Class for binding progress widgets.

BaseGroupBox(title: str, name: str, *, checkable: bool = False)

Bases: QGroupBox

Base class for group boxes with common functionality.

Initialize the base group box.

PathSelectorWidget(title: str, name: str, items: Sequence[str])

Bases: BaseGroupBox

Handles logic for selecting a path.

Initialize the path selector widget.

Methods:

Name Description
dragEnterEvent

Handle drag enter event for folder paths.
dropEvent

Handle drop event for folder paths.
browse

Return the browse button.
delete_curr_item

Delete the currently selected item.
open

Open the currently selected path in file explorer.
get_config

Return clean data for the config.

dragEnterEvent(event: QDragEnterEvent) -> None

Handle drag enter event for folder paths.

dropEvent(event: QDropEvent) -> None

Handle drop event for folder paths.

browse() -> None

Return the browse button.

delete_curr_item() -> None

Delete the currently selected item.

open() -> None

Open the currently selected path in file explorer.

get_config() -> str

Return clean data for the config.

RootPathSelectorWidget()

Bases: PathSelectorWidget

Handles logic for selecting a root path.

Initialize the root path selector widget.

Methods:

Name Description
dragEnterEvent

Handle drag enter event for folder paths.
dropEvent

Handle drop event for folder paths.
browse

Return the browse button.
delete_curr_item

Delete the currently selected item.
open

Open the currently selected path in file explorer.
get_config

Return clean data for the config.

dragEnterEvent(event: QDragEnterEvent) -> None

Handle drag enter event for folder paths.

dropEvent(event: QDropEvent) -> None

Handle drop event for folder paths.

browse() -> None

Return the browse button.

delete_curr_item() -> None

Delete the currently selected item.

open() -> None

Open the currently selected path in file explorer.

get_config() -> str

Return clean data for the config.

DestPathSelectorWidget()

Bases: PathSelectorWidget

Handles logic for selecting a destination path.

Initialize the destination path selector widget.

Methods:

Name Description
dragEnterEvent

Handle drag enter event for folder paths.
dropEvent

Handle drop event for folder paths.
browse

Return the browse button.
delete_curr_item

Delete the currently selected item.
open

Open the currently selected path in file explorer.
get_config

Return clean data for the config.

dragEnterEvent(event: QDragEnterEvent) -> None

Handle drag enter event for folder paths.

dropEvent(event: QDropEvent) -> None

Handle drop event for folder paths.

browse() -> None

Return the browse button.

delete_curr_item() -> None

Delete the currently selected item.

open() -> None

Open the currently selected path in file explorer.

get_config() -> str

Return clean data for the config.

FileCountWidget()

Bases: BaseGroupBox

Handles logic for file count settings.

Initialize the file count widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> FilecountModel

Return clean data for the config.

FolderCreatorWidget()

Bases: BaseGroupBox

Handles logic for creating folders.

Initialize the create folders widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> DirectoryModel

Return clean data for the config.

FilenameWidget()

Bases: BaseGroupBox

Handles logic for filename template settings.

Initialize the filename template settings widget.

Methods:

Name Description
insert_tag

Insert a tag into the template at the cursor position.
get_config

Return clean data for the config.

insert_tag(tag: str) -> None

Insert a tag into the template at the cursor position.

get_config() -> FilenameModel

Return clean data for the config.

TransferModeWidget()

Bases: BaseGroupBox

Handles logic for mode settings.

Initialize the mode settings widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> TransferModeModel

Return clean data for the config.

ListIncludeExcludeFilterWidget(title: str, name: str)

Bases: BaseGroupBox

Handles the Include/Exclude pattern for Keywords and Extensions.

Initialize the dual list widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> ListIncludeExcludeModel

Return clean data for the config.

ExtensionsFilterWidget()

Bases: ListIncludeExcludeFilterWidget

Handles the Include/Exclude pattern for file extensions.

Initialize the extensions filter widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> ListIncludeExcludeModel

Return clean data for the config.

KeywordsFilterWidget()

Bases: ListIncludeExcludeFilterWidget

Handles the Include/Exclude pattern for keywords.

Initialize the keywords filter widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> ListIncludeExcludeModel

Return clean data for the config.

MinMaxFilterWidget(title: str, name: str, items: Sequence[str | ByteUnit | TimeUnit])

Bases: BaseGroupBox

Handles logic for ranges (Min/Max), e.g., Size or Duration.

Initialize the range filter widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> MinMaxModel

Return clean data for the config.

SizeFilterWidget()

Bases: MinMaxFilterWidget

Handles logic for size range filter.

Initialize the size filter widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> MinMaxModel

Return clean data for the config.

DurationFilterWidget()

Bases: MinMaxFilterWidget

Handles logic for duration range filter.

Initialize the duration filter widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> MinMaxModel

Return clean data for the config.

SizeLimitWidget(title: str, name: str, items: Sequence[str | ByteUnit | TimeUnit])

Bases: BaseGroupBox

Handles logic for output folder size limit.

Initialize the size limit widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> SizeLimitModel

Return clean data for the config.

FolderSizeLimitWidget()

Bases: SizeLimitWidget

Handles logic for per-folder size limit.

Initialize the folder size limit widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> SizeLimitModel

Return clean data for the config.

TotalSizeLimitWidget()

Bases: SizeLimitWidget

Handles logic for total size limit across all folders.

Initialize the total size limit widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> SizeLimitModel

Return clean data for the config.

OptionsWidget()

Bases: BaseGroupBox

Handles logic for miscellaneous options.

Initialize the options widget.

Methods:

Name Description
get_config

Return clean data for the config.

get_config() -> OptionsModel

Return clean data for the config.

ProgressWidget()

Bases: QWidget

Progress bars and execution controls.

Post-initialize the progress widget.

Methods:

Name Description
update_total_prog

Update the total progress bar.
reset

Reset progress bars.

update_total_prog() -> None

Update the total progress bar.

reset() -> None

Reset progress bars.

LoggingWidget()

Bases: QWidget

Logging widget.

Post-initialize the logging widget.

ProgressBinder(progressw: ProgressWidget, loggingw: LoggingWidget)

Bases: QObject

Class for binding progress widgets.

Initialize the ProgressBinder.

Methods:

Name Description
bind

Bind worker signals to progress widget.
on_count

Handle directory progress count update.

bind(signals: WorkerSignals) -> None

Bind worker signals to progress widget.

on_count(count: int) -> None

Handle directory progress count update.