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.
tdeutils/kmilo/kmilod/monitor.h

98 lines
2.7 KiB

/*
This file is part of the KDE project
Copyright (c) 2003 George Staikos <staikos@kde.org>
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 _MONITOR_H_
#define _MONITOR_H_
#include <tqstring.h>
#include <tqstringlist.h>
#include <tqpixmap.h>
#include <tqobject.h>
#include <tdemacros.h>
class TDEConfig;
namespace KMilo {
class KMiloInterface;
class TDE_EXPORT Monitor : public TQObject {
public:
Monitor(TQObject *parent, const char *name, const TQStringList&);
virtual ~Monitor();
/**
* Called by kmilod to initialise this plugin. The plugin
* must return true if its hardware is present and it should
* be loaded. If it returns false, it will be unloaded.
*/
virtual bool init();
enum DisplayType { None, //!
Error, //! Error
Volume, //! Volume level changed
Mute, //! Volume has been muted
Brightness, //! Brighteness of the screen has changed
Tap, //! Mousttracker tap mode has changed
Sleep //! laptop will sleep in progress() seconds
};
/**
* This is called by KMiloD when it polls. Must return
* the type of event that has occurred, or None.
*/
virtual DisplayType poll();
/**
* If poll() returns stating that a value has changed, this
* will be called by kmilod to determine the value (0..100)
* for the slider in the display, if necessary.
*/
virtual int progress() const;
/**
* Message displayed for DisplayType's that are not int
* measurable ( DisplayType::Tap for example )
*/
virtual TQString message() const;
/**
* Custom pixmap that can be displayed be the themes
* when displaying the DisplayType.
*/
virtual TQPixmap customPixmap() const;
bool shouldPoll() const { return _poll; }
virtual void reconfigure(TDEConfig*);
protected:
bool _poll; // set to false to disable polling.
friend class KMiloD;
void setInterface(KMiloInterface *i) { _interface = i; }
KMiloInterface *_interface;
};
}
#endif