• Skip to content
• Skip to link menu

KDE 3.5 API Reference

• KDE API Reference
• API Reference

• Sitemap
• Contact Us

 

KParts

part.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 1999 Simon Hausmann <hausmann@kde.org>
             (C) 1999 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 _KPART_H
#define _KPART_H

#include <qstring.h>
#include <qdom.h>
#include <qguardedptr.h>
#include <kurl.h>

#include <kxmlguiclient.h>

class KInstance;
class QWidget;
class KAction;
class KActionCollection;
class QEvent;
struct QUnknownInterface;

namespace KIO {
  class Job;
}

namespace KParts
{

class PartManager;
class Plugin;
class PartPrivate;
class PartActivateEvent;
class PartSelectEvent;
class GUIActivateEvent;
class PartBasePrivate;

class KPARTS_EXPORT PartBase : virtual public KXMLGUIClient
{
    friend class PartBasePrivate;
public:

  PartBase();

  virtual ~PartBase();

  void setPartObject( QObject *object );
  QObject *partObject() const;

protected:
  virtual void setInstance( KInstance *instance );

  virtual void setInstance( KInstance *instance, bool loadPlugins );

  enum PluginLoadingMode {
    DoNotLoadPlugins = 0,
    LoadPlugins = 1,
    LoadPluginsIfEnabled = 2
  };

  void loadPlugins( QObject *parent, KXMLGUIClient *parentGUIClient, KInstance *instance );

  void setPluginLoadingMode( PluginLoadingMode loadingMode );

private:
    PartBasePrivate *d;
    QObject *m_obj;
};

class KPARTS_EXPORT Part : public QObject, public PartBase
{
    Q_OBJECT

public:

    Part( QObject *parent = 0, const char* name = 0 );

    virtual ~Part();

    virtual void embed( QWidget * parentWidget );

    virtual QWidget *widget();

    virtual void setManager( PartManager * manager );

    PartManager * manager() const;

    virtual Part *hitTest( QWidget *widget, const QPoint &globalPos );

    virtual void setSelectable( bool selectable );

    bool isSelectable() const;

signals:
    void setWindowCaption( const QString & caption );
    void setStatusBarText( const QString & text );

protected:

    virtual void setWidget( QWidget * widget );

    virtual void customEvent( QCustomEvent *event );

    virtual void partActivateEvent( PartActivateEvent *event );

    virtual void partSelectEvent( PartSelectEvent *event );

    virtual void guiActivateEvent( GUIActivateEvent *event );

    QWidget *hostContainer( const QString &containerName );

private slots:
    void slotWidgetDestroyed();

private:
    QGuardedPtr<QWidget> m_widget;

    PartManager * m_manager;

    PartPrivate *d;
};

class ReadWritePart;
class ReadOnlyPartPrivate;

class KPARTS_EXPORT ReadOnlyPart : public Part
{
  Q_OBJECT
  friend class ReadWritePart;
public:
  ReadOnlyPart( QObject *parent = 0, const char *name = 0 );

  virtual ~ReadOnlyPart();

  void setProgressInfoEnabled( bool show );

  bool isProgressInfoEnabled() const;

#ifndef KDE_NO_COMPAT
  void showProgressInfo( bool show );
#endif

public slots:
  virtual bool openURL( const KURL &url );

public:
  KURL url() const { return m_url; }

  virtual bool closeURL();

public:
  bool openStream( const QString& mimeType, const KURL& url );

  bool writeStream( const QByteArray& data );

  bool closeStream();

private: // Makes no sense for inherited classes to call those. But make it protected there.

  virtual bool doOpenStream( const QString& /*mimeType*/ ) { return false; }
  virtual bool doWriteStream( const QByteArray& /*data*/ ) { return false; }
  virtual bool doCloseStream() { return false; }

signals:
  void started( KIO::Job * );

  void completed();

  void completed( bool pendingAction );

  void canceled( const QString &errMsg );

protected slots:
  void slotJobFinished( KIO::Job * job );

protected:
  virtual bool openFile() = 0;

  void abortLoad();

  virtual void guiActivateEvent( GUIActivateEvent *event );

  KURL m_url;
  QString m_file;
  bool m_bTemp;

private:
  ReadOnlyPartPrivate *d;
};

class KPARTS_EXPORT ReadWritePart : public ReadOnlyPart
{
  Q_OBJECT
public:
  ReadWritePart( QObject *parent = 0, const char *name = 0 );
  virtual ~ReadWritePart();

  bool isReadWrite() const { return m_bReadWrite; }

  virtual void setReadWrite ( bool readwrite = true );

  bool isModified() const { return m_bModified; }

  // TODO: Make virtual for KDE 4
  bool queryClose();

  virtual bool closeURL();

  // TODO: Make virtual for KDE 4
  bool closeURL( bool promptToSave );

  virtual bool saveAs( const KURL &url );

  virtual void setModified( bool modified );

signals:
   void sigQueryClose(bool *handled, bool* abortClosing);

public slots:
  virtual void setModified();

  virtual bool save();

  bool waitSaveComplete();

protected:
  virtual bool saveFile() = 0;

  virtual bool saveToURL();

protected slots:
  void slotUploadFinished( KIO::Job * job );

private:
  void prepareSaving();

private:
  bool m_bModified;
  bool m_bReadWrite;
  bool m_bClosing;
};

} // namespace

#endif

KParts

Skip menu "KParts"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members
• Related Pages

API Reference

Skip menu "API Reference"

• dcop
• DNSSD
• interfaces
• Kate
• kconf_update
• KDECore
• KDED
• kdefx
• KDEsu
• kdeui
• KDocTools
• KHTML
• KImgIO
• KInit
• kio
• kioslave
• KJS
• KNewStuff
• KParts
• KUtils

Generated for API Reference by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal