KisSupporterBundlesDialog Class Reference

#include <KisSupporterBundlesDialog.h>

Inheritance diagram for KisSupporterBundlesDialog:

Public Member Functions
	KisSupporterBundlesDialog (QWidget *parent=nullptr)

Private Slots
void	slotFetchIndexDone (bool success, const QString &errorMessage)
void	slotResetBundleWidgets ()

Private Member Functions
void	fetchBundles ()
QVector< KisSupporterProduct >	getCurrentProducts () const

Static Private Member Functions
static bool	bundleWidgetLessThan (const KisSupporterBundleWidget *a, const KisSupporterBundleWidget *b)
static bool	couldOwnAnyProduct (const QVector< KisSupporterProduct > &bundleProducts)
static QVector< KisSupporterProduct >	getProductsForBundle (const QVector< KisSupporterProduct > &currentProducts, const KisSupporterBundle &bundle)
static const KisSupporterProduct *	searchProductById (const QVector< KisSupporterProduct > &currentProducts, const QString &id)

Private Attributes
KisSupporterBundlesFetcher *	m_fetcher

Static Private Attributes
static constexpr int	PAGE_BUNDLES = 2
static constexpr int	PAGE_ERROR = 1
static constexpr int	PAGE_FETCHING = 0

Detailed Description

Definition at line 18 of file KisSupporterBundlesDialog.h.

Constructor & Destructor Documentation

KisSupporterBundlesDialog()

KisSupporterBundlesDialog::KisSupporterBundlesDialog ( QWidget * parent = nullptr )

explicit

Definition at line 15 of file KisSupporterBundlesDialog.cpp.

    : QDialog(parent)
    , m_fetcher(new KisSupporterBundlesFetcher(this))
{
    setupUi(this);
    setWindowTitle(i18n("Supporter Bundles"));
 
    QScroller *scroller = KisKineticScroller::createPreconfiguredScroller(m_scrBundles);
    if (scroller) {
        connect(scroller, &QScroller::stateChanged, this, [&](QScroller::State state) {
            KisKineticScroller::updateCursor(this, state);
        });
    }
 
    connect(m_fetcher,
            &KisSupporterBundlesFetcher::fetchIndexDone,
            this,
            &KisSupporterBundlesDialog::slotFetchIndexDone);
    connect(m_btnRetry, &QPushButton::clicked, this, &KisSupporterBundlesDialog::fetchBundles);
    connect(m_buttons, &QDialogButtonBox::rejected, this, &KisSupporterBundlesDialog::reject);
 
    fetchBundles();
}

References KisKineticScroller::createPreconfiguredScroller(), fetchBundles(), KisSupporterBundlesFetcher::fetchIndexDone(), m_fetcher, slotFetchIndexDone(), and KisKineticScroller::updateCursor().

Member Function Documentation

bundleWidgetLessThan()

bool KisSupporterBundlesDialog::bundleWidgetLessThan ( const KisSupporterBundleWidget * a, const KisSupporterBundleWidget * b )

staticprivate

Definition at line 186 of file KisSupporterBundlesDialog.cpp.

{
    bool aOwned = a->isProductOwned();
    bool bOwned = b->isProductOwned();
    if (aOwned && !bOwned) {
        return true;
    } else if (!aOwned && bOwned) {
        return false;
    }
 
    bool aCanImport = a->canImport();
    bool bCanImport = b->canImport();
    if (aCanImport && !bCanImport) {
        return true;
    } else if (!aCanImport && bCanImport) {
        return false;
    }
 
    return a->bundle().title.compare(b->bundle().title, Qt::CaseInsensitive) < 0;
}

References KisSupporterBundleWidget::bundle(), KisSupporterBundleWidget::canImport(), KisSupporterBundleWidget::isProductOwned(), and KisSupporterBundle::title.

couldOwnAnyProduct()

bool KisSupporterBundlesDialog::couldOwnAnyProduct ( const QVector< KisSupporterProduct > & bundleProducts )

staticprivate

Definition at line 172 of file KisSupporterBundlesDialog.cpp.

