-rw-r--r-- | library/global.cpp | 165 |
1 files changed, 124 insertions, 41 deletions
diff --git a/library/global.cpp b/library/global.cpp index ab27b3f..7438891 100644 --- a/library/global.cpp +++ b/library/global.cpp | |||
@@ -1,5 +1,5 @@ | |||
1 | /********************************************************************** | 1 | /********************************************************************** |
2 | ** Copyright (C) 2000 Trolltech AS. All rights reserved. | 2 | ** Copyright (C) 2000-2002 Trolltech AS. All rights reserved. |
3 | ** | 3 | ** |
4 | ** This file is part of Qtopia Environment. | 4 | ** This file is part of the Qtopia Environment. |
5 | ** | 5 | ** |
@@ -47,3 +47,5 @@ | |||
47 | 47 | ||
48 | #ifdef QWS | ||
48 | #include <qwindowsystem_qws.h> // for qwsServer | 49 | #include <qwindowsystem_qws.h> // for qwsServer |
50 | #endif | ||
49 | #include <qdatetime.h> | 51 | #include <qdatetime.h> |
@@ -58,3 +60,3 @@ namespace { | |||
58 | return true; | 60 | return true; |
59 | 61 | ||
60 | QByteArray array = file.readAll(); | 62 | QByteArray array = file.readAll(); |
@@ -110,2 +112,3 @@ StartingAppList::StartingAppList( QObject *parent, const char* name ) | |||
110 | { | 112 | { |
113 | #ifdef QWS | ||
111 | #if QT_VERSION >= 232 && !defined(QT_NO_COP) | 114 | #if QT_VERSION >= 232 && !defined(QT_NO_COP) |
@@ -115,2 +118,3 @@ StartingAppList::StartingAppList( QObject *parent, const char* name ) | |||
115 | #endif | 118 | #endif |
119 | #endif | ||
116 | } | 120 | } |
@@ -171,3 +175,51 @@ static QString dictDir() | |||
171 | \class Global global.h | 175 | \class Global global.h |
172 | \brief The Global class collects application-wide global functions. | 176 | \brief The Global class provides application-wide global functions. |
177 | |||
178 | The Global functions are grouped as follows: | ||
179 | \tableofcontents | ||
180 | |||
181 | \section1 User Interface | ||
182 | |||
183 | The statusMessage() function provides short-duration messages to the | ||
184 | user. The showInputMethod() function shows the current input method, | ||
185 | and hideInputMethod() hides the input method. | ||
186 | |||
187 | \section1 Document related | ||
188 | |||
189 | The findDocuments() function creates a set of \link doclnk.html | ||
190 | DocLnk\endlink objects in a particular folder. | ||
191 | |||
192 | \section1 Filesystem related | ||
193 | |||
194 | Global provides an applicationFileName() function that returns the | ||
195 | full path of an application-specific file. | ||
196 | |||
197 | The execute() function runs an application. | ||
198 | |||
199 | \section1 Word list related | ||
200 | |||
201 | A list of words relevant to the current locale is maintained by the | ||
202 | system. The list is held in a \link qdawg.html DAWG\endlink | ||
203 | (implemented by the QDawg class). This list is used, for example, by | ||
204 | the pickboard input method. | ||
205 | |||
206 | The global QDawg is returned by fixedDawg(); this cannot be updated. | ||
207 | An updatable copy of the global QDawg is returned by addedDawg(). | ||
208 | Applications may have their own word lists stored in \l{QDawg}s | ||
209 | which are returned by dawg(). Use addWords() to add words to the | ||
210 | updateable copy of the global QDawg or to named application | ||
211 | \l{QDawg}s. | ||
212 | |||
213 | \section1 Quoting | ||
214 | |||
215 | The shellQuote() function quotes a string suitable for passing to a | ||
216 | shell. The stringQuote() function backslash escapes '\' and '"' | ||
217 | characters. | ||
218 | |||
219 | \section1 Hardware | ||
220 | |||
221 | The writeHWClock() function sets the hardware clock to the system | ||
222 | clock's date and time. | ||
223 | |||
224 | \ingroup qtopiaemb | ||
173 | */ | 225 | */ |
@@ -254,3 +306,3 @@ const QDawg& Global::dawg(const QString& name) | |||
254 | named_dawg->insert(name,r); | 306 | named_dawg->insert(name,r); |
255 | QString dawgfilename = dictDir() + "/" + name + ".dawg"; | 307 | QString dawgfilename = applicationFileName("Dictionary", name ) + ".dawg"; |
256 | QFile dawgfile(dawgfilename); | 308 | QFile dawgfile(dawgfilename); |
@@ -263,3 +315,8 @@ const QDawg& Global::dawg(const QString& name) | |||
263 | /*! | 315 | /*! |
316 | \overload | ||
264 | Adds \a wordlist to the addedDawg(). | 317 | Adds \a wordlist to the addedDawg(). |
318 | |||
319 | Note that the addition of words persists between program executions | ||
320 | (they are saved in the dictionary files), so you should confirm the | ||
321 | words with the user before adding them. | ||
265 | */ | 322 | */ |
@@ -271,3 +328,8 @@ void Global::addWords(const QStringList& wordlist) | |||
271 | /*! | 328 | /*! |
272 | Adds \a wordlist to the dawg() named \a dictname. | 329 | \overload |
330 | Adds \a wordlist to the addedDawg(). | ||
331 | |||
332 | Note that the addition of words persists between program executions | ||
333 | (they are saved in the dictionary files), so you should confirm the | ||
334 | words with the user before adding them. | ||
273 | */ | 335 | */ |
@@ -279,3 +341,3 @@ void Global::addWords(const QString& dictname, const QStringList& wordlist) | |||
279 | 341 | ||
280 | QString dawgfilename = dictDir() + "/" + dictname + ".dawg"; | 342 | QString dawgfilename = applicationFileName("Dictionary", dictname) + ".dawg"; |
281 | QFile dawgfile(dawgfilename); | 343 | QFile dawgfile(dawgfilename); |
@@ -293,7 +355,7 @@ void Global::addWords(const QString& dictname, const QStringList& wordlist) | |||
293 | /*! | 355 | /*! |
294 | Returns a full path for the application named \a appname, with the | 356 | Returns the full path for the application called \a appname, with the |
295 | given \a filename or QString::null if there was a problem creating | 357 | given \a filename. Returns QString::null if there was a problem creating |
296 | the directory tree for \a appname. | 358 | the directory tree for \a appname. |
297 | If \a filename contains "/", it is the caller's responsibility to | 359 | If \a filename contains "/", it is the caller's responsibility to |
298 | ensure those directories exist. | 360 | ensure that those directories exist. |
299 | */ | 361 | */ |
@@ -328,4 +390,4 @@ void Global::createDocDir() | |||
328 | /*! | 390 | /*! |
329 | Displays a status \a message to the user. This generally appears | 391 | Displays a status \a message to the user. This usually appears |
330 | in the taskbar for some amount of time, then disappears. | 392 | in the taskbar for a short amount of time, then disappears. |
331 | */ | 393 | */ |
@@ -375,2 +437,9 @@ QWidget *Global::restart( bool ) | |||
375 | Explicitly show the current input method. | 437 | Explicitly show the current input method. |
438 | |||
439 | Input methods are indicated in the taskbar by a small icon. If the | ||
440 | input method is activated (shown) then it takes up some proportion | ||
441 | of the bottom of the screen, to allow the user to interact (input | ||
442 | characters) with it. | ||
443 | |||
444 | \sa hideInputMethod() | ||
376 | */ | 445 | */ |
@@ -385,2 +454,7 @@ void Global::showInputMethod() | |||
385 | Explicitly hide the current input method. | 454 | Explicitly hide the current input method. |
455 | |||
456 | The current input method is still indicated in the taskbar, but no | ||
457 | longer takes up screen space, and can no longer be interacted with. | ||
458 | |||
459 | \sa showInputMethod() | ||
386 | */ | 460 | */ |
@@ -467,2 +541,3 @@ void Global::terminate( const AppLnk* app ) | |||
467 | 541 | ||
542 | #ifndef QT_NO_COP | ||
468 | QCString channel = "QPE/Application/" + app->exec().utf8(); | 543 | QCString channel = "QPE/Application/" + app->exec().utf8(); |
@@ -471,2 +546,3 @@ void Global::terminate( const AppLnk* app ) | |||
471 | } | 546 | } |
547 | #endif | ||
472 | } | 548 | } |
@@ -474,5 +550,9 @@ void Global::terminate( const AppLnk* app ) | |||
474 | /*! | 550 | /*! |
475 | Low-level function to run command \a c. Not recommended. | 551 | Low-level function to run command \a c. |
552 | |||
553 | \warning Do not use this function. Use execute instead. | ||
554 | |||
555 | \sa execute() | ||
476 | */ | 556 | */ |
477 | void Global::invoke(const QString &c) | 557 | void Global::invoke(const QString &c) |
478 | { | 558 | { |
@@ -484,3 +564,3 @@ void Global::invoke(const QString &c) | |||
484 | // see if the application is already running | 564 | // see if the application is already running |
485 | // XXX should lock file /tmp/qcop-msg-ap | 565 | // XXX should lock file /tmp/qcop-msg-ap |
486 | if ( QCopChannel::isRegistered( ("QPE/Application/" + ap).latin1() ) ) { | 566 | if ( QCopChannel::isRegistered( ("QPE/Application/" + ap).latin1() ) ) { |
@@ -490,3 +570,3 @@ void Global::invoke(const QString &c) | |||
490 | } | 570 | } |
491 | // XXX should unlock file /tmp/qcop-msg-ap | 571 | // XXX should unlock file /tmp/qcop-msg-ap |
492 | //see if it is being started | 572 | //see if it is being started |
@@ -526,3 +606,3 @@ void Global::invoke(const QString &c) | |||
526 | quickexecv( libexe.utf8().data(), (const char **)args ); | 606 | quickexecv( libexe.utf8().data(), (const char **)args ); |
527 | } else | 607 | } else |
528 | #endif | 608 | #endif |
@@ -543,7 +623,9 @@ void Global::invoke(const QString &c) | |||
543 | 623 | ||
624 | |||
544 | /*! | 625 | /*! |
545 | Executes application identfied by \a c, passing \a document. | 626 | Executes the application identfied by \a c, passing \a |
627 | document if it isn't null. | ||
546 | 628 | ||
547 | Note that you might be better off sending a QCop message to | 629 | Note that a better approach might be to send a QCop message to the |
548 | the application's QPE/Application/<i>appname</i> channel. | 630 | application's QPE/Application/\e{appname} channel. |
549 | */ | 631 | */ |
@@ -579,4 +661,6 @@ void Global::execute( const QString &c, const QString& document ) | |||
579 | } | 661 | } |
662 | #ifndef QT_NO_COP | ||
580 | QCopEnvelope e("QPE/System", "notBusy(QString)" ); | 663 | QCopEnvelope e("QPE/System", "notBusy(QString)" ); |
581 | e << c; // that was quick ;-) | 664 | e << c; // that was quick ;-) |
665 | #endif | ||
582 | return; | 666 | return; |
@@ -596,3 +680,3 @@ void Global::execute( const QString &c, const QString& document ) | |||
596 | if ( ap == "suspend" ) { | 680 | if ( ap == "suspend" ) { |
597 | QWSServer::sendKeyEvent( 0xffff, Qt::Key_F34, FALSE, TRUE, FALSE ); | 681 | QWSServer::sendKeyEvent( 0xffff, Qt::Key_F34, FALSE, TRUE, FALSE ); |
598 | return; | 682 | return; |
@@ -600,5 +684,6 @@ void Global::execute( const QString &c, const QString& document ) | |||
600 | 684 | ||
601 | /* if need be, sending a qcop message will result in an invoke, see | 685 | /* if need be, sending a qcop message will result in an invoke, see |
602 | preceeding function */ | 686 | preceeding function */ |
603 | { QCopEnvelope env( ("QPE/Application/" + ap).latin1(), "raise()" ); } | 687 | invoke( ap ); |
688 | //{ QCopEnvelope env( ("QPE/Application/" + ap).latin1(), "raise()" ); } | ||
604 | if ( !document.isEmpty() ) { | 689 | if ( !document.isEmpty() ) { |
@@ -611,4 +696,6 @@ void Global::execute( const QString &c, const QString& document ) | |||
611 | /*! | 696 | /*! |
612 | Returns the string \a s with the characters backslash, ", and $ | 697 | Returns the string \a s with the characters '\', '"', and '$' quoted |
613 | quoted by a preceeding backslash. | 698 | by a preceeding '\'. |
699 | |||
700 | \sa stringQuote() | ||
614 | */ | 701 | */ |
@@ -630,4 +717,6 @@ QString Global::shellQuote(const QString& s) | |||
630 | /*! | 717 | /*! |
631 | Returns the string \a s with the characters backslash and " | 718 | Returns the string \a s with the characters '\' and '"' quoted by a |
632 | quoted by a preceeding backslash. | 719 | preceeding '\'. |
720 | |||
721 | \sa shellQuote() | ||
633 | */ | 722 | */ |
@@ -663,4 +752,4 @@ void Global::findDocuments(DocLnkSet* folder, const QString &mimefilter) | |||
663 | * d) the user wants to check and this medium as well | 752 | * d) the user wants to check and this medium as well |
664 | * | 753 | * |
665 | * In all cases we need to apply a different mimefilter to | 754 | * In all cases we need to apply a different mimefilter to |
666 | * the medium. | 755 | * the medium. |
@@ -677,3 +766,3 @@ void Global::findDocuments(DocLnkSet* folder, const QString &mimefilter) | |||
677 | if ( (*it)->isRemovable() ) { // let's find out if we should search on it | 766 | if ( (*it)->isRemovable() ) { // let's find out if we should search on it |
678 | // this is a candidate look at the cf and see if we should search on it | 767 | // this is a candidate look at the cf and see if we should search on it |
679 | QString path = (*it)->path(); | 768 | QString path = (*it)->path(); |
@@ -715,12 +804,6 @@ QStringList Global::helpPath() | |||
715 | path += QPEApplication::qpeDir() + "/pics"; | 804 | path += QPEApplication::qpeDir() + "/pics"; |
716 | path += QPEApplication::qpeDir() + "/help/en/html"; | 805 | path += QPEApplication::qpeDir() + "/help/html"; |
717 | path += QPEApplication::qpeDir() + "/docs"; | 806 | path += QPEApplication::qpeDir() + "/docs"; |
718 | QString dir = QDir::current().canonicalPath(); | 807 | |
719 | if ( dir == "/" ) | 808 | |
720 | dir += "/docs"; | ||
721 | else { | ||
722 | path += dir + "/../pics"; | ||
723 | dir += "/../docs"; | ||
724 | path += dir; | ||
725 | } | ||
726 | return path; | 809 | return path; |