apps/konqueror/src/KonqViewAdaptor.h

   1 /* This file is part of the KDE project
   2    Copyright 2000       Simon Hausmann <hausmann@kde.org>
   3    Copyright 2000, 2006 David Faure <faure@kde.org>
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public
   7    License as published by the Free Software Foundation; either
   8    version 2 of the License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13     General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; see the file COPYING.  If not, write to
  17    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18    Boston, MA 02110-1301, USA.
  19 */
  20
  21 #ifndef __KonqViewAdaptor_h__
  22 #define __KonqViewAdaptor_h__
  23
  24 #include <QtCore/QStringList>
  25 #include <QtDBus/QtDBus>
  26
  27 class KonqView;
  28
  29 /**
  30  * DBus interface for a konqueror view
  31  */
  32 class KonqViewAdaptor : public QObject
  33 {
  34     Q_OBJECT
  35     Q_CLASSINFO("D-Bus Interface", "org.kde.Konqueror.View")
  36
  37 public:
  38
  39     explicit KonqViewAdaptor( KonqView * view );
  40     ~KonqViewAdaptor();
  41
  42 public slots:
  43
  44     /**
  45      * Displays another URL, but without changing the view mode
  46      * (Make sure the part can display this URL)
  47      */
  48     void openUrl( const QString& url,
  49                   const QString& locationBarURL,
  50                   const QString& nameFilter );
  51
  52     /**
  53      * Reload
  54      */
  55     void reload();
  56
  57     /**
  58      * Change the type of view (i.e. loads a new konqueror view)
  59      * @param serviceType the service type we want to show
  60      * @param serviceName allows to enforce a particular service to be chosen,
  61      *        @see KonqFactory.
  62      */
  63     bool changeViewMode( const QString &serviceType,
  64                          const QString &serviceName );
  65
  66     /**
  67      * Call this to prevent next openUrl() call from changing history lists
  68      * Used when the same URL is reloaded (for instance with another view mode)
  69      */
  70     void lockHistory();
  71
  72     /**
  73      * Stop loading
  74      */
  75     void stop();
  76
  77     /**
  78      * Retrieve view's URL
  79      */
  80     QString url();
  81
  82     /**
  83      * Get view's location bar URL, i.e. the one that the view signals
  84      * It can be different from url(), for instance if we display a index.html
  85      */
  86     QString locationBarURL();
  87
  88     /**
  89      * @return the servicetype this view is currently displaying
  90      */
  91     QString serviceType();
  92
  93     /**
  94      * @return the servicetypes this view is capable to display
  95      */
  96     QStringList serviceTypes();
  97
  98     /**
  99      * @return the part embedded into this view
 100      */
 101     QDBusObjectPath part();
 102
 103     /**
 104      * Enable/Disable the context popup menu for this view.
 105      */
 106     void enablePopupMenu( bool b );
 107
 108
 109     bool isPopupMenuEnabled() const;
 110
 111     /*
 112      * Return length of history
 113      */
 114     uint historyLength()const;
 115     /*
 116      * Return true  if "Use index HTML" is checked
 117      */
 118     bool allowHTML() const;
 119
 120     /*
 121      * Move forward in history "-1"
 122      */
 123     void goForward();
 124     /*
 125      * Move back in history "+1"
 126      */
 127     void goBack();
 128
 129     bool canGoBack()const;
 130     bool canGoForward()const;
 131
 132 private:
 133
 134     KonqView * m_pView;
 135
 136 };
 137
 138 #endif
 139