okular/interfaces/printinterface.h
Pino Toscano 91b7675c14 configurationWidget() is too generic -> rename to printConfigurationWidget()
svn path=/trunk/playground/graphics/okular/; revision=622782
2007-01-12 23:48:29 +00:00

58 lines
1.7 KiB
C++

/***************************************************************************
* Copyright (C) 2007 by Pino Toscano <pino@kde.org> *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
***************************************************************************/
#ifndef _OKULAR_PRINTINTERFACE_H_
#define _OKULAR_PRINTINTERFACE_H_
#include <okular/core/okular_export.h>
class KPrintDialogPage;
namespace Okular {
/**
* @short Abstract interface for advanced printing control
*
* This interface defines an advanced way of interfacing with the print
* process.
*
* How to use it in a custom Generator:
* @code
class MyGenerator : public Okular::Generator, public Okular::PrintInterface
{
Q_OBJECT
Q_INTERFACES( Okular::PrintInterface )
...
};
* @endcode
* and - of course - implementing its methods.
*/
class OKULAR_EXPORT PrintInterface
{
public:
/**
* Destroys the printer interface.
*/
virtual ~PrintInterface() {}
/**
* Builds and returns a new printing configuration widget.
*
* @note don't keep a pointer to the new constructed widget, as it
* will be handled elsewhere (in the Okular KPart)
*/
virtual KPrintDialogPage* printConfigurationWidget() const = 0;
};
}
Q_DECLARE_INTERFACE( Okular::PrintInterface, "org.kde.okular.PrintInterface/0.1" )
#endif