-rw-r--r-- | libopie/odevice.h | 4 | ||||
-rw-r--r-- | libopie/otimepicker.h | 3 | ||||
-rw-r--r-- | libopie/pim/ocontactaccessbackend.h | 9 |
3 files changed, 15 insertions, 1 deletions
diff --git a/libopie/odevice.h b/libopie/odevice.h index ee0b0ec..791d358 100644 --- a/libopie/odevice.h +++ b/libopie/odevice.h | |||
@@ -219,50 +219,52 @@ public: | |||
219 | virtual void alarmSound ( ); | 219 | virtual void alarmSound ( ); |
220 | virtual void keySound ( ); | 220 | virtual void keySound ( ); |
221 | virtual void touchSound ( ); | 221 | virtual void touchSound ( ); |
222 | 222 | ||
223 | virtual QValueList <OLed> ledList ( ) const; | 223 | virtual QValueList <OLed> ledList ( ) const; |
224 | virtual QValueList <OLedState> ledStateList ( OLed led ) const; | 224 | virtual QValueList <OLedState> ledStateList ( OLed led ) const; |
225 | virtual OLedState ledState ( OLed led ) const; | 225 | virtual OLedState ledState ( OLed led ) const; |
226 | virtual bool setLedState ( OLed led, OLedState st ); | 226 | virtual bool setLedState ( OLed led, OLedState st ); |
227 | 227 | ||
228 | virtual bool hasLightSensor ( ) const; | 228 | virtual bool hasLightSensor ( ) const; |
229 | virtual int readLightSensor ( ); | 229 | virtual int readLightSensor ( ); |
230 | virtual int lightSensorResolution ( ) const; | 230 | virtual int lightSensorResolution ( ) const; |
231 | 231 | ||
232 | virtual bool hasHingeSensor ( ) const; | 232 | virtual bool hasHingeSensor ( ) const; |
233 | virtual OHingeStatus readHingeSensor ( ); | 233 | virtual OHingeStatus readHingeSensor ( ); |
234 | 234 | ||
235 | const QStrList &allowedCpuFrequencies() const; | 235 | const QStrList &allowedCpuFrequencies() const; |
236 | bool setCurrentCpuFrequency(uint index); | 236 | bool setCurrentCpuFrequency(uint index); |
237 | 237 | ||
238 | /** | 238 | /** |
239 | * Returns the available buttons on this device. The number and location | 239 | * Returns the available buttons on this device. The number and location |
240 | * of buttons will vary depending on the device. Button numbers will be assigned | 240 | * of buttons will vary depending on the device. Button numbers will be assigned |
241 | * by the device manufacturer and will be from most preferred button to least preffered | 241 | * by the device manufacturer and will be from most preferred button to least preffered |
242 | * button. Note that this list only contains "user mappable" buttons. | 242 | * button. Note that this list only contains "user mappable" buttons. |
243 | * | ||
244 | * @todo ### make const | ||
243 | */ | 245 | */ |
244 | const QValueList<ODeviceButton> &buttons ( ) /* ### make const */; | 246 | const QValueList<ODeviceButton> &buttons ( ) /** /todo ### make const */; |
245 | 247 | ||
246 | /** | 248 | /** |
247 | * Returns the DeviceButton for the \a keyCode. If \a keyCode is not found, it | 249 | * Returns the DeviceButton for the \a keyCode. If \a keyCode is not found, it |
248 | * returns 0L | 250 | * returns 0L |
249 | */ | 251 | */ |
250 | const ODeviceButton *buttonForKeycode ( ushort keyCode ); | 252 | const ODeviceButton *buttonForKeycode ( ushort keyCode ); |
251 | 253 | ||
252 | /** | 254 | /** |
253 | * Reassigns the pressed action for \a button. To return to the factory | 255 | * Reassigns the pressed action for \a button. To return to the factory |
254 | * default pass an empty string as \a qcopMessage. | 256 | * default pass an empty string as \a qcopMessage. |
255 | */ | 257 | */ |
256 | void remapPressedAction ( int button, const OQCopMessage &qcopMessage ); | 258 | void remapPressedAction ( int button, const OQCopMessage &qcopMessage ); |
257 | 259 | ||
258 | /** | 260 | /** |
259 | * Reassigns the held action for \a button. To return to the factory | 261 | * Reassigns the held action for \a button. To return to the factory |
260 | * default pass an empty string as \a qcopMessage. | 262 | * default pass an empty string as \a qcopMessage. |
261 | */ | 263 | */ |
262 | void remapHeldAction ( int button, const OQCopMessage &qcopMessage ); | 264 | void remapHeldAction ( int button, const OQCopMessage &qcopMessage ); |
263 | 265 | ||
264 | /** | 266 | /** |
265 | * How long (in ms) you have to press a button for a "hold" action | 267 | * How long (in ms) you have to press a button for a "hold" action |
266 | */ | 268 | */ |
267 | uint buttonHoldTime ( ) const; | 269 | uint buttonHoldTime ( ) const; |
268 | 270 | ||
diff --git a/libopie/otimepicker.h b/libopie/otimepicker.h index 6a9e040..8df7d10 100644 --- a/libopie/otimepicker.h +++ b/libopie/otimepicker.h | |||
@@ -45,39 +45,42 @@ class OTimePicker: public QWidget { | |||
45 | 45 | ||
46 | private slots: | 46 | private slots: |
47 | void slotHour(bool b); | 47 | void slotHour(bool b); |
48 | void slotMinute(bool b); | 48 | void slotMinute(bool b); |
49 | 49 | ||
50 | signals: | 50 | signals: |
51 | /** | 51 | /** |
52 | * gets emitted when the time got changed by the user | 52 | * gets emitted when the time got changed by the user |
53 | */ | 53 | */ |
54 | void timeChanged(const QTime &); | 54 | void timeChanged(const QTime &); |
55 | }; | 55 | }; |
56 | 56 | ||
57 | /** | 57 | /** |
58 | * | 58 | * |
59 | * @short A small dialog to pick a time | 59 | * @short A small dialog to pick a time |
60 | * @version 1.0 | 60 | * @version 1.0 |
61 | * @author Stefan Eilers | 61 | * @author Stefan Eilers |
62 | */ | 62 | */ |
63 | 63 | ||
64 | class OTimePickerDialog: public OTimePickerDialogBase { | 64 | class OTimePickerDialog: public OTimePickerDialogBase { |
65 | Q_OBJECT | 65 | Q_OBJECT |
66 | 66 | ||
67 | public: | 67 | public: |
68 | OTimePickerDialog ( QWidget* parent = 0, const char* name = NULL, WFlags fl = 0 ); | 68 | OTimePickerDialog ( QWidget* parent = 0, const char* name = NULL, WFlags fl = 0 ); |
69 | /** | ||
70 | * @todo make it non line! See KDE guide for BC | ||
71 | */ | ||
69 | ~OTimePickerDialog() { }; | 72 | ~OTimePickerDialog() { }; |
70 | 73 | ||
71 | QTime time()const; | 74 | QTime time()const; |
72 | 75 | ||
73 | public slots: | 76 | public slots: |
74 | void setTime( const QTime& time ); | 77 | void setTime( const QTime& time ); |
75 | void setHour( const QString& hour ); | 78 | void setHour( const QString& hour ); |
76 | void setMinute( const QString& minute ); | 79 | void setMinute( const QString& minute ); |
77 | 80 | ||
78 | private: | 81 | private: |
79 | QTime m_time; | 82 | QTime m_time; |
80 | class Private; | 83 | class Private; |
81 | Private* d; | 84 | Private* d; |
82 | }; | 85 | }; |
83 | #endif | 86 | #endif |
diff --git a/libopie/pim/ocontactaccessbackend.h b/libopie/pim/ocontactaccessbackend.h index 280e05c..0eac6dc 100644 --- a/libopie/pim/ocontactaccessbackend.h +++ b/libopie/pim/ocontactaccessbackend.h | |||
@@ -1,45 +1,48 @@ | |||
1 | /** | 1 | /** |
2 | * The class responsible for managing a backend. | 2 | * The class responsible for managing a backend. |
3 | * The implementation of this abstract class contains | 3 | * The implementation of this abstract class contains |
4 | * the complete database handling. | 4 | * the complete database handling. |
5 | * | 5 | * |
6 | * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de) | 6 | * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de) |
7 | * Copyright (c) 2002 by Holger Freyther (zecke@handhelds.org) | 7 | * Copyright (c) 2002 by Holger Freyther (zecke@handhelds.org) |
8 | * | 8 | * |
9 | * ===================================================================== | 9 | * ===================================================================== |
10 | *This program is free software; you can redistribute it and/or | 10 | *This program is free software; you can redistribute it and/or |
11 | *modify it under the terms of the GNU Library General Public | 11 | *modify it under the terms of the GNU Library General Public |
12 | * License as published by the Free Software Foundation; | 12 | * License as published by the Free Software Foundation; |
13 | * either version 2 of the License, or (at your option) any later | 13 | * either version 2 of the License, or (at your option) any later |
14 | * version. | 14 | * version. |
15 | * ===================================================================== | 15 | * ===================================================================== |
16 | * ToDo: Define enum for query settings | 16 | * ToDo: Define enum for query settings |
17 | * ===================================================================== | 17 | * ===================================================================== |
18 | * Version: $Id$ | 18 | * Version: $Id$ |
19 | * ===================================================================== | 19 | * ===================================================================== |
20 | * History: | 20 | * History: |
21 | * $Log$ | 21 | * $Log$ |
22 | * Revision 1.7 2004/02/19 02:05:37 zecke | ||
23 | * Add notes for API fixes and BC stuff | ||
24 | * | ||
22 | * Revision 1.6 2003/08/01 12:30:16 eilers | 25 | * Revision 1.6 2003/08/01 12:30:16 eilers |
23 | * Merging changes from BRANCH_1_0 to HEAD | 26 | * Merging changes from BRANCH_1_0 to HEAD |
24 | * | 27 | * |
25 | * Revision 1.5.4.1 2003/06/30 14:34:19 eilers | 28 | * Revision 1.5.4.1 2003/06/30 14:34:19 eilers |
26 | * Patches from Zecke: | 29 | * Patches from Zecke: |
27 | * Fixing and cleaning up extraMap handling | 30 | * Fixing and cleaning up extraMap handling |
28 | * Adding d_ptr for binary compatibility in the future | 31 | * Adding d_ptr for binary compatibility in the future |
29 | * | 32 | * |
30 | * Revision 1.5 2003/04/13 18:07:10 zecke | 33 | * Revision 1.5 2003/04/13 18:07:10 zecke |
31 | * More API doc | 34 | * More API doc |
32 | * QString -> const QString& | 35 | * QString -> const QString& |
33 | * QString = 0l -> QString::null | 36 | * QString = 0l -> QString::null |
34 | * | 37 | * |
35 | * Revision 1.4 2002/11/13 14:14:51 eilers | 38 | * Revision 1.4 2002/11/13 14:14:51 eilers |
36 | * Added sorted for Contacts.. | 39 | * Added sorted for Contacts.. |
37 | * | 40 | * |
38 | * Revision 1.3 2002/11/01 15:10:42 eilers | 41 | * Revision 1.3 2002/11/01 15:10:42 eilers |
39 | * Added regExp-search in database for all fields in a contact. | 42 | * Added regExp-search in database for all fields in a contact. |
40 | * | 43 | * |
41 | * Revision 1.2 2002/10/07 17:34:24 eilers | 44 | * Revision 1.2 2002/10/07 17:34:24 eilers |
42 | * added OBackendFactory for advanced backend access | 45 | * added OBackendFactory for advanced backend access |
43 | * | 46 | * |
44 | * Revision 1.1 2002/09/27 17:11:44 eilers | 47 | * Revision 1.1 2002/09/27 17:11:44 eilers |
45 | * Added API for accessing the Contact-Database ! It is compiling, but | 48 | * Added API for accessing the Contact-Database ! It is compiling, but |
@@ -50,49 +53,55 @@ | |||
50 | * ===================================================================== | 53 | * ===================================================================== |
51 | * | 54 | * |
52 | */ | 55 | */ |
53 | 56 | ||
54 | #ifndef _OCONTACTACCESSBACKEND_H_ | 57 | #ifndef _OCONTACTACCESSBACKEND_H_ |
55 | #define _OCONTACTACCESSBACKEND_H_ | 58 | #define _OCONTACTACCESSBACKEND_H_ |
56 | 59 | ||
57 | #include "ocontact.h" | 60 | #include "ocontact.h" |
58 | #include "opimaccessbackend.h" | 61 | #include "opimaccessbackend.h" |
59 | 62 | ||
60 | #include <qregexp.h> | 63 | #include <qregexp.h> |
61 | 64 | ||
62 | /** | 65 | /** |
63 | * This class represents the interface of all Contact Backends. | 66 | * This class represents the interface of all Contact Backends. |
64 | * Derivates of this class will be used to access the contacts. | 67 | * Derivates of this class will be used to access the contacts. |
65 | * As implementation currently XML and vCard exist. This class needs to be implemented | 68 | * As implementation currently XML and vCard exist. This class needs to be implemented |
66 | * if you want to provide your own storage. | 69 | * if you want to provide your own storage. |
67 | * In all queries a list of uids is passed on instead of loading the actual record! | 70 | * In all queries a list of uids is passed on instead of loading the actual record! |
68 | * | 71 | * |
69 | * @see OContactAccessBackend_VCard | 72 | * @see OContactAccessBackend_VCard |
70 | * @see OContactAccessBackend_XML | 73 | * @see OContactAccessBackend_XML |
71 | */ | 74 | */ |
72 | class OContactAccessBackend: public OPimAccessBackend<OContact> { | 75 | class OContactAccessBackend: public OPimAccessBackend<OContact> { |
73 | public: | 76 | public: |
77 | /** | ||
78 | * @todo make non line in regard to BC guide of KDE | ||
79 | */ | ||
74 | OContactAccessBackend() {} | 80 | OContactAccessBackend() {} |
81 | /** | ||
82 | * @todo make non inline in regard to the BC guide of KDE | ||
83 | */ | ||
75 | virtual ~OContactAccessBackend() {} | 84 | virtual ~OContactAccessBackend() {} |
76 | 85 | ||
77 | 86 | ||
78 | /** | 87 | /** |
79 | * Return if database was changed externally. | 88 | * Return if database was changed externally. |
80 | * This may just make sense on file based databases like a XML-File. | 89 | * This may just make sense on file based databases like a XML-File. |
81 | * It is used to prevent to overwrite the current database content | 90 | * It is used to prevent to overwrite the current database content |
82 | * if the file was already changed by something else ! | 91 | * if the file was already changed by something else ! |
83 | * If this happens, we have to reload before save our data. | 92 | * If this happens, we have to reload before save our data. |
84 | * If we use real databases, this should be handled by the database | 93 | * If we use real databases, this should be handled by the database |
85 | * management system themselve, therefore this function should always return false in | 94 | * management system themselve, therefore this function should always return false in |
86 | * this case. It is not our problem to handle this conflict ... | 95 | * this case. It is not our problem to handle this conflict ... |
87 | * @return <i>true</i> if the database was changed and if save without reload will | 96 | * @return <i>true</i> if the database was changed and if save without reload will |
88 | * be dangerous. <i>false</i> if the database was not changed or it is save to write | 97 | * be dangerous. <i>false</i> if the database was not changed or it is save to write |
89 | * in this situation. | 98 | * in this situation. |
90 | */ | 99 | */ |
91 | virtual bool wasChangedExternally() = 0; | 100 | virtual bool wasChangedExternally() = 0; |
92 | 101 | ||
93 | virtual QArray<int> matchRegexp( const QRegExp &r ) const = 0; | 102 | virtual QArray<int> matchRegexp( const QRegExp &r ) const = 0; |
94 | 103 | ||
95 | /** | 104 | /** |
96 | * Return all possible settings. | 105 | * Return all possible settings. |
97 | * @return All settings provided by the current backend | 106 | * @return All settings provided by the current backend |
98 | * (i.e.: query_WildCards & query_IgnoreCase) | 107 | * (i.e.: query_WildCards & query_IgnoreCase) |