BPS C++ API  2.24.4
BpsPrinterSettings Class Reference

The BpsPrinterSettings class allows to save and restore printer settings. More...

#include <bpsprintersettings.h>

+ Inheritance diagram for BpsPrinterSettings:

Public Member Functions

 BpsPrinterSettings (QPrinter *aPrinter, BpsSettings *aSettings=nullptr, QObject *aParent=nullptr)
 
QMap< QString, QStringconfig () const
 
bool restore ()
 Restore the settings from human readable keys/values. More...
 
void save ()
 Save the settings as human readable keys/values.
 
bool setConfig (const QMap< QString, QString > &aConfig)
 Load the settings from a config map instead from the settings. More...
 
- Public Member Functions inherited from QObject
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
 QObject (QObject *parent)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static QMap< QPrinter::ColorMode, QStringcolorModes ()
 
static QMap< QPrinter::Orientation, QStringorientations ()
 
static QMap< QPrinter::PaperSize, QStringpaperNames ()
 A map with the paper names. More...
 
static QMap< QPrinter::PaperSize, QSizeFpaperSizes ()
 A map with paper size informations. More...
 
static QMap< QPrinter::PaperSource, QStringpaperSources ()
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

The BpsPrinterSettings class allows to save and restore printer settings.

This is useful when you do not want to show a print dialog every time, but reuse the last setting. The status can be saved and restored in 2 different ways: Either binary where all settings are encoded into one single value, or human readable where every setting is in a distinct value.

QPrinter p;
s.open("Settings/Printers/MyPrinter");
BpsPrinterSettings ps(&p, &s);
bool ok = ps.load();
if (!ok) {
// no settings yet saved, show dialog as fallback
ok = QPrintDialog(&p, this).exec() == QDialog::Accepted;
// save the new settings
if (ok) ps.save();
} // if
if (ok) {
// do the printing
....
} // if
The BpsPrinterSettings class allows to save and restore printer settings.
Definition: bpsprintersettings.h:42
Query and edit settings.
Definition: bpssettings.h:17
void open(const QString &aPath)
Open a new path.

Constructor & Destructor Documentation

◆ BpsPrinterSettings()

BpsPrinterSettings::BpsPrinterSettings ( QPrinter *  aPrinter,
BpsSettings aSettings = nullptr,
QObject aParent = nullptr 
)
Parameters
aPrinterThe printer object to save/load settings for.
aSettingsThe settings object, opened to the desire path. If aSettings is = 0, the save and restore methods will do nothing.
aParentThe parent object.

Member Function Documentation

◆ colorModes()

static QMap<QPrinter::ColorMode, QString> BpsPrinterSettings::colorModes ( )
static
Returns
A map of all Qt printer color modes to strings.

◆ config()

QMap<QString,QString> BpsPrinterSettings::config ( ) const
Returns
The config map of the current settings.

◆ orientations()

static QMap<QPrinter::Orientation, QString> BpsPrinterSettings::orientations ( )
static
Returns
A map of all Qt printer orientations to strings.

◆ paperNames()

static QMap<QPrinter::PaperSize, QString> BpsPrinterSettings::paperNames ( )
static

A map with the paper names.

Returns
A map of all Qt printer paper names.

◆ paperSizes()

static QMap<QPrinter::PaperSize, QSizeF> BpsPrinterSettings::paperSizes ( )
static

A map with paper size informations.

The paper size in in millimeters, and for portrait orientation. Swap width and height for landscape orientation.

Returns
A map of all Qt printer paper sizes.

◆ paperSources()

static QMap<QPrinter::PaperSource, QString> BpsPrinterSettings::paperSources ( )
static
Returns
A map of all Qt printer paper sources to strings.

◆ restore()

bool BpsPrinterSettings::restore ( )

Restore the settings from human readable keys/values.

Returns
True is settings are valid for a local printer and got loaded. Otherwise aPrinter settings are unchanged.

◆ setConfig()

bool BpsPrinterSettings::setConfig ( const QMap< QString, QString > &  aConfig)

Load the settings from a config map instead from the settings.

Parameters
aConfigThe config map to use.
Returns
True is settings are valid for a local printer and got loaded. Otherwise aPrinter settings are unchanged.

The documentation for this class was generated from the following file: