kpropertiesdialog.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
   Copyright (c) 1999, 2000 Preston Brown <pbrown@kde.org>
   Copyright (c) 2000 Simon Hausmann <hausmann@kde.org>
   Copyright (c) 2000 David Faure <faure@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 as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   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 KPROPERTIESDIALOG_H
#define KPROPERTIESDIALOG_H

#include <QtCore/QString>

#include <kdemacros.h>
#include <kurl.h>
#include <kfileitem.h>
#include <kpagedialog.h>

class KPropertiesDialogPlugin;

class KJob;
namespace KIO { class Job; }

class KIO_EXPORT KPropertiesDialog : public KPageDialog
{
  Q_OBJECT

public:

  static bool canDisplay( const KFileItemList& _items );

  explicit KPropertiesDialog( const KFileItem& item,
                              QWidget* parent = 0 );

  explicit KPropertiesDialog( const KFileItemList& _items,
                              QWidget *parent = 0 );

  explicit KPropertiesDialog( const KUrl& _url,
                              QWidget* parent = 0 );

  KPropertiesDialog( const KUrl& _tempUrl, const KUrl& _currentDir,
                     const QString& _defaultName,
                     QWidget* parent = 0 );

  explicit KPropertiesDialog(const QString& title,
                             QWidget* parent = 0);

  virtual ~KPropertiesDialog();

  static bool showDialog(const KFileItem& item, QWidget* parent = 0,
                         bool modal = true);

  static bool showDialog(const KUrl& _url, QWidget* parent = 0,
                         bool modal = true);

  static bool showDialog(const KFileItemList& _items, QWidget* parent = 0,
                         bool modal = true);

  void insertPlugin (KPropertiesDialogPlugin *plugin);

  KUrl kurl() const;

  KFileItem& item();

  KFileItemList items() const;

  KUrl currentDir() const;

  QString defaultName() const;

  void updateUrl( const KUrl& _newUrl );

  void rename( const QString& _name );

  void abortApplying();

  void showFileSharingPage();

  void setFileSharingPage(QWidget* page);

  void setFileNameReadOnly( bool ro );

public Q_SLOTS:
  virtual void slotOk();      // Deletes the PropertiesDialog instance
  virtual void slotCancel();     // Deletes the PropertiesDialog instance

Q_SIGNALS:
  void propertiesClosed();

  void applied();

  void canceled();
  void saveAs(const KUrl &oldUrl, KUrl &newUrl);

Q_SIGNALS:
  void leaveModality();
private:
  class KPropertiesDialogPrivate;
  KPropertiesDialogPrivate* const d;

    Q_DISABLE_COPY(KPropertiesDialog)
};

class KIO_EXPORT KPropertiesDialogPlugin : public QObject
{
  Q_OBJECT
public:
  KPropertiesDialogPlugin( KPropertiesDialog *_props );
  virtual ~KPropertiesDialogPlugin();

  virtual void applyChanges();

#ifndef KDE_NO_DEPRECATED
  static KDE_DEPRECATED bool isDesktopFile( const KFileItem& _item );
#endif

  void setDirty( bool b );
  bool isDirty() const;

public Q_SLOTS:
  void setDirty(); // same as setDirty( true ). TODO KDE5: void setDirty(bool dirty=true);

Q_SIGNALS:
  void changed();

protected:
  KPropertiesDialog *properties;

  int fontHeight() const;

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


#endif