Fix API docu

1 files changed, 16 insertions, 0 deletions

diff --git a/library/applnk.cpp b/library/applnk.cpp
index 35822dd..00030e8 100644
--- a/library/applnk.cpp
+++ b/library/applnk.cpp
@@ -207,257 +207,273 @@ public:
     \endtable
 
     To save an AppLnk to disk use writeLink(). To execute the
     application that the AppLnk object refers to, use execute().
 
     AppLnk's can be deleted from disk using removeLinkFile(). To
     remove both the link and the application's executable use
     removeFiles().
 
     Icon sizes can be globally changed (but only for AppLnk objects
     created after the calls) with setSmallIconSize() and
     setBigIconSize().
 
     \ingroup qtopiaemb
 */
 
 /*!
   Sets the size used for small icons to \a small pixels.
   Only affects AppLnk objects created after the call.
 
   \sa smallIconSize() setIcon()
 */
 void AppLnk::setSmallIconSize(int small)
 {
     smallSize = small;
 }
 
 /*!
   Returns the size used for small icons.
 
   \sa setSmallIconSize() setIcon()
 */
 int AppLnk::smallIconSize()
 {
     return smallSize;
 }
 
 
 /*!
   Sets the size used for large icons to \a big pixels.
   Only affects AppLnk objects created after the call.
 
   \sa bigIconSize() setIcon()
 */
 void AppLnk::setBigIconSize(int big)
 {
     bigSize = big;
 }
 
 /*!
   Returns the size used for large icons.
 
   \sa setBigIconSize() setIcon()
 */
 int AppLnk::bigIconSize()
 {
     return bigSize;
 }
 
 
 /*!
   \fn QString AppLnk::name() const
 
   Returns the Name property. This is the user-visible name for the
   document or application, not the filename.
 
     See \link #files-and-links Files and Links\endlink.
 
   \sa setName()
 */
 /*!
     \fn QString AppLnk::exec() const
 
   Returns the Exec property. This is the name of the executable
   program associated with the AppLnk.
 
   \sa setExec()
 */
 /*!
     \fn QString AppLnk::rotation() const
 
   Returns the Rotation property. The value is 0, 90, 180 or 270
   degrees.
 */
 /*!
     \fn QString AppLnk::comment() const
 
   Returns the Comment property.
 
   \sa setComment()
 */
 /*!
     \fn QStringList AppLnk::mimeTypes() const
 
   Returns the MimeTypes property. This is the list of MIME types
   that the application can view or edit.
 */
 /*!
     \fn const QArray<int>& AppLnk::categories() const
 
   Returns the Categories property.
 
   See the CategoryWidget for more details.
 
   \sa setCategories()
 */
 
 const QArray<int>& AppLnk::categories() const
 {
     d->ensureCatArray();
     return d->mCat;
 }
 
 /*!
     \fn int AppLnk::id() const
 
   Returns the id of the AppLnk. If the AppLnk is not in an AppLnkSet,
   this value is 0, otherwise it is a value that is unique for the
   duration of the current process.
 
   \sa AppLnkSet::find()
 */
 
 /*!
   \fn bool AppLnk::isValid() const
 
   Returns TRUE if this AppLnk is valid; otherwise returns FALSE.
 */
