office-gobmx/vcl/inc/salprn.hxx
Caolán McNamara 054568fea7 this casting of a void* is a disaster waiting to happen
only ever used for a string, to set it to a string type
2011-11-21 12:51:36 +00:00

141 lines
5.8 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _SV_SALPRN_HXX
#define _SV_SALPRN_HXX
#include <rtl/ustring.hxx>
#include <vcl/sv.h>
#include <vcl/dllapi.h>
#include <vcl/prntypes.hxx>
#include <vector>
class SalGraphics;
class SalFrame;
struct ImplJobSetup;
namespace vcl { class PrinterController; }
// -----------------------
// - SalPrinterQueueInfo -
// -----------------------
struct VCL_PLUGIN_PUBLIC SalPrinterQueueInfo
{
rtl::OUString maPrinterName;
rtl::OUString maDriver;
rtl::OUString maLocation;
rtl::OUString maComment;
sal_uLong mnStatus;
sal_uLong mnJobs;
rtl::OUString* mpSysData;
SalPrinterQueueInfo();
~SalPrinterQueueInfo();
};
// ------------------
// - SalInfoPrinter -
// ------------------
class VCL_PLUGIN_PUBLIC SalInfoPrinter
{
public:
std::vector< PaperInfo > m_aPaperFormats; // all printer supported formats
bool m_bPapersInit; // set to true after InitPaperFormats
bool m_bCompatMetrics;
SalInfoPrinter() : m_bPapersInit( false ), m_bCompatMetrics( false ) {}
virtual ~SalInfoPrinter();
// SalGraphics or NULL, but two Graphics for all SalFrames
// must be returned
virtual SalGraphics* GetGraphics() = 0;
virtual void ReleaseGraphics( SalGraphics* pGraphics ) = 0;
virtual sal_Bool Setup( SalFrame* pFrame, ImplJobSetup* pSetupData ) = 0;
// This function set the driver data and
// set the new indepen data in pSetupData
virtual sal_Bool SetPrinterData( ImplJobSetup* pSetupData ) = 0;
// This function merged the indepen driver data
// and set the new indepen data in pSetupData
// Only the data must changed, where the bit
// in nFlags is set
virtual sal_Bool SetData( sal_uLong nFlags, ImplJobSetup* pSetupData ) = 0;
virtual void GetPageInfo( const ImplJobSetup* pSetupData,
long& rOutWidth, long& rOutHeight,
long& rPageOffX, long& rPageOffY,
long& rPageWidth, long& rPageHeight ) = 0;
virtual sal_uLong GetCapabilities( const ImplJobSetup* pSetupData, sal_uInt16 nType ) = 0;
virtual sal_uLong GetPaperBinCount( const ImplJobSetup* pSetupData ) = 0;
virtual rtl::OUString GetPaperBinName( const ImplJobSetup* pSetupData, sal_uLong nPaperBin ) = 0;
// fills m_aPaperFormats and sets m_bPapersInit to true
virtual void InitPaperFormats( const ImplJobSetup* pSetupData ) = 0;
// returns angle that a landscape page will be turned counterclockwise wrt to portrait
virtual int GetLandscapeAngle( const ImplJobSetup* pSetupData ) = 0;
};
// --------------
// - SalPrinter -
// --------------
class VCL_PLUGIN_PUBLIC SalPrinter
{
public: // public for Sal Implementation
SalPrinter() {}
virtual ~SalPrinter();
virtual sal_Bool StartJob( const rtl::OUString* pFileName,
const rtl::OUString& rJobName,
const rtl::OUString& rAppName,
sal_uLong nCopies,
bool bCollate,
bool bDirect,
ImplJobSetup* pSetupData ) = 0;
// implement for pull model print systems only,
// default implementations (see salvtables.cxx) just returns sal_False
virtual sal_Bool StartJob( const rtl::OUString* pFileName,
const rtl::OUString& rJobName,
const rtl::OUString& rAppName,
ImplJobSetup* pSetupData,
vcl::PrinterController& rController );
virtual sal_Bool EndJob() = 0;
virtual sal_Bool AbortJob() = 0;
virtual SalGraphics* StartPage( ImplJobSetup* pSetupData, sal_Bool bNewJobData ) = 0;
virtual sal_Bool EndPage() = 0;
virtual sal_uLong GetErrorCode() = 0;
};
#endif // _SV_SALPRN_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */