kurllabel.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 1998 Kurt Granroth <granroth@kde.org>
   Copyright (C) 2000 Peter Putzer <putzer@kde.org>
   Copyright (C) 2005 Jarosław Staniek <staniek@kde.org>

   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.

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

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KURLLABEL_H
#define KURLLABEL_H

#include <kdeui_export.h>

#include <QtGui/QColor>
#include <QtGui/QLabel>
#include <QtGui/QPixmap>

class QCursor;

class KDEUI_EXPORT KUrlLabel : public QLabel
{
  Q_OBJECT
  Q_PROPERTY(QString url READ url WRITE setUrl)
  Q_PROPERTY(QString tipText READ tipText WRITE setTipText )
  Q_PROPERTY(QPixmap alternatePixmap READ alternatePixmap WRITE setAlternatePixmap )
  Q_PROPERTY(bool glowEnabled READ isGlowEnabled WRITE setGlowEnabled )
  Q_PROPERTY(bool floatEnabled READ isFloatEnabled WRITE setFloatEnabled )
  Q_PROPERTY(bool useTips READ useTips WRITE setUseTips )
  Q_PROPERTY(bool useCursor READ useCursor WRITE setUseCursor )

  public:
    explicit KUrlLabel( QWidget* parent = 0L );

    explicit KUrlLabel( const QString& url, const QString& text = QString(),
               QWidget* parent = 0L );

    virtual ~KUrlLabel();

    QString url() const;

    QString tipText() const;

    bool useTips() const;

    bool useCursor() const;

    bool isGlowEnabled() const;

    bool isFloatEnabled() const;

    const QPixmap* alternatePixmap() const;

  public Q_SLOTS:
    void setUnderline( bool on = true );

    void setUrl( const QString& url );

    virtual void setFont( const QFont &font );

    void setUseTips ( bool on = true );

    void setTipText( const QString& tip );

    void setHighlightedColor( const QColor& highcolor );

    void setHighlightedColor( const QString& highcolor );

    void setSelectedColor( const QColor& color );

    void setSelectedColor( const QString& color );

    void setUseCursor( bool on, QCursor* cursor = 0L );

    void setGlowEnabled( bool glow = true );

    void setFloatEnabled( bool do_float = true );

    void setAlternatePixmap( const QPixmap& pixmap );

  Q_SIGNALS:

    void enteredUrl( const QString& url );

    void enteredUrl();

    void leftUrl( const QString& url );

    void leftUrl();

    void leftClickedUrl( const QString& url );

    void leftClickedUrl();

    void rightClickedUrl( const QString& url );

    void rightClickedUrl();

    void middleClickedUrl( const QString& url );

    void middleClickedUrl();

  protected:
    virtual void mouseReleaseEvent( QMouseEvent* );

    virtual void enterEvent( QEvent* );

    virtual void leaveEvent( QEvent* );

    virtual bool event( QEvent* );

  private:
    class Private;
    Private* const d;

    Q_PRIVATE_SLOT( d, void updateColor() )
};

#endif