apps/konqueror/src/konqmisc.h

   1 /* This file is part of the KDE project
   2    Copyright (C) 1998, 1999 David Faure <faure@kde.org>
   3
   4    This program is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU General Public
   6    License as published by the Free Software Foundation; either
   7    version 2 of the License, or (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12     General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; see the file COPYING.  If not, write to
  16    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17    Boston, MA 02110-1301, USA.
  18 */
  19
  20 #ifndef _konq_misc_h
  21 #define _konq_misc_h
  22
  23 #include "konqprivate_export.h"
  24
  25 #include <krun.h>
  26 #include <kparts/browserextension.h>
  27 class KonqMainWindow;
  28 class KonqView;
  29 class KStandardDirs;
  30 class KSharedConfig;
  31 template <typename T> class KSharedPtr;
  32 typedef KSharedPtr<KSharedConfig> KSharedConfigPtr;
  33
  34 namespace KonqMisc // TODO split into something like KonqWindowFactory or KonqWindowCreator, and KonqGlobal?
  35 {
  36     /**
  37      * Stop full-screen mode in all windows.
  38      */
  39     void abortFullScreenMode();
  40
  41     /**
  42      * Create a new window with a single view, showing @p url, using @p args
  43      */
  44     KonqMainWindow * createSimpleWindow( const KUrl &url, const KParts::OpenUrlArguments &args,
  45                                          const KParts::BrowserArguments& browserArgs = KParts::BrowserArguments(),
  46                                          bool tempFile = false);
  47
  48     /**
  49      * Create a new window for @p url using @p args and the appropriate profile for this URL.
  50      * @param forbidUseHTML internal. True when called by "Find Files"
  51      * @param openUrl If it is false, no url is opened in the new window (and the aboutpage is not shown).
  52      * The url is used to guess the profile.
  53      */
  54     KonqMainWindow * createNewWindow( const KUrl &url,
  55                                       const KParts::OpenUrlArguments &args = KParts::OpenUrlArguments(),
  56                                       const KParts::BrowserArguments& browserArgs = KParts::BrowserArguments(),
  57                                       bool forbidUseHTML = false,
  58                                       const QStringList &filesToSelect = QStringList(),
  59                                       bool tempFile = false,
  60                                       bool openUrl = true);
  61
  62     /**
  63      * Create a new window from the profile defined by @p filename and @p path.
  64      * @param url an optional URL to open in this profile.
  65      * @param forbidUseHTML internal. True when called by "Find Files"
  66      * @param openUrl If false no url is opened
  67      */
  68     KonqMainWindow * createBrowserWindowFromProfile( const QString &path,
  69                                                      const QString &filename,
  70                                                      const KUrl &url = KUrl(),
  71                                                      const KParts::OpenUrlArguments &args = KParts::OpenUrlArguments(),
  72                                                      const KParts::BrowserArguments& browserArgs = KParts::BrowserArguments(),
  73                                                      bool forbidUseHTML = false,
  74                                                      const QStringList& filesToSelect = QStringList(),
  75                                                      bool tempFile = false,
  76                                                      bool openUrl = true);
  77
  78     /**
  79      * Creates a new window from the history of a view, copies the history
  80      * @param view the History is copied from this view
  81      * @param steps Restore currentPos() + steps
  82      */
  83     KonqMainWindow * newWindowFromHistory( KonqView* view, int steps );
  84
  85     /**
  86      * Applies the URI filters to @p url.
  87      *
  88      * @p parent is used in case of a message box.
  89      * @p _url to be filtered.
  90      * @p _path the absolute path to append to the url before filtering it.
  91      */
  92     QString konqFilteredURL( QWidget* /*parent*/, const QString& /*_url*/, const QString& _path = QString() );
  93
  94     /**
  95      * Name of the default profile
  96      */
  97     QString defaultProfileName();
  98
  99     /**
 100      * Path to the default profile
 101      */
 102     QString defaultProfilePath();
 103
 104     /**
 105     * These are some helper functions to encode/decode session filenames. The
 106     * problem here is that windows doesn't like files with ':' inside.
 107     */
 108
 109     QString encodeFilename(QString filename);
 110
 111     QString decodeFilename(QString filename);
 112 }
 113
 114 #endif