Core::ProgressManager Class

Detaljan opis

Upravitelj napretka prati napredak zadatka o kojemu je obaviješten i prikazuje indikator napretka korisniku u donjem desnom kutu glavnog prozora Qt Creator-a. Indikator napretka također omogućuje korisniku otkazivanje zadatka.

Jedinstveni primjerak ove klase dobivate putem funkcije ProgressManager::instance().

Registracija zadatka

API klase ProgressManager koristi QtConcurrent kao osnovu za definiranje zadataka. Zadatak se sastoji od sljedećih svojstava:

Da biste registrirali zadatak, stvorite svoj objekt QFuture<void> i pozovite addTask(). Ova funkcija vraća objekt FutureProgress koji možete koristiti za daljnju prilagodbu izgleda trake napretka. Pogledajte dokumentaciju za FutureProgress za detalje.

U nastavku ćete naučiti o dva uobičajena obrasca za stvaranje objekta QFuture<void> za vaš zadatak.

Stvaranje zadatka s više niti pomoću QtConcurrent

Prva opcija je izravno koristiti QtConcurrent za započinjanje zadatka istovremeno u drugoj niti. QtConcurrent ima nekoliko različitih funkcija za pokretanje, npr. funkcije klase u drugoj niti. Qt Creator sam po sebi dodaje još nekoliko u src/libs/utils/async.h. Funkcije QtConcurrent za pokretanje istovremenog zadatka vraćaju objekt QFuture. To je ono što trebate proslijediti ProgressManageru u funkciji addTask().

Pogledajte npr. Core::ILocatorFilter. Locator filtri implementiraju funkciju refresh() koja kao parametar prima objekt QFutureInterface. Te funkcije izgledaju otprilike ovako:

void Filter::refresh(QFutureInterface<void> &future) {
    future.setProgressRange(0, MAX);
    ...
    while (!future.isCanceled()) {
        // Do a part of the long stuff
        ...
        future.setProgressValue(currentProgress);
        ...
    }
}

Stvarno osvježavanje, koje poziva sve funkcije osvježavanja filtera u drugoj niti, izgleda ovako:

QFuture<void> task = Utils::map(filters, &ILocatorFilter::refresh);
Core::FutureProgress *progress = Core::ProgressManager::addTask(task, ::Core::Tr::tr("Indexing"),
                                                                Locator::Constants::TASK_INDEX);

Prvo pokrećemo asinhronu operaciju koja poziva funkciju osvježavanja svih filtera. Nakon toga vraćeni objekt QFuture registriramo kod ProgressManagera.

Ručno stvorite QtConcurrent objekte za svoj thread

Ako vaš zadatak ima vlastita sredstva za stvaranje i pokretanje niti, morate sami stvoriti potrebne objekte i izvijestiti o stanju pokretanja/zaustavljanja.

// We are already running in a different thread here
QFutureInterface<void> *progressObject = new QFutureInterface<void>;
progressObject->setProgressRange(0, MAX);
Core::ProgressManager::addTask(progressObject->future(), ::Core::Tr::tr("DoIt"), MYTASKTYPE);
progressObject->reportStarted();
// Do something
...
progressObject->setProgressValue(currentProgress);
...
// We have done what we needed to do
progressObject->reportFinished();
delete progressObject;

U prvoj liniji stvaramo objekt QFutureInterface koji će biti naš način izvještavanja o stanju zadatka. Prva stvar koju izvještavamo je očekivani raspon vrijednosti napretka. Registriramo zadatak kod ProgressManagera koristeći interni objekt QFuture koji je stvoren za naš objekt QFutureInterface. Zatim prijavljujemo da je zadatak započeo i počinjemo s našim stvarnim radom, redovito prijavljujući napredak putem funkcija u QFutureInterfaceu. Nakon što je dugotrajna operacija završena, to prijavljujemo putem objekta QFutureInterface, a zatim ga brišemo.

Prilagodba izgleda napretka

Možete postaviti prilagođeni widget koji će se prikazivati ispod same trake napretka koristeći objekt FutureProgress koji vraća funkcija addTask(). Također koristite ovaj objekt kako biste dobili obavijest kada korisnik klikne na pokazatelj napretka.