background_worker.h

Go to the documentation of this file.

 
#pragma once
#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 {
      struct data;
      
    public:
      
      background_worker() noexcept;
      
      ~background_worker() noexcept;
      
      
      bool cancellation_pending() const noexcept;
      
      bool is_busy() const noexcept;
      
      bool worker_reports_progress() const noexcept;
      void worker_reports_progress(bool value);
      
      bool worker_supports_cancellation() const noexcept;
      void worker_supports_cancellation(bool value);
      
      
      void cancel_async();
      
      virtual void on_do_work(do_work_event_args& e);
      
      virtual void on_progress_changed(const progress_changed_event_args& e);
      
      virtual void on_run_worker_completed(const run_worker_completed_event_args& e);
      
      void run_worker_async();
      
      template<typename argument_t>
      void run_worker_async(argument_t argument) {
        argument_(std::any(argument));
        run_worker_async();
      }
      
      void report_progress(int32 percent_progress);
      
      void report_progress(int32 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:
      void argument_(std::any&& argument);
      
      std::shared_ptr<data> data_;
    };
  }
}