summaryrefslogtreecommitdiff
path: root/libopie/odevice.h
Side-by-side diff
Diffstat (limited to 'libopie/odevice.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie/odevice.h63
1 files changed, 43 insertions, 20 deletions
diff --git a/libopie/odevice.h b/libopie/odevice.h
index ff578d8..45a790b 100644
--- a/libopie/odevice.h
+++ b/libopie/odevice.h
@@ -1,17 +1,17 @@
/* This file is part of the OPIE libraries
Copyright (C) 2002 Robert Griebl (sandman@handhelds.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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
@@ -31,11 +31,14 @@
class ODeviceData;
namespace Opie {
+/**
+ * The available devices
+ */
enum OModel {
- Model_Unknown,
-
+ Model_Unknown, // = 0
+
Model_Series_Mask = 0xff000000,
Model_iPAQ = ( 1 << 24 ),
@@ -54,15 +57,21 @@ enum OModel {
Model_Zaurus_SLB600 = ( Model_Zaurus | 0x000004 ),
Model_Zaurus_SLC700 = ( Model_Zaurus | 0x000005 ),
};
-enum OVendor {
+/**
+ * The vendor of the device
+ */
+enum OVendor {
Vendor_Unknown,
Vendor_HP,
Vendor_Sharp
-};
+};
+/**
+ * The System used
+ */
enum OSystem {
System_Unknown,
System_Familiar,
@@ -93,32 +102,46 @@ enum OHardKey {
HardKey_Suspend = Qt::Key_F34,
HardKey_Backlight = Qt::Key_F35,
};
+/**
+ * A singleton which gives informations about device specefic option
+ * like the Hardware used, LEDs, the Base Distribution and
+ * hardware key mappings.
+ *
+ *
+ * @short A small class for device specefic options
+ * @see QObject
+ * @author Robert Griebl
+ * @version 1.0
+ */
class ODevice : public QObject {
Q_OBJECT
-
+
private:
+ /* disable copy */
ODevice ( const ODevice & );
protected:
ODevice ( );
virtual void init ( );
virtual void initButtons ( );
-
+
ODeviceData *d;
public:
+ // sandman do we want to allow destructions? -zecke?
virtual ~ODevice ( );
+
static ODevice *inst ( );
// information
- QString modelString ( ) const;
+ QString modelString ( ) const;
OModel model ( ) const;
inline OModel series ( ) const { return (OModel) ( model ( ) & Model_Series_Mask ); }
-
+
QString vendorString ( ) const;
OVendor vendor ( ) const;
QString systemString ( ) const;
@@ -127,19 +150,19 @@ public:
QString systemVersionString ( ) const;
Transformation rotation ( ) const;
-// system
+// system
virtual bool setSoftSuspend ( bool on );
virtual bool suspend ( );
virtual bool setDisplayStatus ( bool on );
virtual bool setDisplayBrightness ( int brightness );
virtual int displayBrightnessResolution ( ) const;
-
-// input / output
+// input / output
+ //FIXME playAlarmSound and al might be better -zecke
virtual void alarmSound ( );
virtual void keySound ( );
virtual void touchSound ( );
@@ -158,9 +181,9 @@ public:
* by the device manufacturer and will be from most preferred button to least preffered
* button. Note that this list only contains "user mappable" buttons.
*/
const QValueList<ODeviceButton> &buttons ( );
-
+
/**
* Returns the DeviceButton for the \a keyCode. If \a keyCode is not found, it
* returns 0L
*/
@@ -174,22 +197,22 @@ public:
/**
* Reassigns the held action for \a button. To return to the factory
* default pass an empty string as \a qcopMessage.
- */
+ */
void remapHeldAction ( int button, const OQCopMessage &qcopMessage );
/**
* How long (in ms) you have to press a button for a "hold" action
*/
uint buttonHoldTime ( ) const;
-signals:
+signals:
void buttonMappingChanged ( );
-
-private slots:
+
+private slots:
void systemMessage ( const QCString &, const QByteArray & );
-
+
protected:
void reloadButtonMapping ( );
};