Plugin Development

[KevinH]

If you want to do that to an entire list of checkboxes you may want to check out Sigil/src/Dialogs/DeleteFiles.cpp and [.h] and Sigil/src/Form_Files/DeleteFiles.ui


To see it in action, run Sigil and open a junk epub with lots of files. In BookBrowser highlight a bunch of files and right click and select Delete.

Sigil will show a QDialog with a list of checkboxes and file path right beside it. Then grab the dialog and resize it to make it really small and you will see that the filepaths are nicely wrapped.

Is that what you want?

This is accomplished by using a QTableView with two columns, the first for the checkmark and the second for the file path.

void DeleteFiles::SetUpTable()
{
    QStringList header;
    QPushButton *delete_button = ui.buttonBox->button(QDialogButtonBox::Ok);
    delete_button->setText(tr("Delete Marked Files"));
    header.append(tr("Delete"));
    header.append(tr("File"));
    m_Model.setHorizontalHeaderLabels(header);
    ui.Table->setModel(&m_Model);
    // Make the header fill all the available space
    ui.Table->horizontalHeader()->setStretchLastSection(true);
    ui.Table->verticalHeader()->setVisible(false);
    ui.Table->setSortingEnabled(true);
    ui.Table->setSelectionBehavior(QAbstractItemView::SelectRows);
    ui.Table->setSelectionMode(QAbstractItemView::SingleSelection);
    ui.Table->setAlternatingRowColors(true);
}

DeleteFiles::DeleteFiles(QStringList files_to_delete, QWidget *parent)
    :
    QDialog(parent),
    m_FilesToDelete(files_to_delete)
{
    ui.setupUi(this);
    ConnectSignals();
    SetUpTable();
    ReadSettings();
    foreach(QString filepath, m_FilesToDelete) {
        QList<QStandardItem *> rowItems;
        // Checkbox
        QStandardItem *checkbox_item = new QStandardItem();
        checkbox_item->setCheckable(true);
        checkbox_item->setCheckState(Qt::Checked);
        rowItems << checkbox_item;
        // File Path
        QStandardItem *file_item = new QStandardItem();
        file_item->setText(filepath);
        rowItems << file_item;

        for (int i = 0; i < rowItems.count(); i++) {
            rowItems[i]->setEditable(false);
        }

        m_Model.appendRow(rowItems);
    }
}

One advantage of using a QDialog with a QTableView is that you can easily get alternative row colours and can add a check all or uncheck all element.

If you like the QTableView approach and it does what you want, I would be happy to take a stab at converting it to python if you would like.

Just let me know.

[wrCisco]

Hi Kevin, thanks for the adivce! The QTableView has many desirable features, but what I meant about word wrapping was that the text should flow across multiple lines when there is not enough space, while in the DeleteFiles dialog the overflowing text is replaced by an ellipsis.

Admittedly, for the plugin I'm working on, your solution would nonetheless work well, but in another plugin I have a similar pattern, and there I would like to keep all the labels's text always visible.

[KevinH]

Funny, line wrapping is what happens on MacOS on my machine, when shrinking the dialog. I think you can control that.

setTextElideMode(Qt::TextElideMode mode);
With Qt::ElideNone.

Then enable WordWrap.

setWordWrap(true).

It is funny you get ellipses and I get wrapping.

Update
I can remove the ellipses but if I shrink the Dialog too much even with WordWrap on, it will cut off. I never noticed that before.

[KevinH]

I think the only way to do this in a QTableView is to use a rich text delegate and set wrap mode to break on words first and when that fails break anyplace.

[KevinH]

I finally figured out how to use a Styled Item Delegate which employed QTextDocument and QTextOptions with Qt::WrapAtWordBoundaryOrAnywhere set to prevent elided or lost text in the DeleteFiles dialog. It took most of today to work out the little nits. The end result is not worth the effort in my opinion.

So if your way works, then it is probably better than the QTableView and ItemDelegate approach.

[wrCisco]

Yes, it seems that word wrapping without complex strategies is not entirely consistent across platforms (I'm testing on Windows 11 - Sigil 2.6 - and WSL Ubuntu - Sigil 2.0).

I rewrote the plugin to use QTableView and QAbstractTableModel, partly to learn about Qt's Model/View architecture, partly because I don't think the elision of the text would be a problem here.

I get a weird glitch, only on Windows/PySide6, with both my WrappingCheckBox and QTableView, when word wrap is set to True: there is always a specific width that causes the text to wrap on two lines, but without the cell or QLabel widget expanding to accommodate it all, like in the attached image. If I then resize the window's width by a couple of pixel, the problem disappears one way or another.
This doesn't happen on Ubuntu (where I use PyQt5).

Originally Posted by KevinH

It took most of today to work out the little nits.

I am pleased to have given you the opportunity to have so much fun exploring the deepest meanders of Qt.

Jokes aside, if your experiment is shareable without you wasting more time, I could try to reimplement it for my other plugin, otherwise I'll probably just use the WrappingCheckBox approach.

[KevinH]

I pushed it to my personal github repo;
https://github.com/kevinhendricks/Sigil

You want:

Sigil/src/Dialogs/DeleteFiles.*
Sigil/src/Dialogs/WrapWordAnyItemDelegate.*
And Sigil/src/Form_Files/DeleteFiles.ui

The smarts are in the delegate but had to create my own replacement for built in resizeRowsToContents() using a loop and individual row resizing as that call ignored the delegate completely (had to read the qtableview.cpp source to find that little tidbit out)!

Then had to trigger my routine in resize events and set it initially after the constructor was done (ie effectively what you did with show).

Hope this helps.

[KevinH]

If you want me to try to create a python version, just let me know and I will take a shot at it.

[KevinH]

FWIW, to properly handle vertical alignment within the box, I had to borrow code from another Item Delegate example I found on the web. I have tested it and it now works to show the preferred vertical alignment in the row.

I have just pushed this change to WrapWordAnyItemDelegate.cpp to master on https://github.com/kevinhendricks/Sigil

Just in case you are trying something similar.

[BeckyEbook]

@wrCisco: @wrCisco: If you import iswindows:

from plugin_utils import PluginApplication, QtWidgets, QtCore, Qt, iswindows

…and then an additional attribute:

    mdp = True if iswindows else False
    app = PluginApplication([], bk, app_icon=PLUGIN_ICON, match_dark_palette=mdp)

then under Windows windows will automatically support dark mode.

Recommended!