columnsview.h

Go to the documentation of this file.

/*
    This file is part of the Okteta Gui library, made within the KDE community.

    Copyright 2003,2007-2009 Friedrich W. H. Kossebau <kossebau@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) version 3, or any
    later version accepted by the membership of KDE e.V. (or its
    successor approved by the membership of KDE e.V.), which shall
    act as a proxy defined in Section 6 of version 3 of the license.

    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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef OKTETA_COLUMNSVIEW_H
#define OKTETA_COLUMNSVIEW_H

// lib
#include "oktetagui_export.h"
#include "kadds.h"
#include "linerange.h"
// Qt
#include <QtCore/QList>
#include <QtGui/QAbstractScrollArea>


namespace Okteta
{

class AbstractColumnRenderer;
class ColumnsViewPrivate;

class OKTETAGUI_EXPORT ColumnsView : public QAbstractScrollArea
{
   Q_OBJECT

  public:
    explicit ColumnsView( /*bool R = false,*/ QWidget* parent = 0 );
    virtual ~ColumnsView();

  public: // data-wise sizes
    LineSize noOfLines() const;
    LineSize noOfLinesPerPage() const;

  public: // pixel-wise sizes
    PixelY lineHeight() const;
    PixelX columnsWidth() const;
    PixelY columnsHeight() const;

  public: // services
    Line lineAt( PixelY y ) const;
    LineRange visibleLines() const;
    LineRange visibleLines( const PixelYRange& yPixels ) const;

    PixelX visibleWidth() const;
    PixelY visibleHeight() const;
    PixelX xOffset() const;
    PixelY yOffset() const;

    PixelY yOffsetOfLine( Line lineIndex ) const;

    QPoint viewportToColumns( const QPoint& point ) const;

  public:
    void setColumnsPos( PixelX x, PixelY y );

  protected: // QAbstractScrollArea API
    virtual bool event( QEvent* event );
    virtual void resizeEvent( QResizeEvent* event );
    virtual void paintEvent( QPaintEvent* paintEvent );
    virtual void scrollContentsBy( int dx, int dy );

  protected: // our API
    virtual void renderColumns( QPainter* painter, int cx, int cy, int cw, int ch );
    virtual void renderEmptyArea( QPainter* painter, int cx, int cy, int cw, int ch );

  protected: //
    virtual void setLineHeight( PixelY lineHeight );
    virtual void setNoOfLines( LineSize noOfLines );

  protected:
    void addColumn( AbstractColumnRenderer* columnRenderer );
    void removeColumn( AbstractColumnRenderer* columnRenderer );

  protected: // recalculations
    void updateWidths();
    void updateScrollBars();
    void updateColumn( AbstractColumnRenderer& columnRenderer );
    void updateColumn( AbstractColumnRenderer& columnRenderer, const LineRange& lines );

  private:
    ColumnsViewPrivate* const d;
};

}

#endif