git.sesse.net Git - casparcg/blob - dependencies64/cef/include/cef_print_handler.h

   1 // Copyright (c) 2014 Marshall A. Greenblatt. All rights reserved.
   2 //
   3 // Redistribution and use in source and binary forms, with or without
   4 // modification, are permitted provided that the following conditions are
   5 // met:
   6 //
   7 //    * Redistributions of source code must retain the above copyright
   8 // notice, this list of conditions and the following disclaimer.
   9 //    * Redistributions in binary form must reproduce the above
  10 // copyright notice, this list of conditions and the following disclaimer
  11 // in the documentation and/or other materials provided with the
  12 // distribution.
  13 //    * Neither the name of Google Inc. nor the name Chromium Embedded
  14 // Framework nor the names of its contributors may be used to endorse
  15 // or promote products derived from this software without specific prior
  16 // written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 //
  30 // ---------------------------------------------------------------------------
  31 //
  32 // The contents of this file must follow a specific format in order to
  33 // support the CEF translator tool. See the translator.README.txt file in the
  34 // tools directory for more information.
  35 //
  36
  37 #ifndef CEF_INCLUDE_CEF_PRINT_HANDLER_H_
  38 #define CEF_INCLUDE_CEF_PRINT_HANDLER_H_
  39 #pragma once
  40
  41 #include "include/cef_base.h"
  42 #include "include/cef_browser.h"
  43 #include "include/cef_print_settings.h"
  44
  45 ///
  46 // Callback interface for asynchronous continuation of print dialog requests.
  47 ///
  48 /*--cef(source=library)--*/
  49 class CefPrintDialogCallback : public virtual CefBase {
  50  public:
  51   ///
  52   // Continue printing with the specified |settings|.
  53   ///
  54   /*--cef(capi_name=cont)--*/
  55   virtual void Continue(CefRefPtr<CefPrintSettings> settings) =0;
  56
  57   ///
  58   // Cancel the printing.
  59   ///
  60   /*--cef()--*/
  61   virtual void Cancel() =0;
  62 };
  63
  64 ///
  65 // Callback interface for asynchronous continuation of print job requests.
  66 ///
  67 /*--cef(source=library)--*/
  68 class CefPrintJobCallback : public virtual CefBase {
  69  public:
  70   ///
  71   // Indicate completion of the print job.
  72   ///
  73   /*--cef(capi_name=cont)--*/
  74   virtual void Continue() =0;
  75 };
  76
  77
  78 ///
  79 // Implement this interface to handle printing on Linux. The methods of this
  80 // class will be called on the browser process UI thread.
  81 ///
  82 /*--cef(source=client)--*/
  83 class CefPrintHandler : public virtual CefBase {
  84  public:
  85   ///
  86   // Synchronize |settings| with client state. If |get_defaults| is true then
  87   // populate |settings| with the default print settings. Do not keep a
  88   // reference to |settings| outside of this callback.
  89   ///
  90   /*--cef()--*/
  91   virtual void OnPrintSettings(CefRefPtr<CefPrintSettings> settings,
  92                                bool get_defaults) =0;
  93
  94   ///
  95   // Show the print dialog. Execute |callback| once the dialog is dismissed.
  96   // Return true if the dialog will be displayed or false to cancel the
  97   // printing immediately.
  98   ///
  99   /*--cef()--*/
 100   virtual bool OnPrintDialog(bool has_selection,
 101                              CefRefPtr<CefPrintDialogCallback> callback) =0;
 102
 103   ///
 104   // Send the print job to the printer. Execute |callback| once the job is
 105   // completed. Return true if the job will proceed or false to cancel the job
 106   // immediately.
 107   ///
 108   /*--cef()--*/
 109   virtual bool OnPrintJob(const CefString& document_name,
 110                           const CefString& pdf_file_path,
 111                           CefRefPtr<CefPrintJobCallback> callback) =0;
 112
 113   ///
 114   // Reset client state related to printing.
 115   ///
 116   /*--cef()--*/
 117   virtual void OnPrintReset() =0;
 118 };
 119
 120 #endif  // CEF_INCLUDE_CEF_PRINT_HANDLER_H_