• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Plasma

WeatherEngine Class Reference

#include <weatherengine.h>

Inheritance diagram for WeatherEngine:

Inheritance graph
[legend]

List of all members.


Detailed Description

Author:
Shawn Starr This class is DataEngine.

It handles loading, unloading, updating any data the ions wish to send. It is a gateway for datasources (ions) to communicate with the WeatherEngine.

Definition at line 36 of file weatherengine.h.


Public Member Functions

IonInterface * Ion (const QString &name) const
KService::List knownIons ()
IonInterface * loadIon (const QString &pluginName)
void unloadIon (const QString &name)
 WeatherEngine (QObject *parent, const QVariantList &args)
 ~WeatherEngine ()

Protected Slots

void dataUpdated (const QString &source, Plasma::DataEngine::Data data)
void newIonSource (const QString &source)
void removeIonSource (const QString &source)
bool updateSourceEvent (const QString &source)

Protected Member Functions

bool sourceRequestEvent (const QString &source)

Constructor & Destructor Documentation

WeatherEngine::WeatherEngine ( QObject *  parent,
const QVariantList &  args 
)

Constructor.

Parameters:
parent The parent object.
args Argument list, unused.

Definition at line 225 of file weatherengine.cpp.

WeatherEngine::~WeatherEngine (  ) 

Definition at line 241 of file weatherengine.cpp.


Member Function Documentation

void WeatherEngine::dataUpdated ( const QString &  source,
Plasma::DataEngine::Data  data 
) [protected, slot]

Reimplemented from Plasma::DataEngine.

SLOT: Push out new data to applet.

Parameters:
source The datasource to be updated.
data The new data updated.

Definition at line 218 of file weatherengine.cpp.

IonInterface * WeatherEngine::Ion ( const QString &  name  )  const

Get an a IonInterface instance.

Returns an instance of an ion plugin loaded.

  • name ion (plugin) name.
    Returns:
    IonInterface an instance of a loaded plugin.

Definition at line 76 of file weatherengine.cpp.

KService::List WeatherEngine::knownIons (  ) 

Get a list of known plugins found.

Return a list of Ion plugins found.

Returns:
a list of plugin offers found.

Definition at line 168 of file weatherengine.cpp.

IonInterface * WeatherEngine::loadIon ( const QString &  pluginName  ) 

Load a plugin.

Loads an ion plugin given a plugin name found via KService.

  • pluginName Name of the plugin
    Returns:
    IonInterface returns an instance of the loaded plugin

Definition at line 89 of file weatherengine.cpp.

void WeatherEngine::newIonSource ( const QString &  source  )  [protected, slot]

Notify WeatherEngine a new ion has data sources.

SLOT: Get data from a new source.

  • source datasource name.

Definition at line 187 of file weatherengine.cpp.

void WeatherEngine::removeIonSource ( const QString &  source  )  [protected, slot]

Notify WeatherEngine a datasource is being removed.

SLOT: Remove the datasource from the ion and unload plugin if needed.

  • source datasource name.

Definition at line 202 of file weatherengine.cpp.

bool WeatherEngine::sourceRequestEvent ( const QString &  source  )  [protected]

Reimplemented from Plasma::DataEngine.

SLOT: Set up each Ion for the first time and get any data.

We use it to communicate to the Ion plugins to set the data sources.

Parameters:
source The datasource name.

Definition at line 250 of file weatherengine.cpp.

void WeatherEngine::unloadIon ( const QString &  name  ) 

Unload a plugin.

Unload an Ion plugin given a Ion plugin name.

  • name Name of the plugin.

Definition at line 150 of file weatherengine.cpp.

bool WeatherEngine::updateSourceEvent ( const QString &  source  )  [protected, slot]

Reimplemented from Plasma::DataEngine.

SLOT: update the Applet with new data from all ions loaded.

Parameters:
source The datasource to update.

Definition at line 277 of file weatherengine.cpp.


The documentation for this class was generated from the following files:
  • weatherengine.h
  • weatherengine.cpp

Plasma

Skip menu "Plasma"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libplasma
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal