background_worker.hpp

Go to the documentation of this file.

#pragma once
#include "../forms_export.hpp"
#include "component.hpp"
#include "form.hpp"
#include "do_work_event_handler.hpp"
#include "progress_changed_event_handler.hpp"
#include "run_worker_completed_event_handler.hpp"

namespace xtd {
  namespace forms {
    class forms_export_ background_worker : public xtd::forms::component {
      struct data;
      
    public:
      
      background_worker() noexcept;
      
      ~background_worker() noexcept;
      
      
      [[nodiscard]] auto cancellation_pending() const noexcept -> bool;
      
      [[nodiscard]] auto is_busy() const noexcept -> bool;
      
      [[nodiscard]] auto worker_reports_progress() const noexcept -> bool;
      auto worker_reports_progress(bool value) -> void;
      
      [[nodiscard]] auto worker_supports_cancellation() const noexcept -> bool;
      auto worker_supports_cancellation(bool value) -> void;
      
      
      auto cancel_async() -> void;
      
      virtual auto on_do_work(do_work_event_args& e) -> void;
      
      virtual auto on_progress_changed(const progress_changed_event_args& e) -> void;
      
      virtual auto on_run_worker_completed(const run_worker_completed_event_args& e) -> void;
      
      auto run_worker_async() -> void;
      
      template<typename argument_t>
      auto run_worker_async(argument_t argument) -> void {
        argument_(xtd::any_object(argument));
        run_worker_async();
      }
      
      auto report_progress(int32 percent_progress) -> void;
      
      auto report_progress(int32 percent_progress, const xtd::any_object& user_state) -> void;
      
      
      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:
      auto argument_(xtd::any_object&& argument) -> void;
      
      xtd::sptr<data> data_;
    };
  }
}