added helpful comment on usage of virtualHook

1 files changed, 6 insertions, 0 deletions

diff --git a/libopie/odevice.h b/libopie/odevice.h
index a232d69..650a2da 100644
--- a/libopie/odevice.h
+++ b/libopie/odevice.h
@@ -90,161 +90,167 @@ enum OVendor {
 enum OSystem {
         System_Unknown,
 
         System_Familiar,
         System_Zaurus,
         System_OpenZaurus
 };
 
 enum OLedState {
         Led_Off,
         Led_On,
         Led_BlinkSlow,
         Led_BlinkFast
 };
 
 enum OLed {
         Led_Mail,
         Led_Power,
         Led_BlueTooth
 };
 
 enum OHardKey {
         HardKey_Datebook  = Qt::Key_F9,
         HardKey_Contacts  = Qt::Key_F10,
         HardKey_Menu      = Qt::Key_F11,
         HardKey_Home      = Qt::Key_F12,
         HardKey_Mail      = Qt::Key_F13,
         HardKey_Record    = Qt::Key_F24,
         HardKey_Suspend   = Qt::Key_F34,
         HardKey_Backlight = Qt::Key_F35,
 };
 
 enum ODirection {
         CW   = 0,
         CCW  = 1,
         Flip = 2,
 };
 
 /**
  * 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;
         OModel model ( ) const;
         inline OModel series ( ) const { return (OModel) ( model ( ) & Model_Series_Mask ); }
 
         QString vendorString ( ) const;
         OVendor vendor ( ) const;
 
         QString systemString ( ) const;
         OSystem system ( ) const;
 
         QString systemVersionString ( ) const;
 
         Transformation rotation ( ) const;
         ODirection direction ( ) const;
 
 // system
 
         virtual bool setSoftSuspend ( bool on );
         virtual bool suspend ( );
 
         virtual bool setDisplayStatus ( bool on );
         virtual bool setDisplayBrightness ( int brightness );
         virtual int displayBrightnessResolution ( ) const;
         virtual bool setDisplayContrast ( int contrast );
         virtual int displayContrastResolution ( ) const;
 
+        // don't add new virtual methods, use this:
+                ///*virtual */ void boo(int i ) { return virtual_hook(1,&i); };
+        // and in your subclass do do overwrite
+                //protected virtual int virtual_hook(int, void *)
+        // which is defined below
+
 // input / output
         //FIXME playAlarmSound and al might be better -zecke
         virtual void alarmSound ( );
         virtual void keySound ( );
         virtual void touchSound ( );
 
         virtual QValueList <OLed> ledList ( ) const;
         virtual QValueList <OLedState> ledStateList ( OLed led ) const;
         virtual OLedState ledState ( OLed led ) const;
         virtual bool setLedState ( OLed led, OLedState st );
 
         virtual bool hasLightSensor ( ) const;
         virtual int readLightSensor ( );
         virtual int lightSensorResolution ( ) const;
 
         const QStrList &allowedCpuFrequencies() const;
         bool setCurrentCpuFrequency(uint index);
 
         /**
          * Returns the available buttons on this device.  The number and location
          * of buttons will vary depending on the device.  Button numbers will be assigned
          * 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
          */
         const ODeviceButton *buttonForKeycode ( ushort keyCode );
 
         /**
          * Reassigns the pressed action for \a button.  To return to the factory
          * default pass an empty string as \a qcopMessage.
          */
         void remapPressedAction ( int button, const OQCopMessage &qcopMessage );
 
         /**
          * 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:
         void buttonMappingChanged ( );
 
 private slots:
         void systemMessage ( const QCString &, const QByteArray & );
 
 protected:
         void reloadButtonMapping ( );
         /*  ugly virtual hook */
         virtual void virtual_hook( int id, void* data );
 };
 
 }
 
 #endif