/usr/include/marble/AbstractDataPlugin.h is in libmarble-dev 4:4.8.2-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 | //
// This file is part of the Marble Virtual Globe.
//
// This program is free software licensed under the GNU LGPL. You can
// find a copy of this license in LICENSE.txt in the top directory of
// the source code.
//
// Copyright 2009 Bastian Holst <bastianholst@gmx.de>
//
#ifndef MARBLE_ABSTRACTDATAPLUGIN_H
#define MARBLE_ABSTRACTDATAPLUGIN_H
// Marble
#include "marble_export.h"
#include "RenderPlugin.h"
namespace Marble
{
class ViewportParams;
class GeoSceneLayer;
class AbstractDataPluginItem;
class AbstractDataPluginModel;
class AbstractDataPluginPrivate;
class PluginManager;
/**
* @short: An abstract class for plugins that show data that has a geo coordinate
*
* This is the abstract class for plugins that show data on Marble map.
* It takes care of painting all items it gets from the corresponding AbstractDataPluginModel
* that has to be set on initialisation.
*
* The user has to set the nameId as well as the number of items to fetch.
* Additionally it should be useful to set standard values via setEnabled (often true)
* and setVisible (often false) in the constructor of a subclass.
**/
class MARBLE_EXPORT AbstractDataPlugin : public RenderPlugin
{
Q_OBJECT
public:
AbstractDataPlugin();
virtual ~AbstractDataPlugin();
/**
* @brief Returns the name(s) of the backend that the plugin can render
*/
QStringList backendTypes() const;
/**
* @brief Return how the plugin settings should be used.
*/
QString renderPolicy() const;
/**
* @brief Preferred level in the layer stack for the rendering
*/
QStringList renderPosition() const;
/**
* @brief Renders the content provided by the plugin on the viewport.
* @return @c true Returns whether the rendering has been successful
*/
bool render( GeoPainter *painter, ViewportParams *viewport,
const QString& renderPos = "NONE", GeoSceneLayer * layer = 0 );
/**
* @brief Initialized the plugin and make it ready to be painted.
*/
virtual void initialize() = 0;
virtual bool isInitialized() const;
/**
* @return The model associated with the plugin.
*/
AbstractDataPluginModel *model() const;
/**
* Set the model of the plugin.
*/
void setModel( AbstractDataPluginModel* model );
const PluginManager *pluginManager() const;
/**
* Set the name id of the plugin
*/
void setNameId( const QString& name );
/**
* @return Returns the nameId of the item
*/
QString nameId() const;
/**
* Set the number of items to be shown at the same time.
*/
void setNumberOfItems( quint32 number );
/**
* @return The number of items to be shown at the same time.
*/
quint32 numberOfItems() const;
/**
* This function returns all items at the position @p curpos. Depending on where they have
* been painted the last time.
*
* @return The items at the given position.
*/
QList<AbstractDataPluginItem *> whichItemAt( const QPoint& curpos );
/**
* Function for returning the type of plugin this is for.
* This affects where in the menu tree the action() is placed.
*
* @return: The type of render plugin this is.
*/
virtual RenderType renderType() const;
private Q_SLOTS:
void requestRepaint();
Q_SIGNALS:
void changedNumberOfItems( quint32 number );
private:
AbstractDataPluginPrivate * const d;
};
}
#endif
|