krecentfilesaction.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 1999 Reginald Stadlbauer <reggie@kde.org>
              (C) 1999 Simon Hausmann <hausmann@kde.org>
              (C) 2000 Nicolas Hadacek <haadcek@kde.org>
              (C) 2000 Kurt Granroth <granroth@kde.org>
              (C) 2000 Michael Koch <koch@kde.org>
              (C) 2001 Holger Freyther <freyther@kde.org>
              (C) 2002 Ellis Whitehead <ellis@kde.org>
              (C) 2003 Andras Mantia <amantia@kde.org>
              (C) 2005-2006 Hamish Rodda <rodda@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 KRECENTFILESACTION_H
#define KRECENTFILESACTION_H

#include <kselectaction.h>
#include <kurl.h>

class KConfigGroup;
class KRecentFilesActionPrivate;

class KDEUI_EXPORT KRecentFilesAction : public KSelectAction
{
  Q_OBJECT
  Q_PROPERTY( int maxItems READ maxItems WRITE setMaxItems )
  Q_DECLARE_PRIVATE(KRecentFilesAction)

public:
    explicit KRecentFilesAction(QObject *parent);

    KRecentFilesAction(const QString &text, QObject *parent);

    KRecentFilesAction(const KIcon &icon, const QString &text, QObject *parent);

  virtual ~KRecentFilesAction();

  void addAction(QAction* action, const KUrl& url, const QString& name);

  virtual QAction* removeAction(QAction* action);

public Q_SLOTS:
  virtual void clear();

public:
  int maxItems() const;

  void setMaxItems( int maxItems );

  void loadEntries( const KConfigGroup &config );

  void saveEntries( const KConfigGroup &config );

  void addUrl( const KUrl& url, const QString& name = QString() );

  void removeUrl( const KUrl& url );

  KUrl::List urls() const;

Q_SIGNALS:
  void urlSelected( const KUrl& url );

  void recentListCleared();

private:
    //Internal
    void clearEntries();
    // Don't warn about the virtual overload. As the comment of the other
    // addAction() says, addAction( QAction* ) should not be used.
    using KSelectAction::addAction;
    
    Q_PRIVATE_SLOT( d_func(), void _k_urlSelected(QAction*) )
};

#endif