You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tderadio/src/include/radiostation.h

165 lines
6.1 KiB

/***************************************************************************
radiostation.h - description
-------------------
begin : Sat Feb 2 2002
copyright : (C) 2003 by Martin Witte, Klas Kalass
email : witte@kawo1.rwth-aachen.de / klas@kde.org
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef KRADIO_RADIOSTATION_H
#define KRADIO_RADIOSTATION_H
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
//#include "utils.h"
#include <tqstring.h>
#include <tqstringlist.h>
#include <tqdict.h>
#include <tdelocale.h>
/**
*@author Martin Witte, Klas Kalass
*/
/*
RadioStation
RadioStation is an abstract base class for any type of radio station,
e.g. AM/FM stations or internet radio stations. Thus no specific knowledge
about the frequency or URL is included in this class. A radio station
should not contain information on a matching device as well. The device has
to decide on its own to use or not to use a station.
There are some important abstract functions, that have to be overwritten by
a derived radio station:
copy create an exact copy of a station (in case we only have a RadioStation*
longName return a verbous station description
isValid is this station setup correctly ?
compare is this station equivalent to another station, e.g. approximately same frequency
getclassname classname string for station registry
Other methods "should" be overwritten, but still call inherited methods for completeness!
get/setProperty
getPropertyNames
*/
/////////////////////////////////////////////////////////////////////////////
extern struct RegisterStationClass {} registerStationClass;
/////////////////////////////////////////////////////////////////////////////
class RadioStationConfig;
class KDE_EXPORT RadioStation
{
protected:
RadioStation (RegisterStationClass, const TQString &classname);
public:
RadioStation ();
RadioStation (const TQString &name, const TQString &shortName);
RadioStation (const RadioStation &);
virtual ~RadioStation();
const TQString &stationID() const { return m_stationID; }
virtual TQString longName() const = 0;
virtual TQString description() const = 0;
const TQString &name() const { return m_name; }
const TQString &shortName() const { return m_shortName; }
const TQString &iconName() const { return m_iconName; }
float initialVolume() const { return m_initialVolume; }
void setName (const TQString &name) { m_name = name; }
void setShortName (const TQString &shortName) { m_shortName = shortName; }
void setIconName (const TQString &iconName) { m_iconName = iconName; }
void setInitialVolume(float initialVolume) { m_initialVolume = initialVolume; }
void copyDescriptionFrom(const RadioStation &rs);
// for XML-Parsing/Export
virtual bool setProperty(const TQString &property_name, const TQString &val);
virtual TQString getProperty(const TQString &property_name) const;
virtual TQStringList getPropertyNames() const;
virtual TQString getClassName() const = 0;
// get empty derived stations by classname from registry
static RadioStation const *getStationClass(const TQString &classname);
RadioStation const *getStationClass() const { return getStationClass(getClassName()); }
// = 0 : "this" is same as "s", e.g. approximately same frequency, same url, ...
// > 0 : "this" is numerically (frequencies) or alphanumerically (urls) or ... greater than "s"
// < 0 : "this" is numerically (frequencies) or alphanumerically (urls) or ... smaller than "s"
virtual int compare(const RadioStation &s) const = 0;
// is this station setup correctly ?
virtual bool isValid() const = 0;
/** returns an exact copy of this station */
virtual RadioStation *copy() const = 0;
/** returns an exact copy of this station, BUT with a new station ID */
virtual RadioStation *copyNewID() const = 0;
void generateNewStationID();
virtual RadioStationConfig *createEditor() const = 0;
virtual bool operator == (const RadioStation &x) const;
virtual bool operator != (const RadioStation &x) const { return !operator==(x); }
protected :
TQString m_stationID;
TQString m_name;
TQString m_shortName;
float m_initialVolume; // <0: => Don't use
TQString m_iconName;
private:
static TQDict<RadioStation> *stationClassRegistry;
};
class KDE_EXPORT UndefinedRadioStation : public RadioStation
{
public:
UndefinedRadioStation (RegisterStationClass) : RadioStation (registerStationClass, getClassName()) {}
virtual TQString longName() const { return i18n("unknown"); }
virtual TQString description() const { return i18n("unknown"); }
virtual bool isValid() const { return false; }
virtual RadioStation *copy() const { return new UndefinedRadioStation(*this); }
virtual RadioStation *copyNewID() const { RadioStation *x = new UndefinedRadioStation(*this); x->generateNewStationID(); return x; }
virtual int compare(const RadioStation &s) const;
virtual TQString getClassName() const { return "UndefinedRadioStation"; }
virtual RadioStationConfig *createEditor() const;
};
extern "C" const UndefinedRadioStation undefinedRadioStation;
#endif