Logs the python editor and gui screenshots. More...

#include <special_log_content_manager.h>

Inheritance diagram for hal::SpecialLogContentManager:

Collaboration diagram for hal::SpecialLogContentManager:

Public Member Functions
	SpecialLogContentManager (QObject parent=nullptr, PythonEditor python_editor=nullptr)

	~SpecialLogContentManager ()

void	safeScreenshot ()

void	safePythonEditor ()

void	startLogging (int msec)

Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const

	QObject (QObject *parent)

virtual	~QObject ()

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const const

void	setObjectName (const QString &name)

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

bool	blockSignals (bool block)

QThread *	thread () const const

void	moveToThread (QThread *targetThread)

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

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

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (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

const QObjectList &	children () const const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectTree ()

void	dumpObjectInfo ()

void	dumpObjectTree () const const

void	dumpObjectInfo () const const

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

QVariant	property (const char *name) const const

QList< QByteArray >	dynamicPropertyNames () const const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

bool	inherits (const char *className) const const

void	deleteLater ()

	Q_DISABLE_COPY (Class)

	Q_DISABLE_MOVE (Class)

	Q_DISABLE_COPY_MOVE (Class)

T	qobject_cast (QObject *object)

T	qobject_cast (const QObject *object)

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

	Q_CLASSINFO (Name, Value)

	Q_INTERFACES (...)

	Q_PROPERTY (...)

	Q_ENUMS (...)

	Q_FLAGS (...)

	Q_ENUM (...)

	Q_FLAG (...)

	Q_ENUM_NS (...)

	Q_FLAG_NS (...)

	Q_OBJECT Q_OBJECT

	Q_GADGET Q_GADGET

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_SIGNALS Q_SIGNALS

	Q_SIGNAL Q_SIGNAL

	Q_SLOTS Q_SLOTS

	Q_SLOT Q_SLOT

	Q_EMIT Q_EMIT

	Q_INVOKABLE Q_INVOKABLE

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

Additional Inherited Members
Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

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 receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

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 QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
QObject *	sender () const const

int	senderSignalIndex () const const

int	receivers (const char *signal) const const

bool	isSignalConnected (const QMetaMethod &signal) const const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Properties inherited from QObject
	objectName

Detailed Description

Logs the python editor and gui screenshots.

The SpecialLogContentManager class creates special log content that is used for meta analysis. It takes screenshots of the MainWindow (and all detached widgets) as well as dumps every python editor tabs in a certain interval. The logged content is saved in a directory that is located next to the opened file.

Definition at line 48 of file special_log_content_manager.h.

Constructor & Destructor Documentation

◆ SpecialLogContentManager()

hal::SpecialLogContentManager::SpecialLogContentManager	(	QObject *	parent = `nullptr`,
		PythonEditor *	python_editor = `nullptr`
	)

The constructor.

Parameters

parent	- The manager's parent.
python_editor	- The editor which tabs are to be logged (dumped).

Definition at line 22 of file special_log_content_manager.cpp.

References QObject::connect(), safePythonEditor(), safeScreenshot(), and QTimer::timeout().

◆ ~SpecialLogContentManager()

hal::SpecialLogContentManager::~SpecialLogContentManager ( )

The default destructor.

Definition at line 32 of file special_log_content_manager.cpp.

Member Function Documentation

◆ safePythonEditor()

void hal::SpecialLogContentManager::safePythonEditor ( )

Creates (if it does not exist already) a directory named after the currently opened file. It takes the content of every python editor tab, combines them into a single file and saves it to the created directory in an interval that is specified when calling startLogging(int msec).

Definition at line 90 of file special_log_content_manager.cpp.

References QFileInfo::absoluteDir(), QFileInfo::baseName(), QTabWidget::count, QDateTime::currentDateTime(), QDir::exists(), file, hal::FileManager::fileName(), hal::FileManager::get_instance(), hal::PythonEditor::getTabWidget(), QString::isEmpty(), QDir::mkpath(), QString::number(), QDir::path(), QTabWidget::tabText(), QIODevice::Text, QPlainTextEdit::toPlainText(), QTabWidget::widget(), and QIODevice::WriteOnly.

Referenced by SpecialLogContentManager().

◆ safeScreenshot()

void hal::SpecialLogContentManager::safeScreenshot ( )

Creates (if it does not exist already) a directory named after the currently opened file. It takes a screenshot consisting of every top-level-widget of hal and saves it to the created directory in an interval that is specified when calling startLogging(int msec).

Definition at line 37 of file special_log_content_manager.cpp.

References QFileInfo::absoluteDir(), QList::append(), QList::at(), QFileInfo::baseName(), QDateTime::currentDateTime(), QPainter::drawPixmap(), QDir::exists(), hal::FileManager::fileName(), QPainter::fillRect(), QWidget::find(), QImage::Format_RGB32, hal::FileManager::get_instance(), QPixmap::height(), QString::isEmpty(), QDir::mkpath(), QString::number(), QDir::path(), QWidget::render(), QImage::save(), QList::size(), QWidget::size, Qt::white, and QPixmap::width().

Referenced by SpecialLogContentManager().

◆ startLogging()

void hal::SpecialLogContentManager::startLogging ( int msec )

Starts the logging process of the manager by specifying an interval in which to log the content.

Parameters

msec	- The interval in milliseconds.

Definition at line 140 of file special_log_content_manager.cpp.

References QTimer::start().

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

/home/runner/work/hal/hal/plugins/gui/include/gui/gui_utils/special_log_content_manager.h
/home/runner/work/hal/hal/plugins/gui/src/gui_utils/special_log_content_manager.cpp

Public Member Functions

Additional Inherited Members