cef/include/cef_print_settings.h

209 lines
5.4 KiB
C
Raw Normal View History

// Copyright (c) 2014 Marshall A. Greenblatt. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the name Chromium Embedded
// Framework nor the names of its contributors may be used to endorse
// or promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// ---------------------------------------------------------------------------
//
// The contents of this file must follow a specific format in order to
// support the CEF translator tool. See the translator.README.txt file in the
// tools directory for more information.
//
#ifndef CEF_INCLUDE_CEF_PRINT_SETTINGS_H_
#define CEF_INCLUDE_CEF_PRINT_SETTINGS_H_
#pragma once
#include <vector>
#include "include/cef_base.h"
///
// Class representing print settings.
///
/*--cef(source=library)--*/
class CefPrintSettings : public virtual CefBase {
public:
typedef cef_color_model_t ColorModel;
typedef cef_duplex_mode_t DuplexMode;
Implement Views framework on Windows and Linux (issue #1749). - Add Views header files in a new include/views directory. - Add initial top-level window (CefWindow), control (CefBrowserView, CefLabelButton, CefMenuButton, CefPanel, CefScrollView, CefTextfield) and layout (CefBoxLayout, CefFlowLayout) support. See libcef/browser/views/view_impl.h comments for implementation details. - Add Views example usage in cefclient and cefsimple and Views unit tests in cef_unittests. Pass the `--use-views` command-line flag to cefclient, cefsimple and cef_unittests to run using the Views framework instead of platform APIs. For cefclient and cefsimple this will create the browser window and all related functionality using the Views framework. For cef_unittests this will run all tests (except OSR tests) in a Views-based browser window. Views- specific unit tests (`--gtest_filter=Views*`) will be run even if the the `--use-views` flag is not specified. - Pass the `--hide-frame` command-line flag to cefclient to demo a frameless Views-based browser window. - Pass the `--hide-controls` command-line flag to cefclient to demo a browser window without top controls. This also works in non-Views mode. - Pass the `--enable-high-dpi-support` command-line flag to cef_unittests on Windows to test high-DPI support on a display that supports it. - Add CefImage for reading/writing image file formats. - Add CefBrowser::DownloadImage() for downloading image URLs as a CefImage representation. This is primarily for loading favicons. - Add CefMenuModel::CreateMenuModel() and CefMenuModelDelegate for creating custom menus. This is primarily for use with CefMenuButton. - Add CefBrowser::TryCloseBrowser() helper for closing a browser. Also improve related documentation in cef_life_span_handler.h. - Rename cef_page_range_t to cef_range_t. It is now also used by CefTextfield. - Remove CefLifeSpanHandler::RunModal() which is never called. - Add draggable regions example to cefclient.
2016-01-19 21:09:01 +01:00
typedef std::vector<CefRange> PageRangeList;
///
// Create a new CefPrintSettings object.
///
/*--cef()--*/
static CefRefPtr<CefPrintSettings> Create();
///
// Returns true if this object is valid. Do not call any other methods if this
// function returns false.
///
/*--cef()--*/
virtual bool IsValid() =0;
///
// Returns true if the values of this object are read-only. Some APIs may
// expose read-only objects.
///
/*--cef()--*/
virtual bool IsReadOnly() =0;
///
// Returns a writable copy of this object.
///
/*--cef()--*/
virtual CefRefPtr<CefPrintSettings> Copy() =0;
///
// Set the page orientation.
///
/*--cef()--*/
virtual void SetOrientation(bool landscape) =0;
///
// Returns true if the orientation is landscape.
///
/*--cef()--*/
virtual bool IsLandscape() =0;
///
// 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.
///
/*--cef()--*/
virtual void SetPrinterPrintableArea(
const CefSize& physical_size_device_units,
const CefRect& printable_area_device_units,
bool landscape_needs_flip) =0;
///
// Set the device name.
///
/*--cef(optional_param=name)--*/
virtual void SetDeviceName(const CefString& name) =0;
///
// Get the device name.
///
/*--cef()--*/
virtual CefString GetDeviceName() =0;
///
// Set the DPI (dots per inch).
///
/*--cef()--*/
virtual void SetDPI(int dpi) =0;
///
// Get the DPI (dots per inch).
///
/*--cef()--*/
virtual int GetDPI() =0;
///
// Set the page ranges.
///
/*--cef()--*/
virtual void SetPageRanges(const PageRangeList& ranges) =0;
///
// Returns the number of page ranges that currently exist.
///
/*--cef()--*/
virtual size_t GetPageRangesCount() =0;
///
// Retrieve the page ranges.
///
/*--cef(count_func=ranges:GetPageRangesCount)--*/
virtual void GetPageRanges(PageRangeList& ranges) =0;
///
// Set whether only the selection will be printed.
///
/*--cef()--*/
virtual void SetSelectionOnly(bool selection_only) =0;
///
// Returns true if only the selection will be printed.
///
/*--cef()--*/
virtual bool IsSelectionOnly() =0;
///
// Set whether pages will be collated.
///
/*--cef()--*/
virtual void SetCollate(bool collate) =0;
///
// Returns true if pages will be collated.
///
/*--cef()--*/
virtual bool WillCollate() =0;
///
// Set the color model.
///
/*--cef()--*/
virtual void SetColorModel(ColorModel model) =0;
///
// Get the color model.
///
/*--cef(default_retval=COLOR_MODEL_UNKNOWN)--*/
virtual ColorModel GetColorModel() =0;
///
// Set the number of copies.
///
/*--cef()--*/
virtual void SetCopies(int copies) =0;
///
// Get the number of copies.
///
/*--cef()--*/
virtual int GetCopies() =0;
///
// Set the duplex mode.
///
/*--cef()--*/
virtual void SetDuplexMode(DuplexMode mode) =0;
///
// Get the duplex mode.
///
/*--cef(default_retval=DUPLEX_MODE_UNKNOWN)--*/
virtual DuplexMode GetDuplexMode() =0;
};
#endif // CEF_INCLUDE_CEF_PRINT_SETTINGS_H_