apps/lib/konq/konq_popupmenuinformation.h

   1 /* This file is part of the KDE project
   2    Copyright 2008 David Faure <faure@kde.org>
   3
   4    This library is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU Library General Public License as published
   6    by the Free Software Foundation; either version 2 of the License or
   7    ( at your option ) version 3 or, at the discretion of KDE e.V.
   8    ( which shall act as a proxy as in section 14 of the GPLv3 ), any later version.
   9
  10    This library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Library General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public License
  16    along with this library; see the file COPYING.LIB.  If not, write to
  17    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18    Boston, MA 02110-1301, USA.
  19 */
  20
  21 #ifndef KONQ_POPUPMENUINFORMATION_H
  22 #define KONQ_POPUPMENUINFORMATION_H
  23
  24 #include "konq_fileitemcapabilities.h"
  25 #include <kurl.h>
  26
  27 class KonqPopupMenuInformationPrivate;
  28 class KFileItemList;
  29 class QWidget;
  30
  31 /**
  32  * Holds the information about the items shown by KonqPopupMenu.
  33  * This information is used by KonqMenuActions to insert the appropriate
  34  * actions (for user-defined services and for associated applications),
  35  * and by KonqPopupMenuPlugin for plugins to decide what to show.
  36  *
  37  * KonqPopupMenuInformation is implicitly shared, i.e. it can be used as a value and copied around at almost no cost.
  38  */
  39 class LIBKONQ_EXPORT KonqPopupMenuInformation
  40 {
  41 public:
  42     /**
  43      * Constructor
  44      */
  45     KonqPopupMenuInformation();
  46
  47     /**
  48      * Copy constructor
  49      */
  50     KonqPopupMenuInformation(const KonqPopupMenuInformation&);
  51
  52     /**
  53      * Destructor
  54      */
  55     ~KonqPopupMenuInformation();
  56
  57     KonqPopupMenuInformation & operator=(const KonqPopupMenuInformation& o);
  58
  59     /**
  60      * Sets the list of fileitems which the actions apply to.
  61      */
  62     void setItems(const KFileItemList& items);
  63
  64     /**
  65      * List of fileitems
  66      */
  67     KFileItemList items() const;
  68
  69     /**
  70      * List of urls, gathered from the fileitems
  71      */
  72     KUrl::List urlList() const;
  73
  74     /**
  75      * Returns the capabilities of the items.
  76      * For instance, if they are readonly, then no action should modify those files.
  77      */
  78     KonqFileItemCapabilities capabilities() const;
  79
  80     /**
  81      * @return true if all items are directories
  82      */
  83     bool isDirectory() const;
  84
  85     /**
  86      * @return the mimetype of all items, if they all have the same, otherwise empty
  87      */
  88     QString mimeType() const;
  89
  90     /**
  91      * @return the mimetype group (e.g. "text") of all items, if they all have the same, otherwise empty
  92      */
  93     QString mimeGroup() const;
  94
  95     /**
  96      * Call this to set a parent widget (e.g. for error message boxes)
  97      */
  98     void setParentWidget(QWidget* parentWidget);
  99
 100     /**
 101      * Parent widget (e.g. for error message boxes)
 102      */
 103     QWidget* parentWidget() const;
 104
 105 private:
 106     QSharedDataPointer<KonqPopupMenuInformationPrivate> d;
 107 };
 108
 109 #endif /* KONQ_POPUPMENUINFORMATION_H */
 110