+/*!
+  \fn bool AppLnk::fileKnown() const
+
+  If the with the AppLnk associated file is not equal to QString::null
+*/
+/*!
+  \fn bool AppLnk::linkFileKnown()const
+
+  The filename of the AppLnk
 
+*/
+/*!
+  \fn void AppLnk::setRotation( const QString& )
+
+  The default rotation of the associated application. This
+  function is included inline for binary compatible issues
+*/
 /*!
   Creates an invalid AppLnk.
 
   \sa isValid()
 */
 AppLnk::AppLnk()
 {
     mId = 0;
     d = new AppLnkPrivate();
 }
 
 /*!
   Loads \a file (e.g. \e app.desktop) as an AppLnk.
 
   \sa writeLink()
 */
 AppLnk::AppLnk( const QString &file )
 {
     QStringList sl;
     d = new AppLnkPrivate();
     if ( !file.isNull() ) {
         Config config( file, Config::File );
 
         if ( config.isValid() ) {
             config.setGroup( "Desktop Entry" );
 
             mName = config.readEntry( "Name", file );
             mExec = config.readEntry( "Exec" );
             mType = config.readEntry( "Type", QString::null );
             mIconFile = config.readEntry( "Icon", QString::null );
             mRotation = config.readEntry( "Rotation", "" );
             mComment = config.readEntry( "Comment", QString::null );
             // MIME types are case-insensitive.
             mMimeTypes = config.readListEntry( "MimeType", ';' );
             for (QStringList::Iterator it=mMimeTypes.begin(); it!=mMimeTypes.end(); ++it)
                 *it = (*it).lower();
             mMimeTypeIcons = config.readListEntry( "MimeTypeIcons", ';' );
             mLinkFile = file;
             mFile = config.readEntry("File", QString::null);
             if ( !mExec. isEmpty ( )) {
                 mFile = QString::null;
             }
             else if ( mFile[0] != '/' ) {
                 int slash = file.findRev('/');
                 if ( slash >= 0 ) {
                     mFile = file.left(slash) + '/' + mFile;
                 }
             }
             d->mCatList = config.readListEntry("Categories", ';');
             if ( d->mCatList[0].toInt() < -1 ) {
                 // numeric cats in file! convert to text
                 Categories cat( 0 );
                 cat.load( categoryFileName() );
                 d->mCat.resize( d->mCatList.count() );
                 int i;
                 QStringList::ConstIterator it;
                 for ( i = 0, it = d->mCatList.begin(); it != d->mCatList.end();
                       ++it, i++ ) {
                     bool number;
                     int id = (*it).toInt( &number );
                     if ( !number ) {
                         // convert from text
                         id = cat.id( "Document View", *it );
                         if ( id == 0 )
                             id = cat.addCategory( "Document View", *it );
                     }
                     d->mCat[i] = id;
                 }
                 d->updateCatListFromArray();
             }
         }
     }
     mId = 0;
 }
 
 AppLnk& AppLnk::operator=(const AppLnk &copy)
 {
     if ( this == &copy ) return *this;
     if ( mId )
         qWarning("Deleting AppLnk that is in an AppLnkSet");
     if ( d )
         delete d;
 
 
     mName = copy.mName;
 
     /* remove for Qtopia 3.0 -zecke */
     mPixmap = copy.mPixmap;
     mBigPixmap = copy.mBigPixmap;
 
     mExec = copy.mExec;
     mType = copy.mType;
     mRotation = copy.mRotation;
     mComment = copy.mComment;
     mFile = copy.mFile;
     mLinkFile = copy.mLinkFile;
     mIconFile = copy.mIconFile;
     mMimeTypes = copy.mMimeTypes;
     mMimeTypeIcons = copy.mMimeTypeIcons;
     mId = 0;
     d = new AppLnkPrivate();
     d->mCat = copy.d->mCat;
     d->mCatList = copy.d->mCatList;
     d->mPixmaps = copy.d->mPixmaps;
 
     return *this;
 }
 /*!
   protected internally to share code
   should I document that at all?
   I don't know the TT style for that
 */
 const QPixmap& AppLnk::pixmap( int pos, int size ) const {
     if ( d->mPixmaps[pos].isNull() ) {
         AppLnk* that = (AppLnk*)this;
         if ( mIconFile.isEmpty() ) {
             MimeType mt(type());
             that->d->mPixmaps[pos] = mt.pixmap();
             if ( that->d->mPixmaps[pos].isNull() )
                 that->d->mPixmaps[pos].convertFromImage(
                     Resource::loadImage("UnknownDocument")
                         .smoothScale( size, size ) );
             return that->d->mPixmaps[pos];
         }
         QImage unscaledIcon = Resource::loadImage( that->mIconFile );
         if ( unscaledIcon.isNull() ) {
             qDebug( "Cannot find icon: %s", that->mIconFile.latin1() );
             that->d->mPixmaps[pos].convertFromImage(