1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* 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/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_VCL_PRINT_HXX
#define INCLUDED_VCL_PRINT_HXX
#include <rtl/ustring.hxx>
#include <vcl/errcode.hxx>
#include <tools/solar.h>
#include <vcl/dllapi.h>
#include <vcl/outdev.hxx>
#include <vcl/prntypes.hxx>
#include <vcl/jobset.hxx>
#include <vcl/gdimtf.hxx>
#include <tools/multisel.hxx>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/view/PrintableState.hpp>
#include <memory>
#include <set>
#include <unordered_map>
class SalInfoPrinter;
struct SalPrinterQueueInfo;
class SalPrinter;
class VirtualDevice;
namespace vcl { class Window; }
namespace vcl {
class PrinterController;
class PrintDialog;
}
enum class PrinterSupport
{
SetOrientation,
SetPaperSize, SetPaper,
CollateCopy,
SetupDialog
};
class VCL_DLLPUBLIC QueueInfo
{
friend class Printer;
private:
OUString maPrinterName;
OUString maDriver;
OUString maLocation;
OUString maComment;
PrintQueueFlags mnStatus;
sal_uInt32 mnJobs;
public:
QueueInfo();
QueueInfo( const QueueInfo& rInfo );
~QueueInfo();
const OUString& GetPrinterName() const { return maPrinterName; }
const OUString& GetDriver() const { return maDriver; }
const OUString& GetLocation() const { return maLocation; }
const OUString& GetComment() const { return maComment; }
PrintQueueFlags GetStatus() const { return mnStatus; }
sal_uInt32 GetJobs() const { return mnJobs; }
};
enum class PrinterTransparencyMode
{
Auto = 0,
NONE = 1
};
enum class PrinterGradientMode
{
Stripes = 0,
Color = 1
};
enum class PrinterBitmapMode
{
Optimal = 0,
Normal = 1,
Resolution = 2
};
class VCL_DLLPUBLIC PrinterOptions
{
private:
bool mbReduceTransparency;
PrinterTransparencyMode meReducedTransparencyMode;
bool mbReduceGradients;
PrinterGradientMode meReducedGradientsMode;
sal_uInt16 mnReducedGradientStepCount;
bool mbReduceBitmaps;
PrinterBitmapMode meReducedBitmapMode;
sal_uInt16 mnReducedBitmapResolution;
bool mbReducedBitmapsIncludeTransparency;
bool mbConvertToGreyscales;
bool mbPDFAsStandardPrintJobFormat;
public:
PrinterOptions();
~PrinterOptions();
bool IsReduceTransparency() const { return mbReduceTransparency; }
void SetReduceTransparency( bool bSet ) { mbReduceTransparency = bSet; }
PrinterTransparencyMode GetReducedTransparencyMode() const { return meReducedTransparencyMode; }
void SetReducedTransparencyMode( PrinterTransparencyMode eMode )
{ meReducedTransparencyMode = eMode; }
bool IsReduceGradients() const { return mbReduceGradients; }
void SetReduceGradients( bool bSet ) { mbReduceGradients = bSet; }
PrinterGradientMode GetReducedGradientMode() const { return meReducedGradientsMode; }
void SetReducedGradientMode( PrinterGradientMode eMode ) { meReducedGradientsMode = eMode; }
sal_uInt16 GetReducedGradientStepCount() const { return mnReducedGradientStepCount; }
void SetReducedGradientStepCount( sal_uInt16 nStepCount )
{ mnReducedGradientStepCount = nStepCount; }
bool IsReduceBitmaps() const { return mbReduceBitmaps; }
void SetReduceBitmaps( bool bSet ) { mbReduceBitmaps = bSet; }
PrinterBitmapMode GetReducedBitmapMode() const { return meReducedBitmapMode; }
void SetReducedBitmapMode( PrinterBitmapMode eMode ) { meReducedBitmapMode = eMode; }
sal_uInt16 GetReducedBitmapResolution() const { return mnReducedBitmapResolution; }
void SetReducedBitmapResolution( sal_uInt16 nResolution )
{ mnReducedBitmapResolution = nResolution; }
bool IsReducedBitmapIncludesTransparency() const { return mbReducedBitmapsIncludeTransparency; }
void SetReducedBitmapIncludesTransparency( bool bSet )
{ mbReducedBitmapsIncludeTransparency = bSet; }
bool IsConvertToGreyscales() const { return mbConvertToGreyscales; }
void SetConvertToGreyscales( bool bSet ) { mbConvertToGreyscales = bSet; }
bool IsPDFAsStandardPrintJobFormat() const { return mbPDFAsStandardPrintJobFormat; }
void SetPDFAsStandardPrintJobFormat( bool bSet ) { mbPDFAsStandardPrintJobFormat = bSet; }
/** Read printer options from configuration
parameter decides whether the set for
print "to printer" or "to file" should be read.
@return True if config was read, false if an error occurred
*/
bool ReadFromConfig( bool bFile );
};
class VCL_DLLPUBLIC Printer : public OutputDevice
{
friend class ::OutputDevice;
private:
SalInfoPrinter* mpInfoPrinter;
SalPrinter* mpPrinter;
SalGraphics* mpJobGraphics;
VclPtr<Printer> mpPrev;
VclPtr<Printer> mpNext;
VclPtr<VirtualDevice> mpDisplayDev;
PrinterOptions* mpPrinterOptions;
OUString maPrinterName;
OUString maDriver;
OUString maPrintFile;
OUString maJobName;
JobSetup maJobSetup;
Point maPageOffset;
Size maPaperSize;
ErrCode mnError;
sal_uInt16 mnPageQueueSize;
sal_uInt16 mnCopyCount;
bool mbDefPrinter;
bool mbPrinting;
bool mbJobActive;
bool mbCollateCopy;
bool mbPrintFile;
bool mbInPrintPage;
bool mbNewJobSetup;
SAL_DLLPRIVATE void ImplInitData();
SAL_DLLPRIVATE void ImplInit( SalPrinterQueueInfo* pInfo );
SAL_DLLPRIVATE void ImplInitDisplay();
SAL_DLLPRIVATE static SalPrinterQueueInfo*
ImplGetQueueInfo( const OUString& rPrinterName, const OUString* pDriver );
SAL_DLLPRIVATE void ImplUpdatePageData();
SAL_DLLPRIVATE void ImplUpdateFontList();
SAL_DLLPRIVATE void ImplFindPaperFormatForUserSize( JobSetup&, bool bMatchNearest );
SAL_DLLPRIVATE bool StartJob( const OUString& rJobName, std::shared_ptr<vcl::PrinterController> const & );
static SAL_DLLPRIVATE ErrCode
ImplSalPrinterErrorCodeToVCL( sal_uLong nError );
private:
SAL_DLLPRIVATE bool EndJob();
Printer( const Printer& rPrinter ) = delete;
Printer& operator =( const Printer& rPrinter ) = delete;
public:
SAL_DLLPRIVATE void ImplStartPage();
SAL_DLLPRIVATE void ImplEndPage();
protected:
virtual bool AcquireGraphics() const override;
virtual void ReleaseGraphics( bool bRelease = true ) override;
virtual void ImplReleaseFonts() override;
virtual long GetGradientStepCount( long nMinRect ) override;
virtual bool UsePolyPolygonForComplexGradient() override;
virtual void ClipAndDrawGradientMetafile ( const Gradient &rGradient,
const tools::PolyPolygon &rPolyPoly ) override;
void ScaleBitmap ( Bitmap&, SalTwoRect& ) override { };
public:
void DrawGradientEx( OutputDevice* pOut, const tools::Rectangle& rRect,
const Gradient& rGradient );
virtual Bitmap GetBitmap( const Point& rSrcPt, const Size& rSize ) const override;
protected:
virtual void DrawDeviceMask( const Bitmap& rMask, const Color& rMaskColor,
const Point& rDestPt, const Size& rDestSize,
const Point& rSrcPtPixel, const Size& rSrcSizePixel) override;
bool DrawTransformBitmapExDirect( const basegfx::B2DHomMatrix& aFullTransform,
const BitmapEx& rBitmapEx) override;
bool TransformAndReduceBitmapExToTargetRange( const basegfx::B2DHomMatrix& aFullTransform,
basegfx::B2DRange &aVisibleRange, double &fMaximumArea) override;
void DrawDeviceBitmap( const Point& rDestPt, const Size& rDestSize,
const Point& rSrcPtPixel, const Size& rSrcSizePixel,
BitmapEx& rBitmapEx ) override;
virtual void EmulateDrawTransparent( const tools::PolyPolygon& rPolyPoly,
sal_uInt16 nTransparencePercent ) override;
virtual void InitFont() const override;
virtual void SetFontOrientation( LogicalFontInstance* const pFontInstance ) const override;
public:
Printer();
Printer( const JobSetup& rJobSetup );
Printer( const QueueInfo& rQueueInfo );
Printer( const OUString& rPrinterName );
virtual ~Printer() override;
virtual void dispose() override;
static const std::vector< OUString >&
GetPrinterQueues();
static const QueueInfo* GetQueueInfo( const OUString& rPrinterName, bool bStatusUpdate );
static OUString GetDefaultPrinterName();
const OUString& GetName() const { return maPrinterName; }
const OUString& GetDriverName() const { return maDriver; }
bool IsDefPrinter() const { return mbDefPrinter; }
bool IsDisplayPrinter() const { return mpDisplayDev != nullptr; }
bool IsValid() const { return !IsDisplayPrinter(); }
sal_uInt32 GetCapabilities( PrinterCapType nType ) const;
bool HasSupport( PrinterSupport eFeature ) const;
bool SetJobSetup( const JobSetup& rSetup );
const JobSetup& GetJobSetup() const { return maJobSetup; }
bool Setup( vcl::Window* pWindow, bool bPapersizeFromSetup = false );
bool SetPrinterProps( const Printer* pPrinter );
/** SetPrinterOptions is used internally only now
in earlier times it was used only to set the options loaded directly from the configuration
in SfxPrinter::InitJob, this is now handled internally
should the need arise to set the printer options outside vcl, also a method would have to be devised
to not override these again internally
*/
SAL_DLLPRIVATE void SetPrinterOptions( const PrinterOptions& rOptions );
const PrinterOptions& GetPrinterOptions() const { return( *mpPrinterOptions ); }
bool SetOrientation( Orientation eOrient );
Orientation GetOrientation() const;
bool SetDuplexMode( DuplexMode );
bool SetPaperBin( sal_uInt16 nPaperBin );
sal_uInt16 GetPaperBin() const;
bool SetPaper( Paper ePaper );
bool SetPaperSizeUser( const Size& rSize );
bool SetPaperSizeUser( const Size& rSize, bool bMatchNearest );
Paper GetPaper() const;
static OUString GetPaperName( Paper ePaper );
/** @return A UI string for the current paper; an empty string for PAPER_USER */
OUString GetPaperName() const;
/** @return Number of available paper formats */
int GetPaperInfoCount() const;
/** @return Info about paper format nPaper */
const PaperInfo& GetPaperInfo( int nPaper ) const;
sal_uInt16 GetPaperBinCount() const;
OUString GetPaperBinName( sal_uInt16 nPaperBin ) const;
const Size& GetPaperSizePixel() const { return maPaperSize; }
Size GetPaperSize() const { return PixelToLogic( maPaperSize ); }
const Point& GetPageOffsetPixel() const { return maPageOffset; }
Point GetPageOffset() const { return PixelToLogic( maPageOffset ); }
bool SetCopyCount( sal_uInt16 nCopy, bool bCollate );
sal_uInt16 GetCopyCount() const { return mnCopyCount; }
bool IsCollateCopy() const { return mbCollateCopy; }
bool IsPrinting() const { return mbPrinting; }
bool IsJobActive() const { return mbJobActive; }
/** Checks the printer list and updates it necessary
sends a DataChanged event of type DataChangedEventType::PRINTER if the printer list changed
*/
static void updatePrinters();
/** Execute a print job
starts a print job asynchronously that is will return
*/
static void PrintJob( const std::shared_ptr<vcl::PrinterController>& i_pController,
const JobSetup& i_rInitSetup );
virtual bool HasMirroredGraphics() const override;
virtual void DrawOutDev( const Point& rDestPt, const Size& rDestSize,
const Point& rSrcPt, const Size& rSrcSize ) override;
virtual void DrawOutDev( const Point& rDestPt, const Size& rDestSize,
const Point& rSrcPt, const Size& rSrcSize,
const OutputDevice& rOutDev ) override;
virtual void CopyArea( const Point& rDestPt, const Point& rSrcPt,
const Size& rSrcSize, bool bWindowInvalidate = false ) override;
// These 3 together are more modular PrintJob(), allowing printing more documents as one print job
// by repeated calls to ExecutePrintJob(). Used by mailmerge.
static bool PreparePrintJob( std::shared_ptr<vcl::PrinterController> i_pController,
const JobSetup& i_rInitSetup );
static bool ExecutePrintJob( std::shared_ptr<vcl::PrinterController> i_pController );
static void FinishPrintJob( const std::shared_ptr<vcl::PrinterController>& i_pController );
/** Implementation detail of PrintJob being asynchronous
not exported, not usable outside vcl
*/
static void SAL_DLLPRIVATE ImplPrintJob( const std::shared_ptr<vcl::PrinterController>& i_pController,
const JobSetup& i_rInitSetup );
};
namespace vcl
{
class ImplPrinterControllerData;
enum class NupOrderType
{
LRTB, TBLR, TBRL, RLTB
};
class VCL_DLLPUBLIC PrinterController
{
std::unique_ptr<ImplPrinterControllerData>
mpImplData;
protected:
PrinterController( const VclPtr<Printer>& );
public:
struct MultiPageSetup
{
// all metrics in 100th mm
int nRows;
int nColumns;
Size aPaperSize;
long nLeftMargin;
long nTopMargin;
long nRightMargin;
long nBottomMargin;
long nHorizontalSpacing;
long nVerticalSpacing;
bool bDrawBorder;
NupOrderType nOrder;
MultiPageSetup()
: nRows( 1 ), nColumns( 1 ), aPaperSize( 21000, 29700 )
, nLeftMargin( 0 ), nTopMargin( 0 )
, nRightMargin( 0 ), nBottomMargin( 0 )
, nHorizontalSpacing( 0 ), nVerticalSpacing( 0 )
, bDrawBorder( false )
, nOrder( NupOrderType::LRTB ) {}
};
struct PageSize
{
/// In 100th mm
Size aSize;
/// Full paper, not only imageable area is printed
bool bFullPaper;
PageSize( const Size& i_rSize = Size( 21000, 29700 ),
bool i_bFullPaper = false)
: aSize( i_rSize ), bFullPaper( i_bFullPaper ) {}
};
virtual ~PrinterController();
const VclPtr<Printer>& getPrinter() const;
/** For implementations: get current job properties as changed by e.g. print dialog
this gets the current set of properties initially told to Printer::PrintJob
For convenience a second sequence will be merged in to get a combined sequence.
In case of duplicate property names, the value of i_MergeList wins.
*/
css::uno::Sequence< css::beans::PropertyValue >
getJobProperties(const css::uno::Sequence< css::beans::PropertyValue >& i_rMergeList ) const;
/// Get the PropertyValue of a Property
css::beans::PropertyValue* getValue( const OUString& i_rPropertyName );
const css::beans::PropertyValue* getValue( const OUString& i_rPropertyName ) const;
/** Get a bool property
in case the property is unknown or not convertible to bool, i_bFallback is returned
*/
bool getBoolProperty( const OUString& i_rPropertyName, bool i_bFallback ) const;
/** Get an int property
in case the property is unknown or not convertible to bool, i_nFallback is returned
*/
sal_Int32 getIntProperty( const OUString& i_rPropertyName, sal_Int32 i_nFallback ) const;
/// Set a property value - can also be used to add another UI property
void setValue( const OUString& i_rPropertyName, const css::uno::Any& i_rValue );
void setValue( const css::beans::PropertyValue& i_rValue );
/** @return The currently active UI options. These are the same that were passed to setUIOptions. */
const css::uno::Sequence< css::beans::PropertyValue >&
getUIOptions() const;
/** Set possible UI options.
should only be done once before passing the PrinterListener to Printer::PrintJob
*/
void setUIOptions( const css::uno::Sequence< css::beans::PropertyValue >& );
/// Enable/disable an option; this can be used to implement dialog logic.
bool isUIOptionEnabled( const OUString& rPropName ) const;
bool isUIChoiceEnabled( const OUString& rPropName, sal_Int32 nChoice ) const;
/** @return The property name rPropName depends on or an empty string
if no dependency exists.
*/
OUString getDependency( const OUString& rPropName ) const;
/** MakeEnabled will change the property rPropName depends on to the value
that makes rPropName enabled. If the dependency itself is also disabled,
no action will be performed.
@return The property name rPropName depends on or an empty string if no change was made.
*/
OUString makeEnabled( const OUString& rPropName );
/// App must override this
virtual int getPageCount() const = 0;
/** Get the page parameters
namely the jobsetup that should be active for the page
(describing among others the physical page size) and the "page size". In writer
case this would probably be the same as the JobSetup since writer sets the page size
draw/impress for example print their page on the paper set on the printer,
possibly adjusting the page size to fit. That means the page size can be different from
the paper size.
App must override this
@return Page size in 1/100th mm
*/
virtual css::uno::Sequence< css::beans::PropertyValue >
getPageParameters( int i_nPage ) const = 0;
/// App must override this
virtual void printPage(int i_nPage) const = 0;
/// Will be called after a possible dialog has been shown and the real printjob starts
virtual void jobStarted();
virtual void jobFinished( css::view::PrintableState );
css::view::PrintableState getJobState() const;
void abortJob();
bool isShowDialogs() const;
bool isDirectPrint() const;
// implementation details, not usable outside vcl
// don't use outside vcl. Some of these are exported for
// the benefit of vcl's plugins.
// Still: DO NOT USE OUTSIDE VCL
VCL_PLUGIN_PUBLIC int getFilteredPageCount();
SAL_DLLPRIVATE PageSize getPageFile( int i_inUnfilteredPage, GDIMetaFile& rMtf,
bool i_bMayUseCache = false );
VCL_PLUGIN_PUBLIC PageSize getFilteredPageFile( int i_nFilteredPage, GDIMetaFile& o_rMtf,
bool i_bMayUseCache = false );
VCL_PLUGIN_PUBLIC void printFilteredPage( int i_nPage );
SAL_DLLPRIVATE void setPrinter( const VclPtr<Printer>& );
VCL_PLUGIN_PUBLIC void createProgressDialog();
VCL_PLUGIN_PUBLIC bool isProgressCanceled() const;
SAL_DLLPRIVATE void setMultipage( const MultiPageSetup& );
SAL_DLLPRIVATE const MultiPageSetup&
getMultipage() const;
VCL_PLUGIN_PUBLIC void setLastPage( bool i_bLastPage );
SAL_DLLPRIVATE void setReversePrint( bool i_bReverse );
SAL_DLLPRIVATE bool getReversePrint() const;
SAL_DLLPRIVATE void setPapersizeFromSetup( bool i_bPapersizeFromSetup );
SAL_DLLPRIVATE bool getPapersizeFromSetup() const;
VCL_PLUGIN_PUBLIC void setPrinterModified( bool i_bPapersizeFromSetup );
VCL_PLUGIN_PUBLIC bool getPrinterModified() const;
SAL_DLLPRIVATE void pushPropertiesToPrinter();
SAL_DLLPRIVATE void resetPaperToLastConfigured();
VCL_PLUGIN_PUBLIC void setJobState( css::view::PrintableState );
SAL_DLLPRIVATE bool setupPrinter( vcl::Window* i_pDlgParent );
SAL_DLLPRIVATE int getPageCountProtected() const;
SAL_DLLPRIVATE css::uno::Sequence< css::beans::PropertyValue >
getPageParametersProtected( int i_nPage ) const;
SAL_DLLPRIVATE DrawModeFlags removeTransparencies( GDIMetaFile const & i_rIn, GDIMetaFile& o_rOut );
SAL_DLLPRIVATE void resetPrinterOptions( bool i_bFileOutput );
};
class VCL_DLLPUBLIC PrinterOptionsHelper
{
protected:
std::unordered_map< OUString, css::uno::Any, OUStringHash >
m_aPropertyMap;
std::vector< css::beans::PropertyValue >
m_aUIProperties;
public:
/// Create without ui properties
PrinterOptionsHelper() {}
/** Process a new set of properties
merges changed properties and returns "true" if any occurred
*/
bool processProperties( const css::uno::Sequence< css::beans::PropertyValue >& i_rNewProp );
/** Append to a sequence of property values the ui property sequence passed at creation
as the "ExtraPrintUIOptions" property. if that sequence was empty, no "ExtraPrintUIOptions" property
will be appended.
*/
void appendPrintUIOptions( css::uno::Sequence< css::beans::PropertyValue >& io_rProps ) const;
/** @return An empty Any for not existing properties */
css::uno::Any getValue( const OUString& i_rPropertyName ) const;
bool getBoolValue( const OUString& i_rPropertyName, bool i_bDefault ) const;
// convenience for fixed strings
bool getBoolValue( const char* i_pPropName, bool i_bDefault = false ) const
{ return getBoolValue( OUString::createFromAscii( i_pPropName ), i_bDefault ); }
sal_Int64 getIntValue( const OUString& i_rPropertyName, sal_Int64 i_nDefault ) const;
// convenience for fixed strings
sal_Int64 getIntValue( const char* i_pPropName, sal_Int64 i_nDefault ) const
{ return getIntValue( OUString::createFromAscii( i_pPropName ), i_nDefault ); }
OUString getStringValue( const OUString& i_rPropertyName ) const;
// convenience for fixed strings
OUString getStringValue( const char* i_pPropName ) const
{ return getStringValue( OUString::createFromAscii( i_pPropName ) ); }
// helper functions for user to create a single control
struct UIControlOptions
{
OUString maDependsOnName;
sal_Int32 mnDependsOnEntry;
bool mbAttachToDependency;
OUString maGroupHint;
bool mbInternalOnly;
bool mbEnabled;
std::vector< css::beans::PropertyValue >
maAddProps;
UIControlOptions( const OUString& i_rDependsOnName = OUString(),
sal_Int32 i_nDependsOnEntry = -1, bool i_bAttachToDependency = false)
: maDependsOnName( i_rDependsOnName )
, mnDependsOnEntry( i_nDependsOnEntry )
, mbAttachToDependency( i_bAttachToDependency )
, mbInternalOnly( false )
, mbEnabled( true ) {}
};
// note: in the following helper functions HelpIds are expected as an OUString
// the normal HelpId form is OString (byte string instead of UTF16 string)
// this is because the whole interface is base on UNO properties; in fact the structures
// are passed over UNO interfaces. UNO does not know a byte string, hence the string is
// transported via UTF16 strings.
/// Show general control
static css::uno::Any setUIControlOpt( const css::uno::Sequence< OUString >& i_rIDs, const OUString& i_rTitle,
const css::uno::Sequence< OUString >& i_rHelpId, const OUString& i_rType,
const css::beans::PropertyValue* i_pValue = nullptr,
const UIControlOptions& i_rControlOptions = UIControlOptions());
/// Show and set the title of a TagPage of id i_rID
static css::uno::Any setGroupControlOpt( const OUString& i_rID, const OUString& i_rTitle,
const OUString& i_rHelpId);
/// Show and set the label of a VclFrame of id i_rID
static css::uno::Any setSubgroupControlOpt( const OUString& i_rID, const OUString& i_rTitle, const OUString& i_rHelpId,
const UIControlOptions& i_rControlOptions = UIControlOptions());
/// Show a bool option as a checkbox
static css::uno::Any setBoolControlOpt( const OUString& i_rID, const OUString& i_rTitle, const OUString& i_rHelpId,
const OUString& i_rProperty, bool i_bValue,
const UIControlOptions& i_rControlOptions = UIControlOptions());
/// Show a set of choices in a list box
static css::uno::Any setChoiceListControlOpt( const OUString& i_rID, const OUString& i_rTitle,
const css::uno::Sequence< OUString >& i_rHelpId, const OUString& i_rProperty,
const css::uno::Sequence< OUString >& i_rChoices, sal_Int32 i_nValue,
const css::uno::Sequence< sal_Bool >& i_rDisabledChoices = css::uno::Sequence< sal_Bool >(),
const UIControlOptions& i_rControlOptions = UIControlOptions());
/// Show a set of choices as radio buttons
static css::uno::Any setChoiceRadiosControlOpt( const css::uno::Sequence< OUString >& i_rIDs,
const OUString& i_rTitle, const css::uno::Sequence< OUString >& i_rHelpId,
const OUString& i_rProperty, const css::uno::Sequence< OUString >& i_rChoices,
sal_Int32 i_nValue,
const css::uno::Sequence< sal_Bool >& i_rDisabledChoices = css::uno::Sequence< sal_Bool >(),
const UIControlOptions& i_rControlOptions = UIControlOptions());
/** Show an integer range (e.g. a spin field)
note: max value < min value means do not apply min/max values
*/
static css::uno::Any setRangeControlOpt( const OUString& i_rID, const OUString& i_rTitle, const OUString& i_rHelpId,
const OUString& i_rProperty, sal_Int32 i_nValue, sal_Int32 i_nMinValue,
sal_Int32 i_nMaxValue, const UIControlOptions& i_rControlOptions);
/** Show a string field
note: max value < min value means do not apply min/max values
*/
static css::uno::Any setEditControlOpt( const OUString& i_rID, const OUString& i_rTitle, const OUString& i_rHelpId,
const OUString& i_rProperty, const OUString& i_rValue,
const UIControlOptions& i_rControlOptions);
}; // class PrinterOptionsHelper
} // namespace vcl
#endif // INCLUDED_VCL_PRINT_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|