/usr/include/plasma/weather/ion.h is in kde-workspace-dev 4:4.8.5-0ubuntu0.4.
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 | /*****************************************************************************
* Copyright (C) 2007-2009 by Shawn Starr <shawn.starr@rogers.com> *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public License *
* along with this library; see the file COPYING.LIB. If not, write to *
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, *
* Boston, MA 02110-1301, USA. *
*****************************************************************************/
#ifndef ION_H
#define ION_H
#include <QtCore/QObject>
#include <Plasma/DataEngine>
#include "ion_export.h"
/**
* @author Shawn Starr
* This is the base class to be used to implement new ions for the WeatherEngine.
* The idea is that you can have multiple ions which provide weather information from different services to the engine from which an applet will request the data from.
*
* Basically an ion is a Plasma::DataEngine, which is queried by the WeatherEngine instead of some applet.
*/
class ION_EXPORT IonInterface : public Plasma::DataEngine
{
Q_OBJECT
public:
enum ConditionIcons { ClearDay = 1, FewCloudsDay, PartlyCloudyDay, Overcast,
Rain, LightRain, Showers, ChanceShowersDay, Thunderstorm, Hail,
Snow, LightSnow, Flurries, FewCloudsNight, ChanceShowersNight,
PartlyCloudyNight, ClearNight, Mist, Haze, FreezingRain,
RainSnow, FreezingDrizzle, ChanceThunderstormDay, ChanceThunderstormNight,
ChanceSnowDay, ChanceSnowNight, NotAvailable
};
enum WindDirections { N, NNE, NE, ENE, E, SSE, SE, ESE, S, NNW, NW, WNW, W, SSW, SW, WSW, VR };
/**
* Constructor for the ion
* @param parent The parent object.
* @Param args The argument list.
*/
explicit IonInterface(QObject *parent = 0, const QVariantList &args = QVariantList());
/**
* Destructor for the ion
*/
virtual ~IonInterface();
/**
* Returns weather icon filename to display in applet.
* @param condition the current condition being reported.
* @return icon name
*/
QString getWeatherIcon(ConditionIcons condition) const;
/**
* Returns weather icon filename to display in applet.
* @param conditionList a QList map pair of icons mapped to a enumeration of conditions.
* @param condition the current condition being reported.
* @return icon name
*/
QString getWeatherIcon(const QMap<QString, ConditionIcons> &conditionList, const QString& condition) const;
/**
* Returns wind icon element to display in applet.
* @param windDirList a QList map pair of wind directions mapped to a enumeration of directions.
* @param windDirection the current wind direction.
* @return svg element for wind direction
*/
QString getWindDirectionIcon(const QMap<QString, WindDirections> &windDirList, const QString& windDirection) const;
public Q_SLOTS:
/**
* Reimplemented from Plasma::DataEngine
* @param source the name of the datasource to be updated
*/
bool updateSourceEvent(const QString& source);
/**
* Reimplement for ion to reload data if network status comes back up
*/
virtual void reset() = 0;
Q_SIGNALS:
void forceUpdate(IonInterface *ion, const QString &source);
protected:
/**
* Call this method to flush waiting source requests that may be pending
* initialization
*
* @arg initialized whether or not the ion is currently ready to fetch data
*/
void setInitialized(bool initialized);
/**
* Reimplemented from Plasma::DataEngine
* @param source The datasource being requested
*/
bool sourceRequestEvent(const QString &source);
/**
* Reimplement to fetch the data from the ion.
* @arg source the name of the datasource.
* @return true if update was successful, false if failed
*/
virtual bool updateIonSource(const QString &source) = 0;
friend class WeatherEngine;
private:
class Private;
Private* const d;
};
#endif
|