ImageExporter

#include <imageexporter.h>

Inheritance diagram for ImageExporter:

Public Slots
bool	exportImage (QString url)

Legend *	getLegend ()

void	includeLegend (bool include)

void	setLegendAlpha (int alpha)

void	setLegendProperties (Legend::LEGEND_TYPE type, Legend::LEGEND_ORIENTATION orientation, Legend::LEGEND_POSITION position, int alpha=160, bool include=true)

void	setRasterOutputSize (const QSize *size)

Public Member Functions
	ImageExporter (QObject *parent=nullptr)

	~ImageExporter () override

QString	getLastErrorMessage () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () 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 () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, 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

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	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

T	qobject_cast (const QObject *object)

T	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	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

Properties inherited from QObject
	objectName

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)

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

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Backends for exporting a sky image, either raster or vector, with a legend.

Author: Rafał Kułaga rl.ku.nosp@m.laga.nosp@m.@gmai.nosp@m.l.co.nosp@m.m; Akarsh Simha akars.nosp@m.h.si.nosp@m.mha@k.nosp@m.dema.nosp@m.il.ne.nosp@m.t

Definition at line 23 of file imageexporter.h.

Constructor & Destructor Documentation

◆ ImageExporter()

ImageExporter::ImageExporter ( QObject * parent = nullptr )

explicit

Constructor.

Definition at line 22 of file imageexporter.cpp.

◆ ~ImageExporter()

ImageExporter::~ImageExporter ( )

override

Destructor.

Definition at line 258 of file imageexporter.cpp.

Member Function Documentation

◆ exportImage

bool ImageExporter::exportImage ( QString url )

slot

Exports an image with the defined settings.

Parameters

url	URL of the exported image

Returns: false if the URL was a network location and uploading to the network location failed

Note: This method calls an SVG backend instead if the file extension is svg. Otherwise, it draws raster.

Definition at line 188 of file imageexporter.cpp.

◆ getLastErrorMessage()

QString ImageExporter::getLastErrorMessage ( ) const

inline

Returns: last error message

Definition at line 41 of file imageexporter.h.

◆ getLegend

Legend * ImageExporter::getLegend ( )

inlineslot

Returns: a pointer to the legend used

Definition at line 85 of file imageexporter.h.

◆ includeLegend

void ImageExporter::includeLegend ( bool include )

inlineslot

Include legend?

Parameters

include The legend will be included if the flag is set to true

Definition at line 67 of file imageexporter.h.

◆ setLegendAlpha

void ImageExporter::setLegendAlpha ( int alpha )

slot

Set legend transparency.

Parameters

alpha Transparency level

Definition at line 271 of file imageexporter.cpp.

◆ setLegendProperties

void ImageExporter::setLegendProperties	(	Legend::LEGEND_TYPE	type,
		Legend::LEGEND_ORIENTATION	orientation,
		Legend::LEGEND_POSITION	position,
		int	alpha = 160,
		bool	include = true )

slot

Set the legend properties.

Parameters

type	Legend type. (See enum LEGEND_TYPE in legend.h)
orientation	Legend orientation. (See LEGEND_ORIENTATION in legend.h)
position	Legend position. (See LEGEND_POSITION in legend.h)
alpha	Legend alpha (transparency). Default value is 160.
include	Include the legend?

Definition at line 241 of file imageexporter.cpp.

◆ setRasterOutputSize

void ImageExporter::setRasterOutputSize ( const QSize * size )

slot

Set the size of output raster images.

Parameters

size	a pointer to a QSize containing the size of images. If a null pointer is supplied, the SkyMap size is used.

Note: If size is larger than the skymap size, then the sky image is padded; if it is smaller, then it is cropped. No rescaling is done.

Definition at line 263 of file imageexporter.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kstars

ImageExporter

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImageExporter()

◆ ~ImageExporter()

Member Function Documentation

◆ exportImage

◆ getLastErrorMessage()

◆ getLegend

◆ includeLegend

◆ setLegendAlpha

◆ setLegendProperties

◆ setRasterOutputSize