/*************************************************************************** kcolumn.h - description ------------------- begin : Mit Mai 21 2003 copyright : (C) 2003 by Friedrich W. H. Kossebau email : Friedrich.W.H@Kossebau.de ***************************************************************************/ /*************************************************************************** * * * This library is free software; you can redistribute it and/or * * modify it under the terms of the GNU Library General Public * * License version 2 as published by the Free Software Foundation. * * * ***************************************************************************/ #ifndef KHE_KCOLUMN_H #define KHE_KCOLUMN_H // lib specific #include "kadds.h" #include "ksection.h" class QPainter; namespace KHE { class KColumnsView; /** base class for columns of the KColumnsView * * *@author Friedrich W. H. Kossebau */ class KColumn { // friend class KColumnsView; public: KColumn( KColumnsView *V ); virtual ~KColumn() {} public: // API to be reimplemented in the subclasses /** Before an update of the columns view each column that intersects with the area to be painted * will be called with this function. As often multiple lines of a column are affected * for each lines the same values (like first and last char positions) might be calculated. * This function enables a one-time-calculation for such data that must be stored in some * class members, though. * @param P painter variable * @param cx * @param cw * @param FirstLine no of the first of the range of lines to paint */ virtual void paintFirstLine( TQPainter *P, KPixelXs Xs, int FirstLine ); /** the actual painting call for a column's line. * The default implementation simply paints the background */ virtual void paintNextLine( TQPainter *P ); /** */ virtual void paintEmptyColumn( TQPainter *P, KPixelXs Xs, KPixelYs Ys ); public: // modification access /** sets starting point of the column */ void setX( KPixelX NewX ); /** sets visibily */ void setVisible( bool V ); /** buffer actual line height in column */ void setLineHeight( KPixelY H ); public: // value access /** left offset x in pixel */ KPixelX x() const; /** total width in pixel */ KPixelX width() const; /** right offset x in pixel */ KPixelX rightX() const; /** should Column be displayed? */ bool isVisible() const; /** convinience: returns width if visible else 0 */ KPixelX visibleWidth() const; public: // functional logic /** true if column overlaps with pixels between x-positions x1, x2 */ bool overlaps( KPixelXs Xs ) const; protected: /** sets width of the column */ void setWidth( KPixelX W ); /** */ void paintBlankLine( TQPainter *P ) const; protected: // general column data /** pointer to the view */ KColumnsView *View; /** should Column be displayed? */ bool Visible; /** buffered value */ KPixelY LineHeight; /** left offset x in pixel */ KPixelXs XSpan; }; inline KPixelX KColumn::x() const { return XSpan.start(); } inline KPixelX KColumn::rightX() const { return XSpan.end(); } inline KPixelX KColumn::width() const { return XSpan.width(); } inline bool KColumn::isVisible() const { return Visible; } inline KPixelX KColumn::visibleWidth() const { return Visible ? XSpan.width(): 0; } inline void KColumn::setX( KPixelX NewX ) { XSpan.moveToStart( NewX ); } inline void KColumn::setWidth( KPixelX W ) { XSpan.setEndByWidth( W ); } inline void KColumn::setVisible( bool V ) { Visible = V; } inline void KColumn::setLineHeight( KPixelY H ) { LineHeight = H; } inline bool KColumn::overlaps( KPixelXs Xs ) const { return XSpan.overlaps(Xs); } } #endif