Differential D8211 Diff 22661 kdevplatform/documentation/standarddocumentationview.h

Changeset View

Standalone View

View Options

kdevplatform/documentation/standarddocumentationview.h

Context not available.
59 void setOverrideCss(const QUrl &url); 59​ void setOverrideCss(const QUrl &url);
60 60​
61 void load(const QUrl &url); 61​ void load(const QUrl &url);
62​ /**
63​ * @brief delegate method for the QTextBrowser::loadResource(type,url)
64​ * overload of the QTextBrowser backend. Override this method if your
65​ * plugin can handle URLs that QTextBrowser cannot handle itself.
66​ *
67​ * @param type the QTextDocument::ResourceType type of the address to load
68​ * @param url the address to be loaded; can be rewritten (e.g. with a resolved URL)
69​ * @param content return variable for the loaded content. @p content is
70​ * guaranteed to be invalid upon entry.
71​ *
72​ * The function should return true if content was loaded successfully.
73​ */
74​ virtual bool loadResource(int type, QUrl& url, QVariant& content);
kossebauUnsubmitted
Not Done

Why is this method not in #ifdef USE_QTEXTBROWSER?

kossebau: Why is this method not in #ifdef USE_QTEXTBROWSER?
rjvbbAuthorUnsubmitted
Not Done

I've hesitated about that. It can be of course. I've left it here for now, in case anyone wants to extends the QWE or QWK backends in a similar way with a callback into the QtHelp (or other) plugin.
(I won't be the one doing that, so I don't care where we put this.)

rjvbb: I've hesitated about that. It can be of course. I've left it here for now, in case anyone wants…
kossebauUnsubmitted
Not Done

Given we are flexible with the API per minor kdevelop/kdevplatform version, there is no need to prepare already for possible future extensions.

So let's keep the API as minimal as needed.

kossebau: Given we are flexible with the API per minor kdevelop/kdevplatform version, there is no need to…
75​
76​#ifdef USE_QTEXTBROWSER
kossebauUnsubmitted
Not Done

KDevelop::StandardDocumentationView is part of the public KDevPlatformDocumentation API, standarddocumentationview.h is an installed header.

Having a part of the public API only created depending on build-time config settings needs this settings also be deployed with the installed headers.

kossebau: KDevelop::StandardDocumentationView is part of the public KDevPlatformDocumentation API…
rjvbbAuthorUnsubmitted
Not Done

You're saying I have 2 simple choices here:

  • remove #ifdef in the headerfile and provide (stub) implementations for the QtWeb* configuration
  • add the USE_QTEXTBROWSER flag in a generated headerfile so that the setting becomes available publicly. This would probably also mean that the flag best become under direct control of a cmake option.

Come to think of it, the 2nd option is probably the way to go in case there are contributed documentation plugins (are there?).

Do we agree on the name or should I use something else?

rjvbb: You're saying I have 2 simple choices here: - remove #ifdef in the headerfile and provide…
kossebauUnsubmitted
Not Done

I tried to stay abstract with "deployed with the installed headers"as myself I don't know best practices from the top of my head. Needs others to comment on.
Perhaps the solution is also something which already works for the qthelp plugin, without needing to rely on the same CMake vars used for kdevplatfom/documentation.

kossebau: I tried to stay abstract with "deployed with the installed headers"as myself I don't know best…
77​ /**
78​ * @brief load a page with the given content
79​ *
80​ * @param url the address with a scheme QTextBrowser doesn't support
81​ * @param content content that QTextBrowser cannot obtain itself.
82​ *
83​ * Url and content are cached internally.
84​ */
85​ void load(const QUrl &url, const QByteArray& content);
86​ /**
87​ * @brief restore the cached url and content information
88​ */
89​ void restore();
kossebauUnsubmitted
Not Done

This name is too generic and needs to be more explicit, add to it what it restores.

kossebau: This name is too generic and needs to be more explicit, add to it what it restores.
90​#endif
62 void setHtml(const QString &html); 91​ void setHtml(const QString &html);
63 void setNetworkAccessManager(QNetworkAccessManager* manager); 92​ void setNetworkAccessManager(QNetworkAccessManager* manager);
64 93​
Context not available.
67 */ 96​ */
68 void setDelegateLinks(bool delegate); 97​ void setDelegateLinks(bool delegate);
69 98​
70 QMenu* createStandardContextMenu(); 99​ virtual QMenu* createStandardContextMenu(const QPoint& pos = QPoint());
100​
101​ /**
102​ * is @param url one using a supported scheme?
kossebauUnsubmitted
Not Done

What is the requirement to be a supported scheme? The current hard-coded implementation seems rather made-up. What does "supported" mean? By whom?

So "man", "help", "about", why are they supported? Why are others like "https" not?

kossebau: What is the requirement to be a supported scheme? The current hard-coded implementation seems…
103​ */
104​ static bool isUrlSchemeSupported(const QUrl& url);
105​
106​ /**
107​ * @brief returns the underlying view widget
108​ */
109​ QWidget* view() const;
71 110​
72Q_SIGNALS: 111​Q_SIGNALS:
73 void linkClicked(const QUrl &link); 112​ void linkClicked(const QUrl &link);
Context not available.