tdebase/konqueror/KonqViewIface.h

/* This file is part of the KDE project
   Copyright (C) 2000 Simon Hausmann <hausmann@kde.org>
   Copyright (C) 2000 David Faure <faure@kde.org>

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This program 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
    General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef __KonqViewIface_h__
#define __KonqViewIface_h__

#include <dcopobject.h>
#include <tqstringlist.h>
#include <dcopref.h>

class KonqView;

/**
 * DCOP interface for a konqueror main window
 */
class KonqViewIface : virtual public DCOPObject
{
  K_DCOP
public:

  KonqViewIface( KonqView * view, const TQCString& name );
  ~KonqViewIface();

k_dcop:

  /**
   * Displays another URL, but without changing the view mode
   * (Make sure the part can display this URL)
   */
  void openURL( TQString url,
                const TQString & locationBarURL,
                const TQString & nameFilter );

  /** Reload */
  void reload();

  /**
   * Change the type of view (i.e. loads a new konqueror view)
   * @param serviceType the service type we want to show
   * @param serviceName allows to enforce a particular service to be chosen,
   *        @see KonqFactory.
   */
  bool changeViewMode( const TQString &serviceType,
                       const TQString &serviceName );

  /**
   * Call this to prevent next openURL() call from changing history lists
   * Used when the same URL is reloaded (for instance with another view mode)
   */
  void lockHistory();

  /**
   * Stop loading
   */
  void stop();

  /**
   * Retrieve view's URL
   */
  TQString url();

  /**
   * Get view's location bar URL, i.e. the one that the view signals
   * It can be different from url(), for instance if we display a index.html
   */
  TQString locationBarURL();

  /**
   * @return the servicetype this view is currently displaying
   */
  TQString serviceType();

  /**
   * @return the servicetypes this view is capable to display
   */
  TQStringList serviceTypes();

  /**
   * @return the part embedded into this view
   */
  DCOPRef part();

  /**
   * Enable/Disable the context popup menu for this view.
   */
  void enablePopupMenu( bool b );


    bool isPopupMenuEnabled() const;

    /*
     * Return length of history
     */
    uint historyLength()const;
    /*
     * Return true  if "Use index HTML" is checked
     */
    bool allowHTML() const;

    /*
     * Move forward in history "-1"
     */
    void goForward();
    /*
     * Move back in history "+1"
     */
    void goBack();

    bool canGoBack()const;
    bool canGoForward()const;

private:

  KonqView * m_pView;

};

#endif