gecko-dev/widget/gtk/nsPrintSettingsGTK.h
Ehsan Akhgari 490e611801 Bug 1508472 - Part 5: Fifth batch of comment fix-ups in preparation for the tree reformat r=sylvestre
This is a best effort attempt at ensuring that the adverse impact of
reformatting the entire tree over the comments would be minimal. I've used a
combination of strategies including disabling of formatting, some manual
formatting and some changes to formatting to work around some clang-format
limitations.

Differential Revision: https://phabricator.services.mozilla.com/D13371

--HG--
extra : moz-landing-system : lando
2018-11-29 10:30:46 +00:00

154 lines
5.8 KiB
C++

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsPrintSettingsGTK_h_
#define nsPrintSettingsGTK_h_
#include "nsPrintSettingsImpl.h"
extern "C" {
#include <gtk/gtk.h>
#include <gtk/gtkunixprint.h>
}
#define NS_PRINTSETTINGSGTK_IID \
{ 0x758df520, 0xc7c3, 0x11dc, { 0x95, 0xff, 0x08, 0x00, 0x20, 0x0c, 0x9a, 0x66 } }
//*****************************************************************************
//*** nsPrintSettingsGTK
//*****************************************************************************
class nsPrintSettingsGTK : public nsPrintSettings
{
public:
NS_DECL_ISUPPORTS_INHERITED
NS_DECLARE_STATIC_IID_ACCESSOR(NS_PRINTSETTINGSGTK_IID)
nsPrintSettingsGTK();
// We're overriding these methods because we want to read/write with GTK objects,
// not local variables. This allows a simpler settings implementation between
// Gecko and GTK.
GtkPageSetup* GetGtkPageSetup() { return mPageSetup; };
void SetGtkPageSetup(GtkPageSetup *aPageSetup);
GtkPrintSettings* GetGtkPrintSettings() { return mPrintSettings; };
void SetGtkPrintSettings(GtkPrintSettings *aPrintSettings);
GtkPrinter* GetGtkPrinter() { return mGTKPrinter; };
void SetGtkPrinter(GtkPrinter *aPrinter);
bool GetForcePrintSelectionOnly() { return mPrintSelectionOnly; };
void SetForcePrintSelectionOnly(bool aPrintSelectionOnly) { mPrintSelectionOnly = aPrintSelectionOnly; };
// If not printing the selection, this is stored in the GtkPrintSettings. Printing the
// selection is stored as a protected boolean (mPrintSelectionOnly).
NS_IMETHOD GetPrintRange(int16_t *aPrintRange) override;
NS_IMETHOD SetPrintRange(int16_t aPrintRange) override;
// The page range is stored as as single range in the GtkPrintSettings object.
NS_IMETHOD GetStartPageRange(int32_t *aStartPageRange) override;
NS_IMETHOD SetStartPageRange(int32_t aStartPageRange) override;
NS_IMETHOD GetEndPageRange(int32_t *aEndPageRange) override;
NS_IMETHOD SetEndPageRange(int32_t aEndPageRange) override;
// Reversed, color, orientation and file name are all stored in the GtkPrintSettings.
// Orientation is also stored in the GtkPageSetup and its setting takes priority when getting the orientation.
NS_IMETHOD GetPrintReversed(bool *aPrintReversed) override;
NS_IMETHOD SetPrintReversed(bool aPrintReversed) override;
NS_IMETHOD GetPrintInColor(bool *aPrintInColor) override;
NS_IMETHOD SetPrintInColor(bool aPrintInColor) override;
NS_IMETHOD GetOrientation(int32_t *aOrientation) override;
NS_IMETHOD SetOrientation(int32_t aOrientation) override;
NS_IMETHOD GetToFileName(nsAString& aToFileName) override;
NS_IMETHOD SetToFileName(const nsAString& aToFileName) override;
// Gets/Sets the printer name in the GtkPrintSettings. If no printer name is specified there,
// you will get back the name of the current internal GtkPrinter.
NS_IMETHOD GetPrinterName(nsAString& Printer) override;
NS_IMETHOD SetPrinterName(const nsAString& aPrinter) override;
// Number of copies is stored/gotten from the GtkPrintSettings.
NS_IMETHOD GetNumCopies(int32_t *aNumCopies) override;
NS_IMETHOD SetNumCopies(int32_t aNumCopies) override;
NS_IMETHOD GetScaling(double *aScaling) override;
NS_IMETHOD SetScaling(double aScaling) override;
// A name recognised by GTK is strongly advised here, as this is used to create a GtkPaperSize.
NS_IMETHOD GetPaperName(nsAString& aPaperName) override;
NS_IMETHOD SetPaperName(const nsAString& aPaperName) override;
NS_IMETHOD SetUnwriteableMarginInTwips(nsIntMargin& aUnwriteableMargin) override;
NS_IMETHOD SetUnwriteableMarginTop(double aUnwriteableMarginTop) override;
NS_IMETHOD SetUnwriteableMarginLeft(double aUnwriteableMarginLeft) override;
NS_IMETHOD SetUnwriteableMarginBottom(double aUnwriteableMarginBottom) override;
NS_IMETHOD SetUnwriteableMarginRight(double aUnwriteableMarginRight) override;
NS_IMETHOD GetPaperWidth(double *aPaperWidth) override;
NS_IMETHOD SetPaperWidth(double aPaperWidth) override;
NS_IMETHOD GetPaperHeight(double *aPaperHeight) override;
NS_IMETHOD SetPaperHeight(double aPaperHeight) override;
NS_IMETHOD SetPaperSizeUnit(int16_t aPaperSizeUnit) override;
NS_IMETHOD GetEffectivePageSize(double *aWidth, double *aHeight) override;
NS_IMETHOD SetupSilentPrinting() override;
NS_IMETHOD GetPageRanges(nsTArray<int32_t> &aPages) override;
NS_IMETHOD GetResolution(int32_t *aResolution) override;
NS_IMETHOD SetResolution(int32_t aResolution) override;
NS_IMETHOD GetDuplex(int32_t *aDuplex) override;
NS_IMETHOD SetDuplex(int32_t aDuplex) override;
NS_IMETHOD GetOutputFormat(int16_t *aOutputFormat) override;
protected:
virtual ~nsPrintSettingsGTK();
nsPrintSettingsGTK(const nsPrintSettingsGTK& src);
nsPrintSettingsGTK& operator=(const nsPrintSettingsGTK& rhs);
virtual nsresult _Clone(nsIPrintSettings **_retval) override;
virtual nsresult _Assign(nsIPrintSettings *aPS) override;
GtkUnit GetGTKUnit(int16_t aGeckoUnit);
void SaveNewPageSize();
/**
* Re-initialize mUnwriteableMargin with values from mPageSetup.
* Should be called whenever mPageSetup is initialized or overwritten.
*/
void InitUnwriteableMargin();
/**
* On construction:
* - mPrintSettings and mPageSetup are just new objects with defaults
* determined by GTK.
* - mGTKPrinter is nullptr!!! Remember to be careful when accessing this
* property.
*/
GtkPageSetup* mPageSetup;
GtkPrintSettings* mPrintSettings;
GtkPrinter* mGTKPrinter;
bool mPrintSelectionOnly;
};
NS_DEFINE_STATIC_IID_ACCESSOR(nsPrintSettingsGTK, NS_PRINTSETTINGSGTK_IID)
#endif // nsPrintSettingsGTK_h_