cardview.h

/*
    This file is part of KAddressBook.
    Copyright (c) 2002 Mike Pilone <mpilone@slac.com>
 
    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.
 
    This program 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 General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
    As a special exception, permission is given to link this program
    with any edition of TQt, and distribute the resulting executable,
    without including the source code for TQt in the source distribution.
*/
 
#ifndef CARDVIEW_H
#define CARDVIEW_H
 
#include <tqpair.h>
#include <tqpoint.h>
#include <tqptrlist.h>
#include <tqrect.h>
#include <tqscrollview.h>
#include <tqstring.h>
 
class TQLabel;
class TQMouseEvent;
class TQPainter;
class TQResizeEvent;
 
class CardView;
class CardViewItemPrivate;
class CardViewPrivate;
class CardViewTip;

class CardViewItem
{
  friend class CardView;
 
  public:
    typedef TQPair<TQString, TQString> Field;

    CardViewItem( CardView *parent, const TQString &caption = TQString() );
    virtual ~CardViewItem();

    const TQString &caption() const;

    void setCaption( const TQString &caption );

    virtual void paintCard( TQPainter *p, TQColorGroup &cg );

    virtual void repaintCard();

    void insertField( const TQString &label, const TQString &value );

    void removeField( const TQString &label );

    TQString fieldValue( const TQString &label ) const;

    void clearFields();

    CardViewItem *nextItem() const;

    bool isSelected() const;

    void showFullString( const TQPoint &pos, CardViewTip *tip );

    Field *fieldAt( const TQPoint &itempos ) const;
 
    CardView *cardView() const { return mView; };

    int height( bool allowCache = true ) const;
 
  protected:
    void setSelected( bool selected );
 
  private:
    void initialize();

    TQString trimString( const TQString &text, int width, TQFontMetrics &fm ) const;
 
    CardViewItemPrivate *d;
    CardView *mView;
};

class CardView : public TQScrollView
{
  friend class CardViewItem;
 
  TQ_OBJECT
  
 
  public:
    CardView( TQWidget *parent, const char *name );
    virtual ~CardView();

    void insertItem( CardViewItem *item );

    void takeItem( CardViewItem *item );

    void clear();

    CardViewItem *currentItem() const;

    void setCurrentItem( CardViewItem *item );

    CardViewItem *itemAt( const TQPoint &viewPos ) const;

    TQRect itemRect( const CardViewItem *item ) const;

    void ensureItemVisible( const CardViewItem *item );

    void repaintItem( const CardViewItem *item );
 
    enum SelectionMode { Single, Multi, Extended, NoSelection };

    void setSelectionMode( SelectionMode mode );

    SelectionMode selectionMode() const;

    void setSelected( CardViewItem *item, bool selected );

    void selectAll( bool state );

    bool isSelected( CardViewItem *item ) const;

    CardViewItem *selectedItem() const;

    CardViewItem *firstItem() const;

    CardViewItem *itemAfter( const CardViewItem *item ) const;

    int childCount() const;

    CardViewItem *findItem( const TQString &text, const TQString &label,
                            TQt::StringComparisonMode compare = TQt::BeginsWith ) const;

    uint columnWidth() const;

    void setDrawCardBorder( bool enabled );

    bool drawCardBorder() const;

    void setDrawColSeparators( bool enabled );

    bool drawColSeparators() const;

    void setDrawFieldLabels( bool enabled );

    bool drawFieldLabels() const;

    void setShowEmptyFields( bool show );

    bool showEmptyFields() const;

    // Note: I looked for a value in TQStyle::PixelMetric to use, but I could
    // not see a useful one. One may turn up in a future version of TQt.
    uint itemMargin() const;

    void setItemMargin( uint margin );

    // Note: There is no useful TQStyle::PixelMetric to use for this atm.
    // An option would be using KDialog::spacingHint().
    uint itemSpacing() const;

    void setItemSpacing( uint spacing );

    int itemWidth() const;

    void setItemWidth( int width );

    void setHeaderFont( const TQFont &fnt );

    TQFont headerFont() const;

    void setFont( const TQFont &fnt );

    void setSeparatorWidth( int width );

    int separatorWidth() const;

    void setMaxFieldLines( int howmany );

    int maxFieldLines() const;
 
  signals:
    void selectionChanged();

    void selectionChanged( CardViewItem* );

    void clicked( CardViewItem* );

    void executed( CardViewItem* );

    void doubleClicked( CardViewItem* );

    void currentChanged( CardViewItem* );

    void returnPressed( CardViewItem* );

    void contextMenuRequested( CardViewItem*, const TQPoint& );
 
  protected:
    void drawContents( TQPainter *p, int clipx, int clipy, int clipw, int cliph );

    void resizeEvent( TQResizeEvent* );

    void contentsWheelEvent( TQWheelEvent* );

    void setLayoutDirty( bool dirty );

    void calcLayout();
 
    virtual void contentsMousePressEvent( TQMouseEvent* );
    virtual void contentsMouseMoveEvent( TQMouseEvent* );
    virtual void contentsMouseReleaseEvent( TQMouseEvent* );
    virtual void contentsMouseDoubleClickEvent( TQMouseEvent* );
 
    virtual void enterEvent( TQEvent* );
    virtual void leaveEvent( TQEvent* );
 
    virtual void focusInEvent( TQFocusEvent* );
    virtual void focusOutEvent( TQFocusEvent* );
 
    virtual void keyPressEvent( TQKeyEvent* );

    virtual void startDrag();
 
  private slots:
    void tryShowFullText();
 
  private:
    void drawRubberBands( int pos );
 
    CardViewPrivate *d;
};
 
#endif