bcarrella/cef
1
0
Fork 0
mirror of https://bitbucket.org/chromiumembedded/cef synced 2025-06-05 21:39:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update include/ comments to Doxygen formatting (see issue #3384)

Browse Source 
See related guidelines in the issue.
This commit is contained in:
Marshall Greenblatt
2022-08-31 22:03:04 -04:00
parent 7b352159df
commit d7a153bdd4
235 changed files with 11484 additions and 11274 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
include/cef_print_handler.h
View File

@ -43,58 +43,58 @@
#include "include/cef_print_settings.h"
///
// Callback interface for asynchronous continuation of print dialog requests.
/// Callback interface for asynchronous continuation of print dialog requests.
///
/*--cef(source=library)--*/
class CefPrintDialogCallback : public virtual CefBaseRefCounted {
public:
///
// Continue printing with the specified |settings|.
/// Continue printing with the specified |settings|.
///
/*--cef(capi_name=cont)--*/
virtual void Continue(CefRefPtr<CefPrintSettings> settings) = 0;
///
// Cancel the printing.
/// Cancel the printing.
///
/*--cef()--*/
virtual void Cancel() = 0;
};
///
// Callback interface for asynchronous continuation of print job requests.
/// Callback interface for asynchronous continuation of print job requests.
///
/*--cef(source=library)--*/
class CefPrintJobCallback : public virtual CefBaseRefCounted {
public:
///
// Indicate completion of the print job.
/// Indicate completion of the print job.
///
/*--cef(capi_name=cont)--*/
virtual void Continue() = 0;
};
///
// Implement this interface to handle printing on Linux. Each browser will have
// only one print job in progress at a time. The methods of this class will be
// called on the browser process UI thread.
/// Implement this interface to handle printing on Linux. Each browser will have
/// only one print job in progress at a time. The methods of this class will be
/// called on the browser process UI thread.
///
/*--cef(source=client)--*/
class CefPrintHandler : public virtual CefBaseRefCounted {
public:
///
// Called when printing has started for the specified |browser|. This method
// will be called before the other OnPrint*() methods and irrespective of how
// printing was initiated (e.g. CefBrowserHost::Print(), JavaScript
// window.print() or PDF extension print button).
/// Called when printing has started for the specified |browser|. This method
/// will be called before the other OnPrint*() methods and irrespective of how
/// printing was initiated (e.g. CefBrowserHost::Print(), JavaScript
/// window.print() or PDF extension print button).
///
/*--cef()--*/
virtual void OnPrintStart(CefRefPtr<CefBrowser> browser) = 0;
///
// Synchronize |settings| with client state. If |get_defaults| is true then
// populate |settings| with the default print settings. Do not keep a
// reference to |settings| outside of this callback.
/// Synchronize |settings| with client state. If |get_defaults| is true then
/// populate |settings| with the default print settings. Do not keep a
/// reference to |settings| outside of this callback.
///
/*--cef()--*/
virtual void OnPrintSettings(CefRefPtr<CefBrowser> browser,
@ -102,9 +102,9 @@ class CefPrintHandler : public virtual CefBaseRefCounted {
bool get_defaults) = 0;
///
// Show the print dialog. Execute |callback| once the dialog is dismissed.
// Return true if the dialog will be displayed or false to cancel the
// printing immediately.
/// Show the print dialog. Execute |callback| once the dialog is dismissed.
/// Return true if the dialog will be displayed or false to cancel the
/// printing immediately.
///
/*--cef()--*/
virtual bool OnPrintDialog(CefRefPtr<CefBrowser> browser,
@ -112,9 +112,9 @@ class CefPrintHandler : public virtual CefBaseRefCounted {
CefRefPtr<CefPrintDialogCallback> callback) = 0;
///
// Send the print job to the printer. Execute |callback| once the job is
// completed. Return true if the job will proceed or false to cancel the job
// immediately.
/// Send the print job to the printer. Execute |callback| once the job is
/// completed. Return true if the job will proceed or false to cancel the job
/// immediately.
///
/*--cef()--*/
virtual bool OnPrintJob(CefRefPtr<CefBrowser> browser,
@ -123,14 +123,14 @@ class CefPrintHandler : public virtual CefBaseRefCounted {
CefRefPtr<CefPrintJobCallback> callback) = 0;
///
// Reset client state related to printing.
/// Reset client state related to printing.
///
/*--cef()--*/
virtual void OnPrintReset(CefRefPtr<CefBrowser> browser) = 0;
///
// Return the PDF paper size in device units. Used in combination with
// CefBrowserHost::PrintToPDF().
/// Return the PDF paper size in device units. Used in combination with
/// CefBrowserHost::PrintToPDF().
///
/*--cef()--*/
virtual CefSize GetPdfPaperSize(CefRefPtr<CefBrowser> browser,