diff options
Diffstat (limited to 'kdecore/kpixmapprovider.h')
-rw-r--r-- | kdecore/kpixmapprovider.h | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/kdecore/kpixmapprovider.h b/kdecore/kpixmapprovider.h new file mode 100644 index 000000000..fb7ac7d0a --- /dev/null +++ b/kdecore/kpixmapprovider.h @@ -0,0 +1,55 @@ +/* This file is part of the KDE libraries + + Copyright (c) 2000 Carsten Pfeiffer <pfeiffer@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 (LGPL) 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 KPIXMAPPROVIDER_H +#define KPIXMAPPROVIDER_H + +#include <qpixmap.h> +#include "kdelibs_export.h" + +/** + * A tiny abstract class with just one method: + * pixmapFor() + * + * It will be called whenever an icon is searched for @p text. + * + * Used e.g. by KHistoryCombo + * + * @author Carsten Pfeiffer <pfeiffer@kde.org> + * @short an abstract interface for looking up icons + */ +class KDECORE_EXPORT KPixmapProvider +{ +public: + virtual ~KPixmapProvider(); + /** + * You may subclass this and return a pixmap of size @p size for @p text. + * @param text the text that is associated with the pixmap + * @param size the size of the icon in pixels, 0 for defaylt size. + * See KIcon::StdSize. + * @return the pixmap for the arguments, or null if there is none + */ + virtual QPixmap pixmapFor( const QString& text, int size = 0 ) = 0; +protected: + virtual void virtual_hook( int id, void* data ); +}; + + +#endif // KPIXMAPPROVIDER_H |