Marble

DialogConfigurationInterface.h
1// SPDX-License-Identifier: LGPL-2.1-or-later
2//
3// SPDX-FileCopyrightText: 2012 Bernhard Beschow <bbeschow@cs.tu-berlin.de>
4//
5#ifndef MARBLE_DIALOGCONFIGURATIONINTERFACE_H
6#define MARBLE_DIALOGCONFIGURATIONINTERFACE_H
7
8#include <QObject> // for Q_DECLARE_INTERFACE macro
9#include "marble_export.h"
10
11class QDialog;
12
13namespace Marble
14{
15
16/**
17 * @brief This interface allows a plugin to provide a QWidget-based configuration
18 * dialog which is accessible within Marble's own configuration dialog.
19 *
20 * @note In order for your plugin to provide a configuration dialog, derive your
21 * plugin from this interface in addition to any other interfaces and classes.
22 *
23 * @note Make sure to deploy the @code Q_INTERFACES @endcode macro, which tells
24 * Marble that you actually implemented the interface.
25 */
27{
28 public:
30
31 /**
32 * @brief Returns a pointer to the configuration dialog of the plugin.
33 *
34 * @return: Pointer to the configuration dialog, which must be non-zero.
35 */
36 virtual QDialog *configDialog() = 0;
37};
38
39}
40
41Q_DECLARE_INTERFACE( Marble::DialogConfigurationInterface, "org.kde.Marble.DialogConfigurationInterface/1.0" )
42
43#endif
This interface allows a plugin to provide a QWidget-based configuration dialog which is accessible wi...
virtual QDialog * configDialog()=0
Returns a pointer to the configuration dialog of the plugin.
Binds a QML item to a specific geodetic location in screen coordinates.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 14 2024 11:54:16 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.