background_worker.h

Go to the documentation of this file.

#pragma once
#include <thread>
#include "../forms_export.h"
#include "component.h"
#include "form.h"
#include "do_work_event_handler.h"
#include "progress_changed_event_handler.h"
#include "run_worker_completed_event_handler.h"

namespace xtd {
  namespace forms {
    class forms_export_ background_worker : public component {
    public:
      
      background_worker();
      
      ~background_worker();
      
      
      bool cancellation_pending() const {return data_->cancellation_pending;}
      
      bool is_busy() const {return data_->is_busy;}
      
      bool worker_reports_progress() const {return data_->worker_reports_progress;}
      void worker_reports_progress(bool value) {data_->worker_reports_progress = value;}

      bool worker_supports_cancellation() const {return data_->worker_supports_cancellation;}
      void worker_supports_cancellation(bool value) {data_->worker_supports_cancellation = value;}

      
      void cancel_async();
      
      virtual void on_do_work(do_work_event_args& e) {do_work(*this, e);}
      
      virtual void on_progress_changed(const progress_changed_event_args& e) {progress_changed(*this, e);}
      
      virtual void on_run_worker_completed(const run_worker_completed_event_args& e) {run_worker_completed(*this, e);}

      void run_worker_async();
      
      template<typename argument_t>
      void run_worker_async(argument_t argument) {
        data_->argument = argument;
        run_worker_async();
      }

      void report_progress(int32_t percent_progress);
      
      void report_progress(int32_t percent_progress, std::any user_state);

      
      event<background_worker, do_work_event_handler> do_work;

      event<background_worker, progress_changed_event_handler> progress_changed;

      event<background_worker, run_worker_completed_event_handler> run_worker_completed;
      
    private:
      struct data {
        std::any argument;
        bool cancellation_pending = false;
        bool is_busy = false;
        bool worker_reports_progress = false;
        bool worker_supports_cancellation = false;
        progress_changed_event_args event {0, std::any()};
        std::unique_ptr<form> invoker;
        std::thread thread;
      };
      std::shared_ptr<data> data_ = std::make_shared<data>();
    };
  }
}