akregator/src/openurlrequest.h

   1 /*
   2     This file is part of Akregator.
   3
   4     Copyright (C) 2006 Frank Osterfeld <osterfeld@kde.org>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19
  20     As a special exception, permission is given to link this program
  21     with any edition of Qt, and distribute the resulting executable,
  22     without including the source code for Qt in the source distribution.
  23 */
  24
  25 #ifndef AKREGATOR_OPENURLREQUEST_H
  26 #define AKREGATOR_OPENURLREQUEST_H
  27
  28 #include <kparts/browserextension.h>
  29
  30 #include <QUrl>
  31
  32 #include <QPointer>
  33
  34 #include "akregator_export.h"
  35
  36 namespace Akregator
  37 {
  38
  39 class AKREGATOR_EXPORT OpenUrlRequest
  40 {
  41 public:
  42
  43     /**
  44      * Akregator-specific options specifying how a link should be handled.
  45      * TODO: check what can be done by overriding KURLArgs flags.
  46      */
  47     enum Options {
  48         None = 0, /**< no explicit options, use default */
  49         NewTab, /**< open in new tab */
  50         ExternalBrowser /**< open in external browser */
  51     };
  52
  53     explicit OpenUrlRequest(const QUrl &url = QUrl());
  54
  55     /**
  56      * the Id of the frame that sent the request */
  57     int frameId() const;
  58     void setFrameId(int frameId);
  59
  60     QUrl url() const;
  61     void setUrl(const QUrl &url);
  62
  63     KParts::OpenUrlArguments args() const;
  64     void setArgs(const KParts::OpenUrlArguments &args);
  65
  66     KParts::BrowserArguments browserArgs() const;
  67     void setBrowserArgs(const KParts::BrowserArguments &args);
  68
  69     Options options() const;
  70     void setOptions(Options options);
  71
  72     bool openInBackground() const;
  73     void setOpenInBackground(bool background);
  74
  75     QString debugInfo() const;
  76
  77     bool wasHandled() const;
  78     void setWasHandled(bool handled);
  79
  80 private:
  81
  82     int m_frameId;
  83     QUrl m_url;
  84     KParts::OpenUrlArguments m_args;
  85     KParts::BrowserArguments m_browserArgs;
  86     Options m_options;
  87     bool m_inBackground;
  88     bool m_wasHandled;
  89 };
  90
  91 } // namespace Akregator
  92
  93 #endif // AKREGATOR_OPENURLREQUEST_H