KoView.h

/* This file is part of the KDE project
   Copyright (C) 1998, 1999 Torben Weis <weis@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 __koView_h__
#define __koView_h__
 
#include <tqwidget.h>
#include <tqguardedptr.h>
 
#include <tdeparts/part.h>
 
#include <KoChild.h>
#include <koffice_export.h>
 
class TDEAction;
class TDEActionCollection;
class TQCustomEvent;
class KoDocument;
class KoMainWindow;
class TDEMainWindow;
class KoViewPrivate;
class KoViewChild;
class KoFrame;
class KStatusBar;
class TDEInstance;
class KPrinter;
class KoDocumentChild;
class DCOPObject;
 
namespace KParts
{
  class PartManager;
  class PartActivateEvent;
  class PartSelectEvent;
}

class KOFFICECORE_EXPORT KoView : public TQWidget, public KParts::PartBase
{
  TQ_OBJECT
  
public:
  KoView( KoDocument *document, TQWidget *parent = 0, const char *name = 0 );
  virtual ~KoView();

  KoDocument *koDocument() const;

  void setDocumentDeleted();
  bool documentDeleted() const;
 
  virtual void setPartManager( KParts::PartManager *manager );
  virtual KParts::PartManager *partManager() const;

  virtual TDEAction *action( const TQDomElement &element ) const;

  virtual KoDocument *hitTest( const TQPoint &pos );

  virtual int leftBorder() const;
  virtual int rightBorder() const;
  virtual int topBorder() const;
  virtual int bottomBorder() const;

  virtual void setZoom( double zoom );
  virtual double zoom() const;

  virtual TQWidget *canvas() const;

  virtual int canvasXOffset() const;

  virtual int canvasYOffset() const;

  virtual void canvasAddChild( KoViewChild *child );

   virtual KoDocumentChild *selectedChild();

  virtual KoDocumentChild *activeChild();

  void enableAutoScroll();

  void disableAutoScroll();

  virtual void paintEverything( TQPainter &painter, const TQRect &rect, bool transparent = false );

  bool hasDocumentInWindow( KoDocument *doc );

  virtual TQWMatrix matrix() const TDE_DEPRECATED;

  virtual TQPoint applyViewTransformations( const TQPoint& ) const;

  virtual TQPoint reverseViewTransformations( const TQPoint& ) const;

  virtual TQRect applyViewTransformations( const TQRect& ) const;

  virtual TQRect reverseViewTransformations( const TQRect& ) const;

  KoViewChild *child( KoView *view );
  KoViewChild *child( KoDocument *document );

  virtual DCOPObject * dcopObject();

  virtual void setupPrinter( KPrinter &printer );
 
  // BCI: make it return a bool, so that aborting doesn't still fire up the print preview afterwards
  virtual void print( KPrinter &printer );

  KoMainWindow * shell() const;

  TDEMainWindow* mainWindow() const;

  KStatusBar * statusBar() const;

  void addStatusBarItem( TQWidget * widget, int stretch = 0, bool permanent = false );

  void removeStatusBarItem( TQWidget * widget );

  void showAllStatusBarItems( bool show );

  virtual void updateReadWrite( bool readwrite ) = 0;

  bool isInOperation() const;
 
public slots:
    virtual void newView();

    virtual void beginOperation();

    virtual void endOperation();

    void slotActionStatusText( const TQString &text );

    void slotClearStatusText();
 
protected:
  virtual void customEvent( TQCustomEvent *ev );

  virtual void partActivateEvent( KParts::PartActivateEvent *event );
  virtual void partSelectEvent( KParts::PartSelectEvent *event );
  virtual void guiActivateEvent( KParts::GUIActivateEvent * );
 
signals:
  void activated( bool active );
  void selected( bool select );
 
  void autoScroll(const TQPoint &scrollDistance);
 
  void childSelected( KoDocumentChild *child );
  void childUnselected( KoDocumentChild *child );
 
  void childActivated( KoDocumentChild *child );
  void childDeactivated( KoDocumentChild *child );
 
  void regionInvalidated( const TQRegion &region, bool erase );
 
  void invalidated();
 
// KDE invents public signals :)
#undef signals
#define signals public
signals:

  void embeddImage(const TQString &filename);
 
#undef signals
#define signals protected
 
protected slots:
  virtual void slotChildActivated( bool a );
  virtual void slotChildChanged( KoDocumentChild *child );
  virtual void slotAutoScroll( );
 
private:
  TDEAction *actionNewView;
  virtual void setupGlobalActions( void );
  KoViewPrivate *d;
  int autoScrollAcceleration( int offset ) const;
};

class KoViewChild : public KoChild
{
  TQ_OBJECT
  
public:
  KoViewChild( KoDocumentChild *child, KoView *_parentView );
  virtual ~KoViewChild();
 
  KoDocumentChild *documentChild() const { return m_child; }
  KoView *parentView() const { return m_parentView; }
  KoFrame *frame() const { return m_frame; }
 
  void setInitialFrameGeometry();
 
public slots:
 
  // Call this when the view transformations change
  void reposition() { slotDocGeometryChanged(); }
 
private slots:
  void slotFrameGeometryChanged();
  void slotDocGeometryChanged();
 
private:
  TQGuardedPtr<KoDocumentChild> m_child;
  TQGuardedPtr<KoFrame> m_frame;
  TQGuardedPtr<KoView> m_parentView;
  class KoViewChildPrivate;
  KoViewChildPrivate *d;
};
 
#endif