diff options
Diffstat (limited to 'kdecore/kmimesourcefactory.h')
-rw-r--r-- | kdecore/kmimesourcefactory.h | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/kdecore/kmimesourcefactory.h b/kdecore/kmimesourcefactory.h new file mode 100644 index 000000000..ec73621a7 --- /dev/null +++ b/kdecore/kmimesourcefactory.h @@ -0,0 +1,85 @@ +/* + This file is part of the KDE libraries + Copyright (c) 1999 Preston Brown <pbrown@kde.org> + Copyright (C) 1997 Matthias Kalle Dalheimer <kalle@kde.org> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. +*/ + +#ifndef KMIMESOURCEFACTORY_H +#define KMIMESOURCEFACTORY_H + +#include <qmime.h> +#include <kglobal.h> + +class KMimeSourceFactoryPrivate; +class KInstance; + +/** + * An extension to QMimeSourceFactory that uses KIconLoader to + * find images. + * + * Normally you don't have to instantiate this class at all, KApplication does that for + * you automagically and sets QMimeSourceFactory::setDefaultFactory(). + * + * @author Peter Putzer <putzer@kde.org> + */ +class KDECORE_EXPORT KMimeSourceFactory : public QMimeSourceFactory +{ +public: + + /** + * Constructor. + * + * @param loader is the iconloader used to find images. + */ + KMimeSourceFactory (KIconLoader* loader = KGlobal::iconLoader()); + + /** + * Destructor. + */ + virtual ~KMimeSourceFactory(); + + /** + * This function is maps an absolute or relative name for a resource to + * the absolute one. + * + * To load an icon, prepend the @p category name before the @p icon name, in the style + * of \<category>|\<icon>. + * + * Example: + * \code "<img src=\"user|ksysv_start\"/>", "<img src="\desktop|trash\">", ... + * \endcode + * + * @param abs_or_rel_name is the absolute or relative pathname. + * @param context is the path of the context object for the queried resource. Almost always empty. + */ + virtual QString makeAbsolute (const QString& abs_or_rel_name, const QString& context) const; + +protected: + virtual void virtual_hook( int id, void* data ); +private: + /** + * @internal + * Associate with a KInstance so we can pull its iconLoader() when need arises. + */ + friend class KInstance; + void setInstance(KInstance *); + + KMimeSourceFactoryPrivate* d; +}; + +#endif // KMIMESOURCEFACTORY_H |