src/panels/information/informationpanel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006-2009 by Peter Penz <peter.penz@gmx.at>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef INFORMATIONPANEL_H
  21 #define INFORMATIONPANEL_H
  22
  23 #include <panels/panel.h>
  24
  25 class InformationPanelContent;
  26
  27 /**
  28  * @brief Panel for showing meta information of one ore more selected items.
  29  */
  30 class InformationPanel : public Panel
  31 {
  32     Q_OBJECT
  33
  34 public:
  35     explicit InformationPanel(QWidget* parent = 0);
  36     virtual ~InformationPanel();
  37
  38     /** @see QWidget::sizeHint() */
  39     virtual QSize sizeHint() const;
  40
  41 public slots:
  42     /** @see Panel::setUrl() */
  43     virtual void setUrl(const KUrl& url);
  44
  45     /**
  46      * This is invoked to inform the panel that the user has selected a new
  47      * set of items.
  48      */
  49     void setSelection(const KFileItemList& selection);
  50
  51     /**
  52      * Does a delayed request of information for the item \a item.
  53      * If within this delay InformationPanel::setUrl() or InformationPanel::setSelection()
  54      * are invoked, then the request will be skipped. Requesting a delayed item information
  55      * makes sense when hovering items.
  56      */
  57     void requestDelayedItemInfo(const KFileItem& item);
  58
  59 protected:
  60     /** @see QWidget::showEvent() */
  61     virtual void showEvent(QShowEvent* event);
  62
  63     /** @see QWidget::resizeEvent() */
  64     virtual void resizeEvent(QResizeEvent* event);
  65
  66     /** @see QWidget::contextMenuEvent() */
  67     virtual void contextMenuEvent(QContextMenuEvent* event);
  68
  69 private slots:
  70     /**
  71      * Shows the information for the item of the URL which has been provided by
  72      * InformationPanel::requestItemInfo() and provides default actions.
  73      */
  74     void showItemInfo();
  75
  76     /**
  77      * Triggered if the request for item information has timed out.
  78      * @see InformationPanel::requestDelayedItemInfo()
  79      */
  80     void slotInfoTimeout();
  81
  82     /**
  83      * Resets the information panel to show the current
  84      * URL (InformationPanel::url()). Is called by
  85      * DolphinInformationPanel::markUrlAsInvalid().
  86      */
  87     void reset();
  88
  89     void slotFileRenamed(const QString& source, const QString& dest);
  90     void slotFilesAdded(const QString& directory);
  91     void slotFilesChanged(const QStringList& files);
  92     void slotFilesRemoved(const QStringList& files);
  93     void slotEnteredDirectory(const QString& directory);
  94     void slotLeftDirectory(const QString& directory);
  95
  96 private:
  97     /** Assures that any pending item information request is cancelled. */
  98     void cancelRequest();
  99
 100     /**
 101      * Shows the meta information for the current shown item inside
 102      * a label.
 103      */
 104     void showMetaInfo();
 105
 106     /**
 107      * Returns true, if the meta information should be shown for
 108      * the multiple selected items that are stored in
 109      * m_selection. If true is returned, it is assured that
 110      * m_selection.count() > 1. If false is returned, the meta
 111      * information should be shown for the file
 112      * InformationPanel::fileUrl();
 113      */
 114     bool showMultipleSelectionInfo() const;
 115
 116     /**
 117      * Returns true, if \a url is equal to the shown URL m_shownUrl.
 118      */
 119     bool isEqualToShownUrl(const KUrl& url) const;
 120
 121     /**
 122      * Marks the URL as invalid and will reset the Information Panel
 123      * after a short delay. The reset is not done synchronously to
 124      * prevent expensive updates during temporary invalid URLs by
 125      * e. g. changing the directory.
 126      */
 127     void markUrlAsInvalid();
 128
 129     void init();
 130
 131 private:
 132     bool m_initialized;
 133     bool m_pendingPreview;
 134     QTimer* m_infoTimer;
 135     QTimer* m_urlChangedTimer;
 136     QTimer* m_resetUrlTimer;
 137
 138     // URL that is currently shown in the Information Panel.
 139     KUrl m_shownUrl;
 140
 141     // URL candidate that will replace m_shownURL after a delay.
 142     // Used to remember URLs when hovering items.
 143     KUrl m_urlCandidate;
 144
 145     // URL candidate that is marked as invalid (e. g. because the directory
 146     // has been deleted or the shown item has been renamed). The Information
 147     // Panel will be reset asynchronously to prevent unnecessary resets when
 148     // a directory has been changed.
 149     KUrl m_invalidUrlCandidate;
 150
 151     KFileItem m_fileItem; // file item for m_shownUrl if available (otherwise null)
 152     KFileItemList m_selection;
 153
 154     InformationPanelContent* m_content;
 155 };
 156
 157 #endif // INFORMATIONPANEL_H