Chromium Embedded Framework (CEF)  130.1.2+g48f3ef6+chromium-130.0.6723.44
CefPrintSettings Class Referenceabstract

Class representing print settings. More...

#include "include/cef_print_settings.h"

Inheritance diagram for CefPrintSettings:
CefBaseRefCounted

Public Types

typedef cef_color_model_t ColorModel
 
typedef cef_duplex_mode_t DuplexMode
 
typedef std::vector< CefRangePageRangeList
 

Public Member Functions

virtual bool IsValid ()=0
 Returns true if this object is valid. More...
 
virtual bool IsReadOnly ()=0
 Returns true if the values of this object are read-only. More...
 
virtual void SetOrientation (bool landscape)=0
 Set the page orientation. More...
 
virtual bool IsLandscape ()=0
 Returns true if the orientation is landscape. More...
 
virtual void SetPrinterPrintableArea (const CefSize &physical_size_device_units, const CefRect &printable_area_device_units, bool landscape_needs_flip)=0
 Set the printer printable area in device units. More...
 
virtual void SetDeviceName (const CefString &name)=0
 Set the device name. More...
 
virtual CefString GetDeviceName ()=0
 Get the device name. More...
 
virtual void SetDPI (int dpi)=0
 Set the DPI (dots per inch). More...
 
virtual int GetDPI ()=0
 Get the DPI (dots per inch). More...
 
virtual void SetPageRanges (const PageRangeList &ranges)=0
 Set the page ranges. More...
 
virtual size_t GetPageRangesCount ()=0
 Returns the number of page ranges that currently exist. More...
 
virtual void GetPageRanges (PageRangeList &ranges)=0
 Retrieve the page ranges. More...
 
virtual void SetSelectionOnly (bool selection_only)=0
 Set whether only the selection will be printed. More...
 
virtual bool IsSelectionOnly ()=0
 Returns true if only the selection will be printed. More...
 
virtual void SetCollate (bool collate)=0
 Set whether pages will be collated. More...
 
virtual bool WillCollate ()=0
 Returns true if pages will be collated. More...
 
virtual void SetColorModel (ColorModel model)=0
 Set the color model. More...
 
virtual ColorModel GetColorModel ()=0
 Get the color model. More...
 
virtual void SetCopies (int copies)=0
 Set the number of copies. More...
 
virtual int GetCopies ()=0
 Get the number of copies. More...
 
virtual void SetDuplexMode (DuplexMode mode)=0
 Set the duplex mode. More...
 
virtual DuplexMode GetDuplexMode ()=0
 Get the duplex mode. More...
 
- Public Member Functions inherited from CefBaseRefCounted
virtual void AddRef () const =0
 Called to increment the reference count for the object. More...
 
virtual bool Release () const =0
 Called to decrement the reference count for the object. More...
 
virtual bool HasOneRef () const =0
 Returns true if the reference count is 1. More...
 
virtual bool HasAtLeastOneRef () const =0
 Returns true if the reference count is at least 1. More...
 

Static Public Member Functions

static CefRefPtr< CefPrintSettingsCreate ()
 Create a new CefPrintSettings object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CefBaseRefCounted
virtual ~CefBaseRefCounted ()
 

Detailed Description

Class representing print settings.

Member Typedef Documentation

◆ ColorModel

◆ DuplexMode

◆ PageRangeList

Member Function Documentation

◆ Create()

static CefRefPtr<CefPrintSettings> CefPrintSettings::Create ( )
static

Create a new CefPrintSettings object.

◆ GetColorModel()

virtual ColorModel CefPrintSettings::GetColorModel ( )
pure virtual

Get the color model.

◆ GetCopies()

virtual int CefPrintSettings::GetCopies ( )
pure virtual

Get the number of copies.

◆ GetDeviceName()

virtual CefString CefPrintSettings::GetDeviceName ( )
pure virtual

Get the device name.

◆ GetDPI()

virtual int CefPrintSettings::GetDPI ( )
pure virtual

Get the DPI (dots per inch).

◆ GetDuplexMode()

virtual DuplexMode CefPrintSettings::GetDuplexMode ( )
pure virtual

Get the duplex mode.

◆ GetPageRanges()

virtual void CefPrintSettings::GetPageRanges ( PageRangeList ranges)
pure virtual

Retrieve the page ranges.

◆ GetPageRangesCount()

virtual size_t CefPrintSettings::GetPageRangesCount ( )
pure virtual

Returns the number of page ranges that currently exist.

◆ IsLandscape()

virtual bool CefPrintSettings::IsLandscape ( )
pure virtual

Returns true if the orientation is landscape.

◆ IsReadOnly()

virtual bool CefPrintSettings::IsReadOnly ( )
pure virtual

Returns true if the values of this object are read-only.

Some APIs may expose read-only objects.

◆ IsSelectionOnly()

virtual bool CefPrintSettings::IsSelectionOnly ( )
pure virtual

Returns true if only the selection will be printed.

◆ IsValid()

virtual bool CefPrintSettings::IsValid ( )
pure virtual

Returns true if this object is valid.

Do not call any other methods if this function returns false.

◆ SetCollate()

virtual void CefPrintSettings::SetCollate ( bool  collate)
pure virtual

Set whether pages will be collated.

◆ SetColorModel()

virtual void CefPrintSettings::SetColorModel ( ColorModel  model)
pure virtual

Set the color model.

◆ SetCopies()

virtual void CefPrintSettings::SetCopies ( int  copies)
pure virtual

Set the number of copies.

◆ SetDeviceName()

virtual void CefPrintSettings::SetDeviceName ( const CefString name)
pure virtual

Set the device name.

◆ SetDPI()

virtual void CefPrintSettings::SetDPI ( int  dpi)
pure virtual

Set the DPI (dots per inch).

◆ SetDuplexMode()

virtual void CefPrintSettings::SetDuplexMode ( DuplexMode  mode)
pure virtual

Set the duplex mode.

◆ SetOrientation()

virtual void CefPrintSettings::SetOrientation ( bool  landscape)
pure virtual

Set the page orientation.

◆ SetPageRanges()

virtual void CefPrintSettings::SetPageRanges ( const PageRangeList ranges)
pure virtual

Set the page ranges.

◆ SetPrinterPrintableArea()

virtual void CefPrintSettings::SetPrinterPrintableArea ( const CefSize physical_size_device_units,
const CefRect printable_area_device_units,
bool  landscape_needs_flip 
)
pure virtual

Set the printer printable area in device units.

Some platforms already provide flipped area. Set |landscape_needs_flip| to false on those platforms to avoid double flipping.

◆ SetSelectionOnly()

virtual void CefPrintSettings::SetSelectionOnly ( bool  selection_only)
pure virtual

Set whether only the selection will be printed.

◆ WillCollate()

virtual bool CefPrintSettings::WillCollate ( )
pure virtual

Returns true if pages will be collated.


The documentation for this class was generated from the following file: