libk3b-dev 2.0.2-7ubuntu1 / usr / include / k3blistview.h

/*
 *
 * Copyright (C) 2003 Sebastian Trueg <trueg@k3b.org>
 *
 * This file is part of the K3b project.
 * Copyright (C) 1998-2007 Sebastian Trueg <trueg@k3b.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file "COPYING" for the exact licensing terms.
 */


#ifndef K3BLISTVIEW_H
#define K3BLISTVIEW_H


#include <k3listview.h>
#include "k3b_export.h"
#include <qstringlist.h>
//Added by qt3to4:
#include <QPaintEvent>
#include <QResizeEvent>
#include <QPixmap>
#include <QEvent>

#include <kdemacros.h>

class QPainter;
class QPushButton;
class QResizeEvent;
class QComboBox;
class QSpinBox;
class QLineEdit;
class QEvent;
class QValidator;

namespace K3b {
    class MsfEdit;
    class ListView;

    /**
     * \deprecated
     */
    class KDE_DEPRECATED LIBK3B_EXPORT ListViewItem : public K3ListViewItem
    {
    public:
        ListViewItem(Q3ListView *parent);
        ListViewItem(Q3ListViewItem *parent);
        ListViewItem(Q3ListView *parent, Q3ListViewItem *after);
        ListViewItem(Q3ListViewItem *parent, Q3ListViewItem *after);

        ListViewItem(Q3ListView *parent,
                     const QString&, const QString& = QString(),
                     const QString& = QString(), const QString& = QString(),
                     const QString& = QString(), const QString& = QString(),
                     const QString& = QString(), const QString& = QString());

        ListViewItem(Q3ListViewItem *parent,
                     const QString&, const QString& = QString(),
                     const QString& = QString(), const QString& = QString(),
                     const QString& = QString(), const QString& = QString(),
                     const QString& = QString(), const QString& = QString());

        ListViewItem(Q3ListView *parent, Q3ListViewItem *after,
                     const QString&, const QString& = QString(),
                     const QString& = QString(), const QString& = QString(),
                     const QString& = QString(), const QString& = QString(),
                     const QString& = QString(), const QString& = QString());

        ListViewItem(Q3ListViewItem *parent, Q3ListViewItem *after,
                     const QString&, const QString& = QString(),
                     const QString& = QString(), const QString& = QString(),
                     const QString& = QString(), const QString& = QString(),
                     const QString& = QString(), const QString& = QString());

        virtual ~ListViewItem();

        /**
         * reimplemented from K3ListViewItem
         */
        void setup();

        virtual int width( const QFontMetrics& fm, const Q3ListView* lv, int c ) const;

        void setEditor( int col, int type, const QStringList& = QStringList() );
        void setButton( int col, bool );

        void setValidator( int col, QValidator* v );
        QValidator* validator( int col ) const;

        int editorType( int col ) const;
        bool needButton( int col ) const;
        const QStringList& comboStrings( int col ) const;

        enum EditorType { NONE, COMBO, LINE, SPIN, MSF };

        void setFont( int col, const QFont& f );
        void setBackgroundColor( int col, const QColor& );
        void setForegroundColor( int col, const QColor& );

        void setDisplayProgressBar( int col, bool );
        void setProgress( int, int );
        void setTotalSteps( int col, int steps );

        /**
         * The margin left and right of the cell
         */
        void setMarginHorizontal( int col, int margin );

        /**
         * The top and button margin of the cell
         */
        void setMarginVertical( int margin );

        int marginHorizontal( int col ) const;
        int marginVertical() const;

        /**
         * Do not reimplement this but paintK3bCell to use the margin and background stuff.
         */
        virtual void paintCell( QPainter* p, const QColorGroup& cg, int col, int width, int align );

        virtual void paintK3bCell( QPainter* p, const QColorGroup& cg, int col, int width, int align );

    private:
        void paintProgressBar( QPainter* p, const QColorGroup& cgh, int col, int width );

        class ColumnInfo;
        mutable ColumnInfo* m_columns;

        ColumnInfo* getColumnInfo( int ) const;
        void init();

        int m_vMargin;
    };


    /**
     * \deprecated
     */
    class KDE_DEPRECATED LIBK3B_EXPORT CheckListViewItem : public ListViewItem
    {
    public:
        CheckListViewItem(Q3ListView *parent);
        CheckListViewItem(Q3ListViewItem *parent);
        CheckListViewItem(Q3ListView *parent, Q3ListViewItem *after);
        CheckListViewItem(Q3ListViewItem *parent, Q3ListViewItem *after);

        virtual bool isChecked() const;
        virtual void setChecked( bool checked );

    protected:
        virtual void paintK3bCell( QPainter* p, const QColorGroup& cg, int col, int width, int align );

    private:
        bool m_checked;
    };


    /**
     * \deprecated
     */
    class LIBK3B_EXPORT ListView : public K3ListView
    {
        Q_OBJECT

    public:
        ListView (QWidget *parent = 0 );
        virtual ~ListView();

        virtual void setCurrentItem( Q3ListViewItem* );

        ListViewItem* currentlyEditedItem() const { return m_currentEditItem; }

        QWidget* editor( ListViewItem::EditorType ) const;

        enum BgPixPosition {
            TOP_LEFT,
            CENTER
        };

        /**
         * This will set a background pixmap which is not tiled.
         * @param pos position on the viewport.
         */
        void setK3bBackgroundPixmap( const QPixmap&, int pos = CENTER );

        /**
         * Searches for the first item above @p i which is one level higher.
         * For 1st level items this will always be the listview's root item.
         */
        static Q3ListViewItem* parentItem( Q3ListViewItem* i );

    Q_SIGNALS:
        void editorButtonClicked( K3b::ListViewItem*, int );

    public Q_SLOTS:
        void setNoItemText( const QString& );
        //  void setNoItemPixmap( const QPixmap& );
        void setNoItemVerticalMargin( int i ) { m_noItemVMargin = i; }
        void setNoItemHorizontalMargin( int i ) { m_noItemHMargin = i; }
        void setDoubleClickForEdit( bool b ) { m_doubleClickForEdit = b; }
        void hideEditor();
        void editItem( ListViewItem*, int );

        virtual void clear();

    private Q_SLOTS:
        void updateEditorSize();
        virtual void slotEditorLineEditReturnPressed();
        virtual void slotEditorComboBoxActivated( const QString& );
        virtual void slotEditorSpinBoxValueChanged( int );
        virtual void slotEditorMsfEditValueChanged( int );
        virtual void slotEditorButtonClicked();

    protected Q_SLOTS:
        void showEditor( K3b::ListViewItem*, int col );
        void placeEditor( K3b::ListViewItem*, int col );

        /**
         * This is called whenever one of the editor's contents changes
         * the default implementation just returnes true
         *
         * FIXME: should be called something like mayRename
         */
        virtual bool renameItem( K3b::ListViewItem*, int, const QString& );

        /**
         * default impl just emits signal
         * editorButtonClicked(...)
         */
        virtual void slotEditorButtonClicked( K3b::ListViewItem*, int );

    protected:
        /**
         * calls K3ListView::drawContentsOffset
         * and paints a the noItemText if no item is in the list
         */
        virtual void drawContentsOffset ( QPainter * p, int ox, int oy, int cx, int cy, int cw, int ch );
        virtual void resizeEvent( QResizeEvent* );
        virtual void paintEmptyArea( QPainter*, const QRect& rect );

        /**
         * Reimplemented for internal reasons.
         *
         * Further reimplementations should call this function or else some features may not work correctly.
         *
         * The API is unaffected.
         */
        virtual void viewportResizeEvent( QResizeEvent* );

        /**
         * Reimplemented for internal reasons.
         * Further reimplementations should call this function or else
         * some features may not work correctly.
         *
         * The API is unaffected.
         */
        virtual void viewportPaintEvent(QPaintEvent*);

        virtual bool eventFilter( QObject*, QEvent* );

        ListViewItem* currentEditItem() const { return m_currentEditItem; }
        int currentEditColumn() const { return m_currentEditColumn; }

    private:
        QWidget* prepareEditor( ListViewItem* item, int col );
        void prepareButton( ListViewItem* item, int col );
        bool doRename();

        QString m_noItemText;
        //  QPixmap m_noItemPixmap;
        int m_noItemVMargin;
        int m_noItemHMargin;

        ListViewItem* m_currentEditItem;
        int m_currentEditColumn;

        bool m_doubleClickForEdit;
        Q3ListViewItem* m_lastClickedItem;

        QPushButton* m_editorButton;
        QComboBox* m_editorComboBox;
        QSpinBox* m_editorSpinBox;
        QLineEdit* m_editorLineEdit;
        MsfEdit* m_editorMsfEdit;

        QPixmap m_backgroundPixmap;
        int m_backgroundPixmapPosition;

        class Private;
        Private* d;

        friend class ListViewItem;
    };
}


#endif