| -rw-r--r-- | development/pim/pim_howto/pim_howto.lyx | 112 |
1 files changed, 60 insertions, 52 deletions
diff --git a/development/pim/pim_howto/pim_howto.lyx b/development/pim/pim_howto/pim_howto.lyx index 4571996..1e43d63 100644 --- a/development/pim/pim_howto/pim_howto.lyx +++ b/development/pim/pim_howto/pim_howto.lyx @@ -53,6 +53,6 @@ {\if@restonecol\onecolumn\else\clearpage\fi} \end_preamble -\language german -\inputencoding auto +\language american +\inputencoding default \fontscheme ae \graphics default @@ -71,5 +71,5 @@ \paragraph_separation skip \defskip medskip -\quotes_language german +\quotes_language english \quotes_times 2 \papercolumns 1 @@ -98,5 +98,5 @@ Abstract The Opie-Pim API provides a powerfull access interface to the PIM (Personal Information Management) data which contains your contact information, the - dates in your calender tool (in this paper called datebook events) and + dates in your calendar tool (in this paper called datebook events) and your todo events. Beside providing full featured access to this information, it covers the @@ -107,5 +107,5 @@ The Opie-Pim API provides a powerfull access interface to the PIM (Personal While starting to read the automatically generated API-documentation, the - user may be confused by a lot of unneccessary classes and details which + user may be confused by a lot of unnecessary classes and details which makes the quick start not as easy as possible. Due to the fact that a user will not need most of the details, this paper @@ -125,5 +125,5 @@ Introduction \layout Standard -Before starting to jump into the work, we should introduce some specialities +Before starting to jump into the work, we should introduce some specialties of the PIM API, first. To know these facts should help to avoid possible irritations and misunderstand @@ -134,9 +134,9 @@ The PIM-API heavily uses C++ templates (as known as generic classes), but you don't have to understand very deeple what templates are doing and how they work! Most of the API works without even seeing the templates. - In some cases whe have to use them (for instance to use the factory classes), + In some cases we have to use them (for instance to use the factory classes), but this guide will provide examples which should help to find the path through. But it is a good idea to read some short introduction of templates to avoid - unneccessary mistakes. + unnecessary mistakes. \layout Enumerate @@ -152,5 +152,5 @@ backend. While the frontend provides the API for the user, the backend implements how to access the databases and what to do with the data. - As we just want to access data, this paper just focusses the frontend. + As we just want to access data, this paper just focuses the frontend. Thus, you should ignore all classes which contains something like \begin_inset Quotes gld @@ -161,6 +161,6 @@ backend \end_inset - in its name! Backends are just interessting for people who want to extend - or implement new possiblities about how to access databases, which will + in its name! Backends are just interesting for people who want to extend + or implement new possibilities about how to access databases, which will be discussed at the end of this paper. Currently, you just have to understand that there do exist several backends @@ -218,5 +218,5 @@ OPimAccessFactory \layout LyX-Code -T* defaultAccess (typename OPimGlobal::PimType type, const QString &appName) +T* defaultAccess (typename OPimGlobal::PimType type, const QString &appName) \layout Standard @@ -242,5 +242,5 @@ If everything works as expected, you will receive a pointer to the contact Accessing the datebook database works equally \begin_inset Foot -collapsed true +collapsed false \layout Standard @@ -276,7 +276,7 @@ defaultAccess() \emph default -, the default dabase is accessed automatically +, the default database is accessed automatically \begin_inset Foot -collapsed true +collapsed false \layout Standard @@ -361,5 +361,5 @@ data-class for the selected access-class: OPimContact \begin_inset Foot -collapsed true +collapsed false \layout Standard @@ -375,5 +375,5 @@ see for OPimContactAccess, OPimEvent \begin_inset Foot -collapsed true +collapsed false \layout Standard @@ -389,5 +389,5 @@ see for ODateBookAccess and OPimTodo \begin_inset Foot -collapsed true +collapsed false \layout Standard @@ -407,5 +407,5 @@ bool load (); \layout LyX-Code -bool reload (); +bool reload (); \layout LyX-Code @@ -415,11 +415,11 @@ bool save (); \layout LyX-Code -bool add (const T& t); +bool add (const T& t); \layout LyX-Code -bool remove (const T& t); +bool remove (const T& t); \layout LyX-Code -bool replace (const T& t); +bool replace (const T& t); \layout Standard @@ -461,9 +461,9 @@ without removing any local changes \begin_inset Foot -collapsed true +collapsed false \layout Standard -We should check whether all dabases behave like this! (se) +We should check whether all databases behave like this! (se) \end_inset @@ -497,5 +497,5 @@ OPimRecordList \layout LyX-Code -List allRecords (); +List allRecords(); \layout Standard @@ -505,8 +505,8 @@ List \emph default just contains a list of uid's to take care of memory space. - As every record is identified by an unique identifaction number which is - called UID (Unique IDentification), these numbers just exists once in the - database which is currently on access! To receive the real record, you - have to use the operation + As every record is identified by an unique identification number which + is called UID (Unique Identification), these numbers just exists once in + the database which is currently on access! To receive the real record, + you have to use the operation \begin_inset Quotes gld \end_inset @@ -516,8 +516,8 @@ find() \end_inset - with a valid UID as paramter: + with a valid UID as parameter: \layout LyX-Code -T find (UID uid); +T find (UID uid); \layout Standard @@ -559,5 +559,5 @@ As shown in the previous chapter, all we need to access the PIM-Database \layout Standard -But first we will start with intoducing some features of the +But first we will start with introducing some features of the \series bold OPimAccessFactory @@ -582,5 +582,5 @@ defaultAccess() \end_inset - to request an access-object to the dafault backend. + to request an access-object to the default backend. Whether this default backend will access the XML, VCard or SQLite database type, is defined by the configuration file @@ -617,5 +617,5 @@ defaultAccess() If the developer wants to select a special database type for sure without - unnecessary side effects, he has to use the oparation + unnecessary side effects, he has to use the operation \emph on create() @@ -624,9 +624,9 @@ create() \layout LyX-Code -T * create (OPimGlobal::PimType type, OPimGlobal::DatabaseStyle dbStyle, +T* create (OPimGlobal::PimType type, OPimGlobal::DatabaseStyle dbStyle, const QString &appName, const QString &fileName=QString::null) \layout Standard -Some paramters are already known, like type and appName (see section +Some parameters are already known, like type and appName (see section \begin_inset LatexCommand \ref{sec:Instantiate-the-Access} @@ -747,8 +747,8 @@ In most cases it is not sufficient to receive just a list of all information It is essential to get a subset of the information available and to be able to sort it. - For this kind of excercise we provide some special operations which provide + For this kind of exercise we provide some special operations which provide searching and sorting in an incremental manner \begin_inset Foot -collapsed true +collapsed false \layout Standard @@ -841,5 +841,5 @@ The function is defined like this: \layout LyX-Code -List matchRegexp (const QRegExp &r); +List matchRegexp (const QRegExp& r); \layout Standard @@ -898,9 +898,9 @@ OPimContact searchQuery; searchQuery.setLastName( -\begin_inset Quotes gld +\begin_inset Quotes eld \end_inset Eilers -\begin_inset Quotes grd +\begin_inset Quotes erd \end_inset @@ -909,9 +909,9 @@ Eilers searchQuery.setHomeZip( -\begin_inset Quotes gld +\begin_inset Quotes eld \end_inset 3* -\begin_inset Quotes grd +\begin_inset Quotes srd \end_inset @@ -960,6 +960,6 @@ The next step is to put this query into the operation which is defined like \layout LyX-Code -List queryByExample (const T& query, int querySettings, const QDateTime - &startperiod=QDateTime()) +List queryByExample (const T& query, int querySettings, const QDateTime& + startperiod=QDateTime()) \layout Standard @@ -981,5 +981,13 @@ querySettings to configure the search properly. - This settings are defined by the enum QuerySettings in the class + This settings are defined by the enumeration +\begin_inset Quotes gld +\end_inset + +QuerySettings +\begin_inset Quotes grd +\end_inset + + in the class \series bold OPimBase @@ -1083,5 +1091,5 @@ It should be clear at this stage, that this query is very powerful and - Thus, not all backends do support all features defined by querySettings \begin_inset Foot -collapsed true +collapsed false \layout Standard @@ -1098,8 +1106,8 @@ At this time, just the contact database for XML and VCard is supporting \layout LyX-Code -bool hasQuerySettings( uint querySettings ); +bool hasQuerySettings( uint querySettings ); \layout LyX-Code -uint querySettings(); +uint querySettings(); \layout Standard @@ -1203,5 +1211,5 @@ List as the first parameter. - The search operation will just occure on this set of uid's! + The search operation will just occur on this set of uid's! \layout Subsection @@ -1213,5 +1221,5 @@ To sort a given dataset, you should use the following operation (or one \layout LyX-Code -List sorted (const List& list, bool ascending, int sortOrder, int sortFilter, +List sorted (const List& list, bool ascending, int sortOrder, int sortFilter, const QArray< UID >& cats); \layout Standard @@ -1402,5 +1410,5 @@ Internal Signal Handling: Automatic Propagation of Changes \layout Standard -Need to be written and is not implemented completly! +Need to be written and is not implemented completely! \layout Chapter |