blob: b6d8e2220d02909ee2a2b296555ee052953e6c80 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <memory>
#include "base/callback.h"
#include "base/macros.h"
#include "base/memory/ref_counted_delete_on_sequence.h"
#include "base/values.h"
#include "printing/print_job_constants.h"
#include "printing/print_settings.h"
#include "printing/printing_context.h"
namespace base {
class Location;
namespace printing {
class PrintJobWorker;
// Query the printer for settings.
class PrinterQuery : public base::RefCountedDeleteOnSequence<PrinterQuery> {
// GetSettings() UI parameter.
enum class GetSettingsAskParam {
// Can only be called on the IO thread.
PrinterQuery(int render_process_id, int render_frame_id);
// Virtual so that tests can override.
virtual void GetSettingsDone(const PrintSettings& new_settings,
PrintingContext::Result result);
// Detach the PrintJobWorker associated to this object. Virtual so that tests
// can override.
// Called on the UI thread.
// TODO(thestig): Do |worker_| and |callback_| need locks?
virtual std::unique_ptr<PrintJobWorker> DetachWorker();
// Virtual so that tests can override.
virtual const PrintSettings& settings() const;
// Initializes the printing context. It is fine to call this function multiple
// times to reinitialize the settings. |web_contents_observer| can be queried
// to find the owner of the print setting dialog box. It is unused when
// |ask_for_user_settings| is DEFAULTS.
void GetSettings(GetSettingsAskParam ask_user_for_settings,
int expected_page_count,
bool has_selection,
MarginType margin_type,
bool is_scripted,
bool is_modifiable,
base::OnceClosure callback);
// Updates the current settings with |new_settings| dictionary values.
virtual void SetSettings(base::Value new_settings,
base::OnceClosure callback);
#if defined(OS_CHROMEOS)
// Updates the current settings with |new_settings|.
void SetSettingsFromPOD(std::unique_ptr<PrintSettings> new_settings,
base::OnceClosure callback);
// Stops the worker thread since the client is done with this object.
virtual void StopWorker();
// Returns true if a GetSettings() call is pending completion.
bool is_callback_pending() const;
int cookie() const;
PrintingContext::Result last_status() const { return last_status_; }
// Returns if a worker thread is still associated to this instance.
bool is_valid() const;
// Posts the given task to be run.
bool PostTask(const base::Location& from_here, base::OnceClosure task);
// RefCountedDeleteOnSequence class.
friend class base::RefCountedDeleteOnSequence<PrinterQuery>;
friend class base::DeleteHelper<PrinterQuery>;
virtual ~PrinterQuery();
// For unit tests to manually set the print callback.
void set_callback(base::OnceClosure callback);
// Lazy create the worker thread. There is one worker thread per print job.
void StartWorker(base::OnceClosure callback);
// Cache of the print context settings for access in the UI thread.
PrintSettings settings_;
// Is the Print... dialog box currently shown.
bool is_print_dialog_box_shown_ = false;
// Cookie that make this instance unique.
int cookie_;
// Results from the last GetSettingsDone() callback.
PrintingContext::Result last_status_ = PrintingContext::FAILED;
// Callback waiting to be run.
base::OnceClosure callback_;
// All the UI is done in a worker thread because many Win32 print functions
// are blocking and enters a message loop without your consent. There is one
// worker thread per print job.
std::unique_ptr<PrintJobWorker> worker_;
} // namespace printing