{
    for (const KisSupporterProduct &product : bundleProducts) {
        switch (product.availability) {
        case KisSupporterProductAvailability::Missing:
            break;
        case KisSupporterProductAvailability::Available:
        case KisSupporterProductAvailability::Owned:
            return true;
        }
    }
    return false;
}

fetchBundles()

void KisSupporterBundlesDialog::fetchBundles ( )

private

Definition at line 126 of file KisSupporterBundlesDialog.cpp.

{
    if (!m_fetcher->isFetching()) {
        m_stack->setCurrentIndex(PAGE_FETCHING);
        m_btnRetry->setEnabled(false);
        m_fetcher->fetchIndex();
    }
}

References KisSupporterBundlesFetcher::fetchIndex(), KisSupporterBundlesFetcher::isFetching(), m_fetcher, and PAGE_FETCHING.

getCurrentProducts()

QVector< KisSupporterProduct > KisSupporterBundlesDialog::getCurrentProducts ( ) const

private

Definition at line 135 of file KisSupporterBundlesDialog.cpp.

{
    KisAndroidDonations *androidDonations = KisAndroidDonations::instance();
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(androidDonations, QVector<KisSupporterProduct>());
    return androidDonations->getCurrentProducts();
}

References KisAndroidDonations::getCurrentProducts(), KisAndroidDonations::instance(), and KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE.

getProductsForBundle()

QVector< KisSupporterProduct > KisSupporterBundlesDialog::getProductsForBundle ( const QVector< KisSupporterProduct > & currentProducts, const KisSupporterBundle & bundle )

staticprivate

Definition at line 143 of file KisSupporterBundlesDialog.cpp.

{
    const QString prefix = QStringLiteral("p:");
    QVector<KisSupporterProduct> bundleProducts;
    dbgResources << "Bundle" << bundle.fileName << "tags:" << bundle.tags;
    for (const QString &tag : bundle.tags) {
        if (tag.startsWith(prefix)) {
            const KisSupporterProduct *product = searchProductById(currentProducts, tag.mid(prefix.length()));
            if (product) {
                bundleProducts.append(*product);
            }
        }
    }
    return bundleProducts;
}

References dbgResources, KisSupporterBundle::fileName, searchProductById(), and KisSupporterBundle::tags.

searchProductById()

const KisSupporterProduct * KisSupporterBundlesDialog::searchProductById ( const QVector< KisSupporterProduct > & currentProducts, const QString & id )

staticprivate

Definition at line 161 of file KisSupporterBundlesDialog.cpp.

{
    for (const KisSupporterProduct &product : currentProducts) {
        if (product.id == id) {
            return &product;
        }
    }
    dbgResources << "No current product for id" << id;
    return nullptr;
}

References dbgResources.

slotFetchIndexDone

void KisSupporterBundlesDialog::slotFetchIndexDone ( bool success, const QString & errorMessage )

privateslot

Definition at line 39 of file KisSupporterBundlesDialog.cpp.

{
    m_btnRetry->setEnabled(!success);
    if (success) {
        slotResetBundleWidgets();
        m_stack->setCurrentIndex(PAGE_BUNDLES);
 
        KisAndroidDonations *androidDonations = KisAndroidDonations::instance();
        if (androidDonations) {
            connect(androidDonations,
                    &KisAndroidDonations::sigStateChanged,
                    this,
                    &KisSupporterBundlesDialog::slotResetBundleWidgets);
        }
 
    } else {
        m_lblError->setText(i18n("<strong>Error:</strong> %1").arg(errorMessage.toHtmlEscaped()));
        // Delay this a bit to avoid excessively fast retries and to make it
        // clear to the user that a retry is actually happening. Otherwise the
        // loading page may flash so quickly that it seems like it's not doing
        // anything at all.
        QTimer::singleShot(1000, [this] {
            m_stack->setCurrentIndex(PAGE_ERROR);
        });
    }
}

References KisAndroidDonations::instance(), PAGE_BUNDLES, PAGE_ERROR, KisAndroidDonations::sigStateChanged(), and slotResetBundleWidgets().

slotResetBundleWidgets

