Warning, file /office/calligra/libs/main/KoView.h was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).

 /* This file is part of the KDE project
    Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
    Copyright (C) 2007 Thomas Zander <zander@kde.org>
    Copyright (C) 2010 Benjamin Port <port.benjamin@gmail.com>
 
    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 __koView_h__
 #define __koView_h__
 
 #include <QWidget>
 #include <kxmlguiclient.h>
 #include "komain_export.h"
 
 class KoPart;
 class KoDocument;
 class KoMainWindow;
 class KoPrintJob;
 class KoViewPrivate;
 class KoZoomController;
 struct KoPageLayout;
 
 // Qt classes
 class QStatusBar;
 class QDragEnterEvent;
 class QDropEvent;
 class QPrintDialog;
 
 /**
  * This class is used to display a KoDocument.
  *
  * Multiple views can be attached to one document at a time.
  */
 class KOMAIN_EXPORT KoView : public QWidget, public KXMLGUIClient
 {
     Q_OBJECT
 
 public:
     /**
      * Creates a new view for the document. Usually you don't create views yourself
      * since the Calligra components come with their own view classes which inherit
      * KoView.
      *
      * The standard way to retrieve a KoView is to call KoPart::createView.
      *
      * @param part     is the KoPart for the document.
      * @param document is the document which should be displayed in this view. This pointer
      *                 must not be zero.
      * @param parent   parent widget for this view.
      */
     KoView(KoPart *part, KoDocument *document, QWidget *parent = 0);
 
     /**
      * Destroys the view and unregisters at the document.
      */
     ~KoView() override;
 
     // QWidget overrides
 protected:
 
     void dragEnterEvent(QDragEnterEvent * event) override;
 
     /**
      * dropEvent by default calls addImages. Your KoView subclass might
      * override dropEvent and if your app can also handle images, call this
      * method.
      */
     void dropEvent(QDropEvent * event) override;
 
     // KoView api
 
     /**
      * Adds the given list of QImages as imageshapes to the view's document.
      *
      * @param imageList a list of QImages that can be inserted
      * @param insertAt the position in screen pixels where the images
      * can be inserted.
      */
     virtual void addImages(const QVector<QImage> &imageList, const QPoint &insertAt);
 
 public:
 
     /**
      *  Retrieves the document object of this view.
      */
     KoDocument *koDocument() const;
 
     /**
      * Tells this view that its document has got deleted (called internally)
      */
     void setDocumentDeleted();
 
     /**
      * In order to print the document represented by this view a new print job should
      * be constructed that is capable of doing the printing.
      * The default implementation returns 0, which silently cancels printing.
      */
     virtual KoPrintJob * createPrintJob();
 
     /**
      * In order to export the document represented by this view a new print job should
      * be constructed that is capable of doing the printing.
      * The default implementation call createPrintJob.
      */
     virtual KoPrintJob * createPdfPrintJob();
 
     /**
      * @return the page layout to be used for printing.
      * Default is the documents layout.
      * Reimplement if your application needs to use a different layout.
      */
     virtual KoPageLayout pageLayout() const;
 
     /**
      * Create a QPrintDialog based on the @p printJob
      */
     virtual QPrintDialog *createPrintDialog(KoPrintJob *printJob, QWidget *parent);
 
     /**
      * @return the KoMainWindow in which this view is currently.
      */
     KoMainWindow * mainWindow() const;
 
    /**
      * @return the statusbar of the KoMainWindow in which this view is currently.
      */
     QStatusBar * statusBar() const;
 
     /**
      * This adds a widget to the statusbar for this view.
      * If you use this method instead of using statusBar() directly,
      * KoView will take care of removing the items when the view GUI is deactivated
      * and readding them when it is reactivated.
      * The parameters are the same as QStatusBar::addWidget().
      *
      * Note that you can't use KStatusBar methods (inserting text items by id).
      * But you can create a KStatusBarLabel with a dummy id instead, and use
      * it directly, to get the same look and feel.
      */
     void addStatusBarItem(QWidget * widget, int stretch = 0, bool permanent = false);
 
     /**
      * Remove a widget from the statusbar for this view.
      */
     void removeStatusBarItem(QWidget * widget);
 
     /**
      * You have to implement this method and disable/enable certain functionality (actions for example) in
      * your view to allow/disallow editing of the document.
      */
     virtual void updateReadWrite(bool readwrite) = 0;
 
     /**
      * Return the zoomController for this view.
      */
     virtual KoZoomController *zoomController() const = 0;
 
     /// create a list of actions that when activated will change the unit on the document.
     QList<QAction*> createChangeUnitActions(bool addPixelUnit = false);
 
     /**
      * @brief guiActivateEvent is called when the window activates a view. Reimplement this for any special behaviour.
      */
     virtual void guiActivateEvent(bool activated);
 
 public Q_SLOTS:
 
     /**
      * Display a message in the status bar (calls QStatusBar::message())
      * @todo rename to something more generic
      */
     void slotActionStatusText(const QString &text);
 
     /**
      * End of the message in the status bar (calls QStatusBar::clear())
      * @todo rename to something more generic
      */
     void slotClearStatusText();
 
     /**
      * Updates the author profile actions from configuration.
      */
     void slotUpdateAuthorProfileActions();
 
 protected:
 
     /**
      * Generate a name for this view.
      */
     QString newObjectName();
 
 protected Q_SLOTS:
 
     virtual void changeAuthorProfile(const QString &profileName);
 
 private:
     virtual void setupGlobalActions(void);
     KoViewPrivate * const d;
 };
 
 #endif