| -rw-r--r-- | library/mimetype.cpp | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/library/mimetype.cpp b/library/mimetype.cpp index ef5d619..d0a578e 100644 --- a/library/mimetype.cpp +++ b/library/mimetype.cpp @@ -131,4 +131,22 @@ MimeType::Private& MimeType::data() } +/*! + \class MimeType mimetype.h + \brief The MimeType class provides MIME type information. + + A MimeType object is a light-weight value which + provides information about a MIME type. + + \ingroup qtopiaemb +*/ + +/*! + Constructs a MimeType. + Normally, \a ext_or_id is a MIME type, + but if \a ext_or_id starts with / or contains no /, + it is interpretted as a filename and the + extension (eg. .txt) is used as the + MIME type. +*/ MimeType::MimeType( const QString& ext_or_id ) { @@ -136,4 +154,7 @@ MimeType::MimeType( const QString& ext_or_id ) } +/*! + Constructs a MimeType from the type() of \a lnk. +*/ MimeType::MimeType( const DocLnk& lnk ) { @@ -141,4 +162,7 @@ MimeType::MimeType( const DocLnk& lnk ) } +/*! + Returns the MIME type identifier. +*/ QString MimeType::id() const { @@ -146,4 +170,8 @@ QString MimeType::id() const } +/*! + Returns a description of the MIME Type. This is usually based + on the application() associated with the type. +*/ QString MimeType::description() const { @@ -152,4 +180,7 @@ QString MimeType::description() const } +/*! + Returns a small QPixmap appropriate for the MIME type. +*/ QPixmap MimeType::pixmap() const { @@ -158,4 +189,8 @@ QPixmap MimeType::pixmap() const } +/*! + \internal + This function is not generally available. +*/ QString MimeType::extension() const { @@ -163,4 +198,9 @@ QString MimeType::extension() const } + +/*! + \internal + This function is not generally available. +*/ QStringList MimeType::extensions() const { @@ -169,4 +209,7 @@ QStringList MimeType::extensions() const } +/*! + Returns a larger QPixmap appropriate for the MIME type. +*/ QPixmap MimeType::bigPixmap() const { @@ -175,4 +218,13 @@ QPixmap MimeType::bigPixmap() const } +/*! + Returns the AppLnk defining the application associated + with this MIME type, or 0 if none is associated. + + The caller must not retain the pointer, + but of course you can dereference it to take a copy if needed. + + \sa Service::binding() +*/ const AppLnk* MimeType::application() const { @@ -190,4 +242,7 @@ static QString serviceBinding(const QString& service) } +/*! + \internal +*/ void MimeType::registerApp( const AppLnk& lnk ) { @@ -214,4 +269,7 @@ void MimeType::registerApp( const AppLnk& lnk ) } +/*! + \internal +*/ void MimeType::clear() { @@ -287,4 +345,7 @@ MimeTypeData* MimeType::data(const QString& id) } +/*! + Returns a Qtopia folder containing application definitions. +*/ QString MimeType::appsFolderName() { @@ -292,4 +353,7 @@ QString MimeType::appsFolderName() } +/*! + Reloads application definitions. +*/ void MimeType::updateApplications() { |