The controller of the OpenOrienteering Mapper home screen. More...

#include <home_screen_controller.h>

Inheritance diagram for OpenOrienteering::HomeScreenController:

Collaboration diagram for OpenOrienteering::HomeScreenController:

[legend]

Public Slots
void	readSettings ()
	(Re-)reads the settings. More...

void	clearRecentFiles ()
	Clears the application's list of recently opened files. More...

void	setOpenMRUFile (bool state)
	Sets whether to open the most recently used file on startup. More...

void	setTipsVisible (bool state)
	Sets the visibility of the tip-of-the-day to state. More...

void	goToPreviousTip ()
	Moves to the tip following the current tip-of-the-day. More...

void	goToNextTip ()
	Moves to the tip preceding the current tip-of-the-day. More...

void	goToTip (int index)
	Moves to the tip-of-the-day given by index. More...

Public Member Functions
	HomeScreenController ()
	Creates a new HomeScreenController. More...

	~HomeScreenController () override
	Destroys the HomeScreenController and its children. More...

bool	statusBarVisible () override
	The home screen widgets do not use a status bar. More...

void	attach (MainWindow *window) override
	Activates the HomeScreenController for the given main window. More...

void	detach () override
	Detaches the HomeScreenController from its main window. More...

Public Member Functions inherited from OpenOrienteering::MainWindowController
	~MainWindowController () override

virtual bool	menuBarVisible ()
	Returns true when the controller wants a menu bar to be shown. More...

virtual bool	saveTo (const QString &path, const FileFormat &format)
	Save to a file. More...

bool	exportTo (const QString &path)
	Export to a file, but don't change modified state with regard to the original file. More...

virtual bool	exportTo (const QString &path, const FileFormat &format)
	Export to a file, but don't change modified state with regard to the original file. More...

virtual bool	loadFrom (const QString &path, const FileFormat &format, QWidget *dialog_parent=nullptr)
	Load from a file. More...

virtual bool	isEditingInProgress () const
	Returns true when editing is in progress. More...

virtual bool	keyPressEventFilter (QKeyEvent *event)
	Receives key press events from the main window. More...

virtual bool	keyReleaseEventFilter (QKeyEvent *event)
	Receives key release events from the main window. More...

MainWindow *	getWindow () const
	Get the main window this controller is attached to. More...

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_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

Protected Attributes
AbstractHomeScreenWidget *	widget
	The widget owned and controlled by this HomeScreenController. More...

int	current_tip
	The index of the tip-of-the-day currently displayed. More...

Protected Attributes inherited from OpenOrienteering::MainWindowController
MainWindow *	window

Additional Inherited Members
Static Public Member Functions inherited from OpenOrienteering::MainWindowController
static MainWindowController *	controllerForFile (const QString &filename)
	Get a controller suitable for a particular file. More...

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

The controller of the OpenOrienteering Mapper home screen.

The OpenOrienteering Mapper home screen is shown when no document is open, for example after the program is started for the first time.

Constructor & Destructor Documentation

◆ HomeScreenController()

OpenOrienteering::HomeScreenController::HomeScreenController ( )

Creates a new HomeScreenController.

◆ ~HomeScreenController()

OpenOrienteering::HomeScreenController::~HomeScreenController ( )

overridedefault

Destroys the HomeScreenController and its children.

Member Function Documentation

◆ attach()

void OpenOrienteering::HomeScreenController::attach ( MainWindow * window )

overridevirtual

Activates the HomeScreenController for the given main window.

Implements OpenOrienteering::MainWindowController.

◆ clearRecentFiles

void OpenOrienteering::HomeScreenController::clearRecentFiles ( )

slot

Clears the application's list of recently opened files.

◆ detach()

void OpenOrienteering::HomeScreenController::detach ( )

overridevirtual

Detaches the HomeScreenController from its main window.

Reimplemented from OpenOrienteering::MainWindowController.

◆ goToNextTip

void OpenOrienteering::HomeScreenController::goToNextTip ( )

slot

Moves to the tip preceding the current tip-of-the-day.

◆ goToPreviousTip

void OpenOrienteering::HomeScreenController::goToPreviousTip ( )

slot

Moves to the tip following the current tip-of-the-day.

◆ goToTip

void OpenOrienteering::HomeScreenController::goToTip ( int index )

slot

Moves to the tip-of-the-day given by index.

◆ readSettings

void OpenOrienteering::HomeScreenController::readSettings ( )

slot

(Re-)reads the settings.

◆ setOpenMRUFile

void OpenOrienteering::HomeScreenController::setOpenMRUFile ( bool state )

slot

Sets whether to open the most recently used file on startup.

◆ setTipsVisible

void OpenOrienteering::HomeScreenController::setTipsVisible ( bool state )

slot

Sets the visibility of the tip-of-the-day to state.

◆ statusBarVisible()

bool OpenOrienteering::HomeScreenController::statusBarVisible ( )

overridevirtual

The home screen widgets do not use a status bar.

Reimplemented from OpenOrienteering::MainWindowController.

Member Data Documentation

◆ current_tip

int OpenOrienteering::HomeScreenController::current_tip

protected

The index of the tip-of-the-day currently displayed.

◆ widget

AbstractHomeScreenWidget* OpenOrienteering::HomeScreenController::widget

protected

The widget owned and controlled by this HomeScreenController.

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

src/gui/home_screen_controller.h (36d2ede on 25 Aug 2019)
src/gui/home_screen_controller.cpp (935d409 on 25 Aug 2019)

Public Slots

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HomeScreenController()

◆ ~HomeScreenController()

Member Function Documentation

◆ attach()

◆ clearRecentFiles

◆ detach()

◆ goToNextTip

◆ goToPreviousTip

◆ goToTip

◆ readSettings

◆ setOpenMRUFile

◆ setTipsVisible

◆ statusBarVisible()

Member Data Documentation

◆ current_tip

◆ widget