void KisSupporterBundlesDialog::slotResetBundleWidgets ( )

privateslot

Definition at line 66 of file KisSupporterBundlesDialog.cpp.

{
    while (!m_lytWdgBundles->isEmpty()) {
        QLayoutItem *item = m_lytWdgBundles->takeAt(m_lytWdgBundles->count() - 1);
        QWidget *widget = item->widget();
        if (widget) {
            widget->deleteLater();
        }
        delete item;
    }
 
    QVector<KisSupporterProduct> currentProducts = getCurrentProducts();
 
    QVector<KisSupporterBundleWidget *> bundleWidgets;
    for (const KisSupporterBundle &bundle : m_fetcher->bundles()) {
        // Gather the products that this bundle is associated with.
        QVector<KisSupporterProduct> bundleProducts = getProductsForBundle(currentProducts, bundle);
        // Only show bundles that the user could actually acquire, there's no
        // point in dangling a bundle in front of their nose that they couldn't
        // purchase any product for.
        if (couldOwnAnyProduct(bundleProducts)) {
            KisSupporterBundleWidget *bundleWidget = new KisSupporterBundleWidget(m_fetcher, bundle, bundleProducts);
            bundleWidgets.append(bundleWidget);
        } else {
            dbgResources << "No products for bundle" << bundle.fileName;
        }
    }
 
    if (bundleWidgets.isEmpty()) {
        m_lytWdgBundles->addStretch();
        QLabel *label = new QLabel(i18n("No supporter bundles available."));
        label->setAlignment(Qt::AlignCenter);
        label->setWordWrap(true);
        m_lytWdgBundles->addWidget(label);
        m_lytWdgBundles->addStretch();
    } else {
        std::sort(bundleWidgets.begin(), bundleWidgets.end(), &KisSupporterBundlesDialog::bundleWidgetLessThan);
 
        // We've been asked to put this disclaimer here so that people don't
        // contact the authors and complain about paywalling or something.
        // Don't remove this message without discussing it with them.
        QLabel *purchaseNoteLabel =
            new QLabel(i18n("These bundles have been made available by their authors to help provide rewards for "
                            "supporting Krita's development. They do not receive compensation for purchases and may "
                            "make these bundles in other ways behind the links below."));
        purchaseNoteLabel->setTextFormat(Qt::PlainText);
        purchaseNoteLabel->setWordWrap(true);
        m_lytWdgBundles->addWidget(purchaseNoteLabel);
 
        for (KisSupporterBundleWidget *bundleWidget : bundleWidgets) {
            QFrame *separator = new QFrame;
            separator->setFrameShape(QFrame::HLine);
            separator->setFrameShadow(QFrame::Sunken);
            m_lytWdgBundles->addWidget(separator);
            m_lytWdgBundles->addWidget(bundleWidget);
        }
        m_lytWdgBundles->addStretch();
    }
}

References KisSupporterBundlesFetcher::bundles(), bundleWidgetLessThan(), couldOwnAnyProduct(), dbgResources, getCurrentProducts(), getProductsForBundle(), and m_fetcher.

Member Data Documentation

m_fetcher

KisSupporterBundlesFetcher* KisSupporterBundlesDialog::m_fetcher

private

Definition at line 47 of file KisSupporterBundlesDialog.h.

PAGE_BUNDLES

constexpr int KisSupporterBundlesDialog::PAGE_BUNDLES = 2

staticconstexprprivate

Definition at line 31 of file KisSupporterBundlesDialog.h.

PAGE_ERROR

constexpr int KisSupporterBundlesDialog::PAGE_ERROR = 1

staticconstexprprivate

Definition at line 30 of file KisSupporterBundlesDialog.h.

PAGE_FETCHING

constexpr int KisSupporterBundlesDialog::PAGE_FETCHING = 0

staticconstexprprivate

Definition at line 29 of file KisSupporterBundlesDialog.h.

---

The documentation for this class was generated from the following files:

• plugins/extensions/resourcemanager/KisSupporterBundlesDialog.h
• plugins/extensions/resourcemanager/KisSupporterBundlesDialog.cpp