KParts

openurlevent.h
1 /*
2  This file is part of the KDE project
3  SPDX-FileCopyrightText: 1999 Simon Hausmann <hausmann@kde.org>
4  SPDX-FileCopyrightText: 1999 David Faure <faure@kde.org>
5 
6  SPDX-License-Identifier: LGPL-2.0-or-later
7 */
8 
9 #ifndef __kparts_openurlevent_h__
10 #define __kparts_openurlevent_h__
11 
12 #include <QEvent>
13 #include <kparts/openurlarguments.h>
14 #include <memory>
15 
16 class QUrl;
17 
18 namespace KParts
19 {
20 class ReadOnlyPart;
21 class OpenUrlEventPrivate;
22 
23 /**
24  * @class OpenUrlEvent openurlevent.h <KParts/OpenUrlEvent>
25  *
26  * @short The KParts::OpenUrlEvent event informs that a given part has opened a given URL.
27  * Applications can use this event to send this information to interested plugins.
28  *
29  * The event should be sent before opening the URL in the part, so that the plugins
30  * can use part()->url() to get the old URL.
31  */
32 class KPARTS_EXPORT OpenUrlEvent : public QEvent
33 {
34 public:
35  OpenUrlEvent(ReadOnlyPart *part, const QUrl &url, const OpenUrlArguments &args = OpenUrlArguments());
36  ~OpenUrlEvent() override;
37 
38  ReadOnlyPart *part() const;
39  QUrl url() const;
40  OpenUrlArguments arguments() const;
41 
42  static bool test(const QEvent *event);
43 
44 private:
45  const std::unique_ptr<OpenUrlEventPrivate> d;
46 };
47 
48 }
49 
50 #endif
Base class for any "viewer" part.
Definition: readonlypart.h:51
OpenUrlArguments is the set of arguments that specify how a URL should be opened by KParts::ReadOnlyP...
The KParts::OpenUrlEvent event informs that a given part has opened a given URL. Applications can use...
Definition: openurlevent.h:32
The KParts namespace,.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Thu Feb 15 2024 03:48:58 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.