listingextension.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2012 Dawit Alemayehu <adawit@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 KPARTS_LISTINGEXTENSION_H
#define KPARTS_LISTINGEXTENSION_H

#include <QtCore/QObject>

#include <kparts/kparts_export.h>


class KFileItemList;

namespace KParts
{

class ReadOnlyPart;

class KPARTS_EXPORT ListingFilterExtension : public QObject
{
    Q_OBJECT

public:
    enum FilterMode  {
        None = 0x00,
        MimeType = 0x01,        
        SubString = 0x02,       
        WildCard = 0x04         
    };

    Q_DECLARE_FLAGS(FilterModes, FilterMode)

    
    ListingFilterExtension(KParts::ReadOnlyPart* parent);

    virtual ~ListingFilterExtension();

    static ListingFilterExtension *childObject(QObject* obj);

    virtual FilterModes supportedFilterModes() const;

    virtual bool supportsMultipleFilters(FilterMode mode) const;

    virtual QVariant filter(FilterMode mode) const = 0;

    virtual void setFilter(FilterMode mode, const QVariant& filter) = 0;

private:
    class ListingFilterExtensionPrivate;
    ListingFilterExtension* const d;
};

class KPARTS_EXPORT ListingNotificationExtension : public QObject
{
    Q_OBJECT

public:
    enum NotificationEventType {
        None = 0x00,
        ItemsAdded = 0x01,      
        ItemsDeleted = 0x02     
    };

    Q_DECLARE_FLAGS(NotificationEventTypes, NotificationEventType)

    
    ListingNotificationExtension(KParts::ReadOnlyPart* parent);

    virtual ~ListingNotificationExtension();

    virtual NotificationEventTypes supportedNotificationEventTypes() const;

    static ListingNotificationExtension *childObject(QObject* obj);

Q_SIGNALS:
    void listingEvent(KParts::ListingNotificationExtension::NotificationEventType, const KFileItemList&);

private:
    class ListingNotificationExtensionPrivate;
    ListingNotificationExtension* const d;
};

}

Q_DECLARE_OPERATORS_FOR_FLAGS(KParts::ListingFilterExtension::FilterModes)
Q_DECLARE_OPERATORS_FOR_FLAGS(KParts::ListingNotificationExtension::NotificationEventTypes)

#endif /* KPARTS_LISTINGEXTENSION_H */