kcapacitybar.h

Go to the documentation of this file.

/*
 * This file is part of the KDE project
 * Copyright (C) 2008 Rafael Fernández López <ereslibre@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 KCAPACITYBAR_H
#define KCAPACITYBAR_H

#include <QtGui/QWidget>

#include <kdeui_export.h>

class QPaintEvent;

class KDEUI_EXPORT KCapacityBar
    : public QWidget
{
    Q_OBJECT

    Q_PROPERTY(int value READ value WRITE setValue)
    Q_PROPERTY(QString text READ text WRITE setText)
    Q_PROPERTY(DrawTextMode drawTextMode READ drawTextMode WRITE setDrawTextMode)
    Q_PROPERTY(bool fillFullBlocks READ fillFullBlocks WRITE setFillFullBlocks)
    Q_PROPERTY(bool continuous READ continuous WRITE setContinuous)
    Q_PROPERTY(int barHeight READ barHeight WRITE setBarHeight)
    Q_PROPERTY(Qt::Alignment horizontalTextAlignment READ horizontalTextAlignment
                                                     WRITE setHorizontalTextAlignment)
    Q_ENUMS(DrawTextMode)
    
public:
    enum DrawTextMode {
        DrawTextInline = 0,     
        DrawTextOutline         
    };

    explicit KCapacityBar(DrawTextMode drawTextMode = DrawTextOutline, QWidget *parent = 0);
    ~KCapacityBar();

    void setValue(int value);

    int value() const;

    void setText(const QString &text);

    QString text() const;

    void setFillFullBlocks(bool fillFullBlocks);

    bool fillFullBlocks() const;

    void setContinuous(bool continuous);

    bool continuous() const;

    void setBarHeight(int barHeight);

    int barHeight() const;

    void setHorizontalTextAlignment(Qt::Alignment textAlignment);

    Qt::Alignment horizontalTextAlignment() const;

    void setDrawTextMode(DrawTextMode mode);

    DrawTextMode drawTextMode() const;
    
    void drawCapacityBar(QPainter *p, const QRect &rect) const;

    // Reimplemented from QWidget
    virtual QSize minimumSizeHint() const;

protected:
    // Reimplemented from QWidget
    virtual void paintEvent(QPaintEvent *event);
    virtual void changeEvent(QEvent *event);

private:
    class Private;
    Private *const d;
};

#endif