kopetelistviewitem.h

Go to the documentation of this file.

/*
    kopetelistviewitem.h - Kopete's modular QListViewItems

    Copyright (c) 2005      by Engin AYDOGAN          <engin@bzzzt.biz>
    Copyright (c) 2004      by Richard Smith          <kde@metafoo.co.uk>

    Kopete    (c) 2002-2004 by the Kopete developers  <kopete-devel@kde.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.                                   *
    *                                                                       *
    *************************************************************************
*/

#ifndef KOPETE_LISTVIEWITEM_H
#define KOPETE_LISTVIEWITEM_H

#include <k3listview.h>
#include <kopetecontact.h>
#include <kopete_export.h>

#include <utility>

#include <QtGui/QPixmap>

namespace Kopete {
namespace UI {
namespace ListView {

class Component;

class KOPETE_EXPORT ComponentBase
{
public:
    ComponentBase();
    virtual ~ComponentBase() = 0;

    uint components();
    Component *component( uint n );
    Component *componentAt( const QPoint &pt );

    virtual void repaint() = 0;
    virtual void relayout() = 0;

    virtual std::pair<QString,QRect> toolTip( const QPoint &relativePos );

protected:
    virtual void componentAdded( Component *component );
    virtual void componentRemoved( Component *component );
    virtual void componentResized( Component *component );
    virtual void clear();

    void updateAnimationPosition( int p, int s );
private:
    class Private;
    Private * const d;

    // calls componentAdded and componentRemoved
    friend class Component;
};

class KOPETE_EXPORT ToolTipSource
{
public:
    virtual ~ToolTipSource(){}
    virtual QString operator() ( ComponentBase *component, const QPoint &pt, QRect &rect ) = 0;
};

class KOPETE_EXPORT Component : public ComponentBase
{
protected:
    Component( ComponentBase *parent );
public:
    virtual ~Component() = 0;

    virtual void layout( const QRect &rect );

    virtual void paint( QPainter *painter, const QPalette &pal );

    void repaint();
    void relayout();

    QRect rect();
    void hide();

    void show();

    bool isShown();
    bool isHidden();

    int minWidth();
    int minHeight();

    virtual int widthForHeight( int height );
    virtual int heightForWidth( int width );

    void setToolTipSource( ToolTipSource *source = 0 );

    std::pair<QString,QRect> toolTip( const QPoint &relativePos );

    enum RttiValues {
        Rtti_Component, Rtti_BoxComponent, Rtti_TextComponent,
        Rtti_ImageComponent, Rtti_DisplayNameComponent,
        Rtti_HSpacerComponent, Rtti_VSpacerComponent
    };

    static int RTTI;
    virtual int rtti() const { return RTTI; }
protected:
    bool setMinWidth( int width );
    bool setMinHeight( int height );

    void componentAdded( Component *component );
    void componentRemoved( Component *component );

private:
    // calls the three functions below
    friend void ComponentBase::updateAnimationPosition( int p, int s );

    // used for animation
    void setRect( const QRect &rect );
    QRect startRect();
    QRect targetRect();

    class Private;
    Private * const d;
};

class KOPETE_EXPORT BoxComponent : public Component
{
public:
    enum Direction { Horizontal, Vertical };
    explicit BoxComponent( ComponentBase *parent, Direction dir = Horizontal );
    ~BoxComponent();

    void layout( const QRect &rect );

    virtual int widthForHeight( int height );
    virtual int heightForWidth( int width );

    static int RTTI;
    virtual int rtti() const { return RTTI; }

protected:
    void componentAdded( Component *component );
    void componentRemoved( Component *component );
    void componentResized( Component *component );

private:
    void calcMinSize();

    class Private;
    Private * const d;
};

class KOPETE_EXPORT TextComponent : public Component
{
public:
    explicit TextComponent( ComponentBase *parent, const QFont &font = QFont(), const QString &text = QString() );
    ~TextComponent();

    QString text();
    void setText( const QString &text );

    QFont font();
    void setFont( const QFont &font );

    QColor color();
    void setColor( const QColor &color );
    void setDefaultColor();

    int widthForHeight( int );

    void paint( QPainter *painter, const QPalette &pal );

    static int RTTI;
    virtual int rtti() const { return RTTI; }

private:
    void calcMinSize();

    class Private;
    Private * const d;
};

class KOPETE_EXPORT ImageComponent : public Component
{
public:
    explicit ImageComponent( ComponentBase *parent );
    ImageComponent( ComponentBase *parent, int minW, int minH );
    ~ImageComponent();

    void setPixmap( const QPixmap &img, bool adjustSize = true);
    QPixmap pixmap( void );

    void paint( QPainter *painter, const QPalette &pal );

    void scale( int w, int h, Qt::AspectRatioMode );
    static int RTTI;
    virtual int rtti() const { return RTTI; }
private:
    class Private;
    Private * const d;
};

class KOPETE_EXPORT ContactComponent : public ImageComponent
{
public:
    ContactComponent( ComponentBase *parent, Kopete::Contact *contact, int iconSize);
    ~ContactComponent();
    void updatePixmap();
    Kopete::Contact *contact();
    std::pair<QString,QRect> toolTip( const QPoint &relativePos );
protected:
    class Private;
    Private * const d;
};

class KOPETE_EXPORT SpacerComponent : public Component
{
public:
    SpacerComponent( ComponentBase *parent, int w, int h );
};

class KOPETE_EXPORT DisplayNameComponent : public BoxComponent
{
public:
    explicit DisplayNameComponent( ComponentBase *parent );

    ~DisplayNameComponent();
    void layout( const QRect& rect );

    QString text();
    void setText( const QString& text );
    void setFont( const QFont& font );
    void setColor( const QColor& color );
    void setDefaultColor();
    static int RTTI;
    virtual int rtti() const { return RTTI; }
    void redraw();

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

class KOPETE_EXPORT HSpacerComponent : public Component
{
public:
    explicit HSpacerComponent( ComponentBase *parent );
    int widthForHeight( int );

    static int RTTI;
    virtual int rtti() const { return RTTI; }
};

class KOPETE_EXPORT VSpacerComponent : public Component
{
public:
    explicit VSpacerComponent( ComponentBase *parent );
    int heightForWidth( int );

    static int RTTI;
    virtual int rtti() const { return RTTI; }
};

class KOPETE_EXPORT Item : public QObject, public K3ListViewItem, public ComponentBase
{
    Q_OBJECT
public:
    explicit Item( Q3ListView *parent, QObject *owner = 0 );
    explicit Item( Q3ListViewItem *parent, QObject *owner = 0 );
    ~Item();

    void repaint();
    void relayout();

    void setup();
    virtual void paintCell( QPainter *p, const QColorGroup &cg, int column, int width, int align );
    //TODO: startRename(...)

    float opacity();
    void setOpacity( float alpha );

    bool targetVisibility();
    void setTargetVisibility( bool vis );

    static void setEffects( bool animation, bool fading, bool folding );

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

    virtual void setSearchMatch( bool match, bool searching );

protected:
    void componentAdded( Component *component );
    void componentRemoved( Component *component );
    void componentResized( Component *component );

    void setHeight( int );
    
signals:
    void visibilityChanged (bool visibility);

private:
    void initLVI(QObject* parent);
    void recalcHeight();
    void scheduleLayout();
    void mySetVisible ( bool b );

private slots:
    void slotColumnResized();
    void slotLayoutItems();
    void slotLayoutAnimateItems();
    void slotUpdateVisibility();

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

} // END namespace ListView
} // END namespace UI
} // END namespace Kopete

#endif

// vim: set noet ts=4 sts=4 sw=4: