doc: update QPrinter docs for clangqdoc
The docs for QPrinter contained a use of Q_QDoc to declare an enum representing paper sizes for different printers, but this special declaration for qdoc was no longer needed, so it was removed. The real declaration is in QPagedPaintDevice, which is the public base class of QPrinter, and it is documented there. A few other uses of Q_QDOC were examined and either removed or upgraded to Q_CLANG_QDOC. One use of Q_OS_WIN was changed to also be included for Q_CLANG_QDOC. Change-Id: If6d810c624aa8d659fd0e3e753ba666d4d42ef83 Reviewed-by: Martin Smith <martin.smith@qt.io>
This commit is contained in:
Martin Smith
parent
9605f4f47b
commit
29bbbe5e60
@ -449,143 +449,17 @@ public:
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum QPrinter::PaperSize
|
||||
\typedef QPrinter::PaperSize
|
||||
\since 4.4
|
||||
|
||||
typdef for the enum QPagedPaintDevice::PageSize.
|
||||
|
||||
This enum type specifies what paper size QPrinter should use.
|
||||
QPrinter does not check that the paper size is available; it just
|
||||
uses this information, together with QPrinter::Orientation and
|
||||
QPrinter::setFullPage(), to determine the printable area.
|
||||
|
||||
The defined sizes (with setFullPage(true)) are:
|
||||
|
||||
\value A0 841 x 1189 mm
|
||||
\value A1 594 x 841 mm
|
||||
\value A2 420 x 594 mm
|
||||
\value A3 297 x 420 mm
|
||||
\value A4 210 x 297 mm, 8.26 x 11.69 inches
|
||||
\value A5 148 x 210 mm
|
||||
\value A6 105 x 148 mm
|
||||
\value A7 74 x 105 mm
|
||||
\value A8 52 x 74 mm
|
||||
\value A9 37 x 52 mm
|
||||
\value B0 1000 x 1414 mm
|
||||
\value B1 707 x 1000 mm
|
||||
\value B2 500 x 707 mm
|
||||
\value B3 353 x 500 mm
|
||||
\value B4 250 x 353 mm
|
||||
\value B5 176 x 250 mm, 6.93 x 9.84 inches
|
||||
\value B6 125 x 176 mm
|
||||
\value B7 88 x 125 mm
|
||||
\value B8 62 x 88 mm
|
||||
\value B9 33 x 62 mm
|
||||
\value B10 31 x 44 mm
|
||||
\value C5E 163 x 229 mm
|
||||
\value Comm10E 105 x 241 mm, U.S. Common 10 Envelope
|
||||
\value DLE 110 x 220 mm
|
||||
\value Executive 7.5 x 10 inches, 190.5 x 254 mm
|
||||
\value Folio 210 x 330 mm
|
||||
\value Ledger 431.8 x 279.4 mm
|
||||
\value Legal 8.5 x 14 inches, 215.9 x 355.6 mm
|
||||
\value Letter 8.5 x 11 inches, 215.9 x 279.4 mm
|
||||
\value Tabloid 279.4 x 431.8 mm
|
||||
\value Custom Unknown, or a user defined size.
|
||||
\value A10
|
||||
\value A3Extra
|
||||
\value A4Extra
|
||||
\value A4Plus
|
||||
\value A4Small
|
||||
\value A5Extra
|
||||
\value B5Extra
|
||||
\value JisB0
|
||||
\value JisB1
|
||||
\value JisB2
|
||||
\value JisB3
|
||||
\value JisB4
|
||||
\value JisB5
|
||||
\value JisB6,
|
||||
\value JisB7
|
||||
\value JisB8
|
||||
\value JisB9
|
||||
\value JisB10
|
||||
\value AnsiA = Letter
|
||||
\value AnsiB = Ledger
|
||||
\value AnsiC
|
||||
\value AnsiD
|
||||
\value AnsiE
|
||||
\value LegalExtra
|
||||
\value LetterExtra
|
||||
\value LetterPlus
|
||||
\value LetterSmall
|
||||
\value TabloidExtra
|
||||
\value ArchA
|
||||
\value ArchB
|
||||
\value ArchC
|
||||
\value ArchD
|
||||
\value ArchE
|
||||
\value Imperial7x9
|
||||
\value Imperial8x10
|
||||
\value Imperial9x11
|
||||
\value Imperial9x12
|
||||
\value Imperial10x11
|
||||
\value Imperial10x13
|
||||
\value Imperial10x14
|
||||
\value Imperial12x11
|
||||
\value Imperial15x11
|
||||
\value ExecutiveStandard
|
||||
\value Note
|
||||
\value Quarto
|
||||
\value Statement
|
||||
\value SuperA
|
||||
\value SuperB
|
||||
\value Postcard
|
||||
\value DoublePostcard
|
||||
\value Prc16K
|
||||
\value Prc32K
|
||||
\value Prc32KBig
|
||||
\value FanFoldUS
|
||||
\value FanFoldGerman
|
||||
\value FanFoldGermanLegal
|
||||
\value EnvelopeB4
|
||||
\value EnvelopeB5
|
||||
\value EnvelopeB6
|
||||
\value EnvelopeC0
|
||||
\value EnvelopeC1
|
||||
\value EnvelopeC2
|
||||
\value EnvelopeC3
|
||||
\value EnvelopeC4
|
||||
\value EnvelopeC5 = C5E
|
||||
\value EnvelopeC6
|
||||
\value EnvelopeC65
|
||||
\value EnvelopeC7
|
||||
\value EnvelopeDL = DLE
|
||||
\value Envelope9
|
||||
\value Envelope10 = Comm10E
|
||||
\value Envelope11
|
||||
\value Envelope12
|
||||
\value Envelope14
|
||||
\value EnvelopeMonarch
|
||||
\value EnvelopePersonal
|
||||
\value EnvelopeChou3
|
||||
\value EnvelopeChou4
|
||||
\value EnvelopeInvite
|
||||
\value EnvelopeItalian
|
||||
\value EnvelopeKaku2
|
||||
\value EnvelopeKaku3
|
||||
\value EnvelopePrc1
|
||||
\value EnvelopePrc2
|
||||
\value EnvelopePrc3
|
||||
\value EnvelopePrc4
|
||||
\value EnvelopePrc5
|
||||
\value EnvelopePrc6
|
||||
\value EnvelopePrc7
|
||||
\value EnvelopePrc8
|
||||
\value EnvelopePrc9
|
||||
\value EnvelopePrc10
|
||||
\value EnvelopeYou4
|
||||
\value LastPageSize = EnvelopeYou4
|
||||
\omitvalue NPageSize
|
||||
\omitvalue NPaperSize
|
||||
The defined sizes (with setFullPage(true)) are found in QPagedPaintDevice.
|
||||
|
||||
With setFullPage(false) (the default), the metrics will be a bit
|
||||
smaller; how much depends on the printer in use.
|
||||
@ -1032,7 +906,7 @@ void QPrinter::setCreator(const QString &creator)
|
||||
}
|
||||
|
||||
// Defined in QPagedPaintDevice but non-virtual, add QPrinter specific doc here
|
||||
#ifdef Q_QDOC
|
||||
#ifdef Q_CLANG_QDOC
|
||||
/*!
|
||||
\fn bool QPrinter::setPageLayout(const QPageLayout &newLayout)
|
||||
\since 5.3
|
||||
@ -1997,7 +1871,7 @@ QPrinter::PrinterState QPrinter::printerState() const
|
||||
return d->printEngine->printerState();
|
||||
}
|
||||
|
||||
#ifdef Q_OS_WIN
|
||||
#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC)
|
||||
/*!
|
||||
Returns the supported paper sizes for this printer.
|
||||
|
||||
|
||||
@ -77,161 +77,7 @@ public:
|
||||
enum Orientation { Portrait, Landscape };
|
||||
|
||||
// ### Qt6 Remove in favor of QPage::PageSize
|
||||
// NOTE: Must keep in sync with QPageSize and QPagedPaintDevice
|
||||
#ifndef Q_QDOC
|
||||
typedef PageSize PaperSize;
|
||||
#else
|
||||
enum PaperSize {
|
||||
// Existing Qt sizes
|
||||
A4,
|
||||
B5,
|
||||
Letter,
|
||||
Legal,
|
||||
Executive,
|
||||
A0,
|
||||
A1,
|
||||
A2,
|
||||
A3,
|
||||
A5,
|
||||
A6,
|
||||
A7,
|
||||
A8,
|
||||
A9,
|
||||
B0,
|
||||
B1,
|
||||
B10,
|
||||
B2,
|
||||
B3,
|
||||
B4,
|
||||
B6,
|
||||
B7,
|
||||
B8,
|
||||
B9,
|
||||
C5E,
|
||||
Comm10E,
|
||||
DLE,
|
||||
Folio,
|
||||
Ledger,
|
||||
Tabloid,
|
||||
Custom,
|
||||
|
||||
// New values derived from PPD standard
|
||||
A10,
|
||||
A3Extra,
|
||||
A4Extra,
|
||||
A4Plus,
|
||||
A4Small,
|
||||
A5Extra,
|
||||
B5Extra,
|
||||
|
||||
JisB0,
|
||||
JisB1,
|
||||
JisB2,
|
||||
JisB3,
|
||||
JisB4,
|
||||
JisB5,
|
||||
JisB6,
|
||||
JisB7,
|
||||
JisB8,
|
||||
JisB9,
|
||||
JisB10,
|
||||
|
||||
// AnsiA = Letter,
|
||||
// AnsiB = Ledger,
|
||||
AnsiC,
|
||||
AnsiD,
|
||||
AnsiE,
|
||||
LegalExtra,
|
||||
LetterExtra,
|
||||
LetterPlus,
|
||||
LetterSmall,
|
||||
TabloidExtra,
|
||||
|
||||
ArchA,
|
||||
ArchB,
|
||||
ArchC,
|
||||
ArchD,
|
||||
ArchE,
|
||||
|
||||
Imperial7x9,
|
||||
Imperial8x10,
|
||||
Imperial9x11,
|
||||
Imperial9x12,
|
||||
Imperial10x11,
|
||||
Imperial10x13,
|
||||
Imperial10x14,
|
||||
Imperial12x11,
|
||||
Imperial15x11,
|
||||
|
||||
ExecutiveStandard,
|
||||
Note,
|
||||
Quarto,
|
||||
Statement,
|
||||
SuperA,
|
||||
SuperB,
|
||||
Postcard,
|
||||
DoublePostcard,
|
||||
Prc16K,
|
||||
Prc32K,
|
||||
Prc32KBig,
|
||||
|
||||
FanFoldUS,
|
||||
FanFoldGerman,
|
||||
FanFoldGermanLegal,
|
||||
|
||||
EnvelopeB4,
|
||||
EnvelopeB5,
|
||||
EnvelopeB6,
|
||||
EnvelopeC0,
|
||||
EnvelopeC1,
|
||||
EnvelopeC2,
|
||||
EnvelopeC3,
|
||||
EnvelopeC4,
|
||||
// EnvelopeC5 = C5E,
|
||||
EnvelopeC6,
|
||||
EnvelopeC65,
|
||||
EnvelopeC7,
|
||||
// EnvelopeDL = DLE,
|
||||
|
||||
Envelope9,
|
||||
// Envelope10 = Comm10E,
|
||||
Envelope11,
|
||||
Envelope12,
|
||||
Envelope14,
|
||||
EnvelopeMonarch,
|
||||
EnvelopePersonal,
|
||||
|
||||
EnvelopeChou3,
|
||||
EnvelopeChou4,
|
||||
EnvelopeInvite,
|
||||
EnvelopeItalian,
|
||||
EnvelopeKaku2,
|
||||
EnvelopeKaku3,
|
||||
EnvelopePrc1,
|
||||
EnvelopePrc2,
|
||||
EnvelopePrc3,
|
||||
EnvelopePrc4,
|
||||
EnvelopePrc5,
|
||||
EnvelopePrc6,
|
||||
EnvelopePrc7,
|
||||
EnvelopePrc8,
|
||||
EnvelopePrc9,
|
||||
EnvelopePrc10,
|
||||
EnvelopeYou4,
|
||||
|
||||
// Last item, with commonly used synynoms from QPagedPrintEngine / QPrinter
|
||||
LastPageSize = EnvelopeYou4,
|
||||
NPageSize = LastPageSize,
|
||||
NPaperSize = LastPageSize,
|
||||
|
||||
// Convenience overloads for naming consistency
|
||||
AnsiA = Letter,
|
||||
AnsiB = Ledger,
|
||||
EnvelopeC5 = C5E,
|
||||
EnvelopeDL = DLE,
|
||||
Envelope10 = Comm10E
|
||||
};
|
||||
#endif
|
||||
|
||||
enum PageOrder { FirstPageFirst,
|
||||
LastPageFirst };
|
||||
@ -305,7 +151,8 @@ public:
|
||||
void setCreator(const QString &);
|
||||
QString creator() const;
|
||||
|
||||
#ifdef Q_QDOC
|
||||
#ifdef Q_CLANG_QDOC
|
||||
// ### Qt6 Remove when these are made virtual in QPagedPaintDevice
|
||||
bool setPageLayout(const QPageLayout &pageLayout);
|
||||
bool setPageSize(const QPageSize &pageSize);
|
||||
bool setPageOrientation(QPageLayout::Orientation orientation);
|
||||
@ -366,7 +213,7 @@ public:
|
||||
|
||||
QList<int> supportedResolutions() const;
|
||||
|
||||
#ifdef Q_OS_WIN
|
||||
#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC)
|
||||
QList<PaperSource> supportedPaperSources() const;
|
||||
#endif
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user