ddaebfb270
Changing the orientation value to anything else than 'Automatic'
didn't do anything by default. This was because by default
neither isPaperSizeFromUser() nor getPapersizeFromSetup()
were set, so PrintDialog::setPaperOrientation() did nothing.
It looks to me like 8cbdc6a068 that introduced it
was rather broken (not just this bug, but also e.g. the ugly
modifying of the paper sizes by non-const reference from a const
function). In fact this whole stuff still looks broken to me, why
does it change paper size instead of just setting the orientation?
It seems like the orientation gets reset, or maybe the setting
was just a band-aid. I don't know how to fix that all though.
Change-Id: If5fdf4c47e06f2b0797d27126d21b3451b8334cf
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/129239
Tested-by: Jenkins
Reviewed-by: Luboš Luňák <l.lunak@collabora.com>
615 lines
29 KiB
C++
615 lines
29 KiB
C++
/* -*- 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 <sal/config.h>
|
|
|
|
#include <sal/types.h>
|
|
#include <rtl/ustring.hxx>
|
|
#include <tools/gen.hxx>
|
|
#include <tools/long.hxx>
|
|
#include <i18nutil/paper.hxx>
|
|
|
|
#include <vcl/dllapi.h>
|
|
#include <vcl/PrinterSupport.hxx>
|
|
#include <vcl/errcode.hxx>
|
|
#include <vcl/outdev.hxx>
|
|
#include <vcl/prntypes.hxx>
|
|
#include <vcl/region.hxx>
|
|
#include <vcl/jobset.hxx>
|
|
|
|
#include <com/sun/star/beans/PropertyValue.hpp>
|
|
#include <com/sun/star/uno/Sequence.hxx>
|
|
#include <com/sun/star/view/PrintableState.hpp>
|
|
|
|
#include <memory>
|
|
#include <unordered_map>
|
|
|
|
class GDIMetaFile;
|
|
class SalInfoPrinter;
|
|
struct SalPrinterQueueInfo;
|
|
class QueueInfo;
|
|
class SalPrinter;
|
|
class VirtualDevice;
|
|
enum class SalPrinterError;
|
|
|
|
namespace vcl {
|
|
class PrinterController;
|
|
|
|
namespace printer {
|
|
class Options;
|
|
}
|
|
}
|
|
|
|
namespace weld { class Window; }
|
|
|
|
class VCL_DLLPUBLIC Printer : public OutputDevice
|
|
{
|
|
friend class ::OutputDevice;
|
|
|
|
private:
|
|
SalInfoPrinter* mpInfoPrinter;
|
|
std::unique_ptr<SalPrinter> mpPrinter;
|
|
SalGraphics* mpJobGraphics;
|
|
VclPtr<Printer> mpPrev;
|
|
VclPtr<Printer> mpNext;
|
|
VclPtr<VirtualDevice> mpDisplayDev;
|
|
std::unique_ptr<vcl::printer::Options> mpPrinterOptions;
|
|
OUString maPrinterName;
|
|
OUString maDriver;
|
|
OUString maPrintFile;
|
|
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;
|
|
bool mbSinglePrintJobs;
|
|
|
|
VCL_DLLPRIVATE void ImplInitData();
|
|
VCL_DLLPRIVATE void ImplInit( SalPrinterQueueInfo* pInfo );
|
|
VCL_DLLPRIVATE void ImplInitDisplay();
|
|
VCL_DLLPRIVATE static SalPrinterQueueInfo*
|
|
ImplGetQueueInfo( const OUString& rPrinterName, const OUString* pDriver );
|
|
VCL_DLLPRIVATE void ImplUpdatePageData();
|
|
VCL_DLLPRIVATE void ImplUpdateFontList();
|
|
VCL_DLLPRIVATE void ImplFindPaperFormatForUserSize( JobSetup& );
|
|
|
|
VCL_DLLPRIVATE bool StartJob( const OUString& rJobName, std::shared_ptr<vcl::PrinterController> const & );
|
|
|
|
static VCL_DLLPRIVATE ErrCode
|
|
ImplSalPrinterErrorCodeToVCL( SalPrinterError nError );
|
|
|
|
SAL_DLLPRIVATE void ImplPrintTransparent (
|
|
const Bitmap& rBmp, const Bitmap& rMask,
|
|
const Point& rDestPt, const Size& rDestSize,
|
|
const Point& rSrcPtPixel, const Size& rSrcSizePixel );
|
|
|
|
private:
|
|
VCL_DLLPRIVATE void EndJob();
|
|
Printer( const Printer& rPrinter ) = delete;
|
|
Printer& operator =( const Printer& rPrinter ) = delete;
|
|
|
|
public:
|
|
VCL_DLLPRIVATE void ImplStartPage();
|
|
VCL_DLLPRIVATE void ImplEndPage();
|
|
|
|
protected:
|
|
virtual bool AcquireGraphics() const override;
|
|
virtual void ReleaseGraphics( bool bRelease = true ) override;
|
|
void ImplReleaseGraphics(bool bRelease = true);
|
|
virtual void ImplReleaseFonts() override;
|
|
|
|
virtual tools::Long GetGradientStepCount( tools::Long nMinRect ) override;
|
|
virtual bool UsePolyPolygonForComplexGradient() override;
|
|
virtual void ClipAndDrawGradientMetafile ( const Gradient &rGradient,
|
|
const tools::PolyPolygon &rPolyPoly ) override;
|
|
|
|
bool CanSubsampleBitmap() const override { return false; }
|
|
vcl::Region ClipToDeviceBounds(vcl::Region aRegion) const override;
|
|
|
|
public:
|
|
void SetSystemTextColor(SystemTextColorFlags, bool) override;
|
|
void DrawGradientEx( OutputDevice* pOut, const tools::Rectangle& rRect,
|
|
const Gradient& rGradient );
|
|
virtual Bitmap GetBitmap( const Point& rSrcPt, const Size& rSize ) const override;
|
|
virtual Size GetButtonBorderSize() override;
|
|
virtual Color GetMonochromeButtonColor() override { return COL_LIGHTGRAY; }
|
|
|
|
bool IsScreenComp() const override { return false; }
|
|
|
|
void DrawBorder(tools::Rectangle aBorderRect) override
|
|
{
|
|
SetLineColor(COL_BLACK);
|
|
DrawRect(aBorderRect);
|
|
}
|
|
|
|
css::awt::DeviceInfo GetDeviceInfo() 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, double fAlpha = 1.0) override;
|
|
|
|
bool TransformAndReduceBitmapExToTargetRange( const basegfx::B2DHomMatrix& aFullTransform,
|
|
basegfx::B2DRange &aVisibleRange, double &fMaximumArea) override;
|
|
|
|
void DrawDeviceBitmapEx( 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 SetFontOrientation( LogicalFontInstance* const pFontInstance ) const override;
|
|
|
|
bool shouldDrawWavePixelAsRect(tools::Long) const override { return true; }
|
|
void SetWaveLineColors(Color const& rColor, tools::Long) override;
|
|
Size GetWaveLineSize(tools::Long nLineWidth) const override;
|
|
|
|
public:
|
|
Printer();
|
|
Printer( const JobSetup& rJobSetup );
|
|
Printer( const QueueInfo& rQueueInfo );
|
|
Printer( const OUString& rPrinterName );
|
|
virtual ~Printer() override;
|
|
virtual void dispose() override;
|
|
|
|
virtual void SetMetafileMapMode(const MapMode& rNewMapMode, bool) override { SetMapMode(rNewMapMode); }
|
|
|
|
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(weld::Window* pWindow,
|
|
PrinterSetupMode eMode = PrinterSetupMode::DocumentGlobal);
|
|
bool SetPrinterProps( const Printer* pPrinter );
|
|
|
|
Color GetBackgroundColor() const override { return COL_WHITE; }
|
|
Color GetReadableFontColor(const Color&, const Color&) const override { return COL_BLACK; }
|
|
|
|
/** 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
|
|
*/
|
|
VCL_DLLPRIVATE void SetPrinterOptions( const vcl::printer::Options& rOptions );
|
|
const vcl::printer::Options& GetPrinterOptions() const { return( *mpPrinterOptions ); }
|
|
|
|
bool SetOrientation( Orientation eOrient );
|
|
Orientation GetOrientation() const;
|
|
void SetDuplexMode( DuplexMode );
|
|
DuplexMode GetDuplexMode() const;
|
|
|
|
bool SetPaperBin( sal_uInt16 nPaperBin );
|
|
sal_uInt16 GetPaperBin() const;
|
|
void SetPaper( Paper ePaper );
|
|
bool SetPaperSizeUser( const Size& rSize );
|
|
/** @return The paper format of the printer's current "jobsetup". Note that if PAPER_USER the actual size can be anything. */
|
|
Paper GetPaper() const;
|
|
/** @return Size of the paper of the printer's current "jobsetup". */
|
|
Size GetSizeOfPaper() const;
|
|
static OUString GetPaperName( Paper ePaper );
|
|
|
|
/** @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;
|
|
|
|
bool GetPrinterSettingsPreferred() const;
|
|
void SetPrinterSettingsPreferred( bool bPaperSizeFromSetup );
|
|
|
|
const Size& GetPaperSizePixel() const { return maPaperSize; }
|
|
Size GetPaperSize() const { return PixelToLogic( maPaperSize ); }
|
|
Size GetPaperSize( int nPaper ) const;
|
|
const Point& GetPageOffsetPixel() const { return maPageOffset; }
|
|
Point GetPageOffset() const { return PixelToLogic( maPageOffset ); }
|
|
|
|
void SetCopyCount( sal_uInt16 nCopy, bool bCollate );
|
|
sal_uInt16 GetCopyCount() const { return mnCopyCount; }
|
|
bool IsCollateCopy() const { return mbCollateCopy; }
|
|
void SetSinglePrintJobs(bool bSinglePrintJobs) { mbSinglePrintJobs = bSinglePrintJobs; }
|
|
bool IsSinglePrintJobs() const { return mbSinglePrintJobs; }
|
|
|
|
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;
|
|
|
|
virtual tools::Rectangle GetBackgroundComponentBounds() const 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(const 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 VCL_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>&, weld::Window* pDialogParent);
|
|
public:
|
|
struct MultiPageSetup
|
|
{
|
|
// all metrics in 100th mm
|
|
int nRows;
|
|
int nColumns;
|
|
Size aPaperSize;
|
|
tools::Long nLeftMargin;
|
|
tools::Long nTopMargin;
|
|
tools::Long nRightMargin;
|
|
tools::Long nBottomMargin;
|
|
tools::Long nHorizontalSpacing;
|
|
tools::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;
|
|
weld::Window* getWindow() 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;
|
|
|
|
/** 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;
|
|
|
|
void dialogsParentClosing();
|
|
|
|
// 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
|
|
int getFilteredPageCount() const;
|
|
VCL_DLLPRIVATE PageSize getPageFile( int i_inUnfilteredPage, GDIMetaFile& rMtf,
|
|
bool i_bMayUseCache = false );
|
|
PageSize getFilteredPageFile( int i_nFilteredPage, GDIMetaFile& o_rMtf,
|
|
bool i_bMayUseCache = false );
|
|
void printFilteredPage( int i_nPage );
|
|
VCL_DLLPRIVATE void setPrinter( const VclPtr<Printer>& );
|
|
void createProgressDialog();
|
|
bool isProgressCanceled() const;
|
|
VCL_DLLPRIVATE void setMultipage( const MultiPageSetup& );
|
|
VCL_DLLPRIVATE const MultiPageSetup&
|
|
getMultipage() const;
|
|
void setLastPage( bool i_bLastPage );
|
|
VCL_DLLPRIVATE void setReversePrint( bool i_bReverse );
|
|
VCL_DLLPRIVATE void setPapersizeFromSetup( bool i_bPapersizeFromSetup );
|
|
VCL_DLLPRIVATE bool getPapersizeFromSetup() const;
|
|
VCL_DLLPRIVATE void setPaperSizeFromUser( Size i_aUserSize );
|
|
VCL_DLLPRIVATE void setOrientationFromUser( Orientation eOrientation, bool set );
|
|
void setPrinterModified( bool i_bPapersizeFromSetup );
|
|
bool getPrinterModified() const;
|
|
VCL_DLLPRIVATE void pushPropertiesToPrinter();
|
|
VCL_DLLPRIVATE void resetPaperToLastConfigured();
|
|
void setJobState( css::view::PrintableState );
|
|
VCL_DLLPRIVATE void setupPrinter( weld::Window* i_pDlgParent );
|
|
|
|
VCL_DLLPRIVATE int getPageCountProtected() const;
|
|
VCL_DLLPRIVATE css::uno::Sequence< css::beans::PropertyValue >
|
|
getPageParametersProtected( int i_nPage ) const;
|
|
|
|
VCL_DLLPRIVATE DrawModeFlags removeTransparencies( GDIMetaFile const & i_rIn, GDIMetaFile& o_rOut );
|
|
VCL_DLLPRIVATE void resetPrinterOptions( bool i_bFileOutput );
|
|
};
|
|
|
|
class VCL_DLLPUBLIC PrinterOptionsHelper
|
|
{
|
|
protected:
|
|
std::unordered_map< OUString, css::uno::Any >
|
|
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;
|
|
OUString maGroupHint;
|
|
std::vector< css::beans::PropertyValue >
|
|
maAddProps;
|
|
sal_Int32 mnDependsOnEntry;
|
|
bool mbAttachToDependency;
|
|
bool mbInternalOnly;
|
|
bool mbEnabled;
|
|
|
|
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: */
|