src/dolphinstatusbar.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz                                      *
   3  *   peter.penz@gmx.at                                                     *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program 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         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  19  ***************************************************************************/
  20
  21 #ifndef DOLPHINSTATUSBAR_H
  22 #define DOLPHINSTATUSBAR_H
  23
  24 #include <khbox.h>
  25
  26 class DolphinView;
  27 class KUrl;
  28 class StatusBarMessageLabel;
  29 class StatusBarSpaceInfo;
  30 class QProgressBar;
  31 class QLabel;
  32
  33 /**
  34  * @brief Represents the statusbar of a Dolphin view.
  35  *
  36  * The statusbar allows to show messages and progress
  37  * information.
  38  */
  39 class DolphinStatusBar : public KHBox
  40 {
  41     Q_OBJECT
  42
  43 public:
  44     /**
  45      * Describes the type of the message text. Dependent
  46      * from the type a corresponding icon and color is
  47      * used for the message text.
  48      */
  49     enum Type {
  50         Default,
  51         OperationCompleted,
  52         Information,
  53         Error
  54     };
  55
  56     DolphinStatusBar(QWidget* parent,
  57                      const KUrl& url);
  58
  59     virtual ~DolphinStatusBar();
  60
  61     /**
  62      * Sets the message text to \a msg. Dependant
  63      * from the given type \a type an icon is shown and
  64      * the color of the text is adjusted. The height of
  65      * the statusbar is automatically adjusted in a way,
  66      * that the full text fits into the available width.
  67      *
  68      * If a progress is ongoing and a message
  69      * with the type Type::Error is set, the progress
  70      * is cleared automatically.
  71      */
  72     void setMessage(const QString& msg, Type type);
  73     QString message() const;
  74
  75     Type type() const;
  76
  77     /**
  78      * Sets the text for the progress information.
  79      * The text is shown with a delay of 300 milliseconds:
  80      * if the progress set by DolphinStatusBar::setProgress()
  81      * does reach 100 % within 300 milliseconds,
  82      * the progress text is not shown at all. This assures that
  83      * no flickering occurs for showing a progress of fast
  84      * operations.
  85      */
  86     void setProgressText(const QString& text);
  87     QString progressText() const;
  88
  89     /**
  90      * Sets the progress in percent (0 - 100). The
  91      * progress is shown with a delay of 300 milliseconds:
  92      * if the progress does reach 100 % within 300 milliseconds,
  93      * the progress is not shown at all. This assures that
  94      * no flickering occurs for showing a progress of fast
  95      * operations.
  96      */
  97     void setProgress(int percent);
  98     int progress() const
  99     {
 100         return m_progress;
 101     }
 102
 103     /**
 104      * Clears the message text of the status bar by replacing
 105      * the message with the default text, which can be set
 106      * by DolphinStatusBar::setDefaultText(). The progress
 107      * information is not cleared.
 108      */
 109     void clear();
 110
 111     /**
 112      * Sets the default text, which is shown if the status bar
 113      * is cleared by DolphinStatusBar::clear().
 114      */
 115     void setDefaultText(const QString& text);
 116     const QString& defaultText() const;
 117
 118 protected:
 119     /** @see QWidget::resizeEvent() */
 120     virtual void resizeEvent(QResizeEvent* event);
 121
 122 private slots:
 123     void updateProgressInfo();
 124
 125     /**
 126      * Is invoked, when the URL of the DolphinView, where the
 127      * statusbar belongs too, has been changed. The space information
 128      * content is updated.
 129      */
 130     void updateSpaceInfoContent(const KUrl& url);
 131
 132     /**
 133      * Shows the space information if there is enough room to show it
 134      * without the need to clip the status bar text. If the progress
 135      * bar is shown, the space information won't be shown.
 136      */
 137     void showSpaceInfo();
 138
 139 private:
 140     StatusBarMessageLabel* m_messageLabel;
 141     StatusBarSpaceInfo* m_spaceInfo;
 142
 143     QLabel* m_progressText;
 144     QProgressBar* m_progressBar;
 145     int m_progress;
 146 };
 147
 148 #endif