Differential D14826 Diff 39889 src/include/ktexteditor/inlinenoteinterface.h

Changeset View

Standalone View

View Options

src/include/ktexteditor/inlinenoteinterface.h

  • This file was added.
PropertyOld ValueNew Value
File Modenull100755
1​/* This file is part of the KDE libraries
2​
3​ Copyright 2018 Sven Brauch <mail@svenbrauch.de>
dhaumannUnsubmitted
Done

author missing

dhaumann: author missing
4​ Copyright 2018 Michal Srb <michalsrb@gmail.com>
5​
dhaumannUnsubmitted
Done

Btw, as license I would previer LGPLv2+ (as it currently is stated) +e.V. option to relicense.

dhaumann: Btw, as license I would previer LGPLv2+ (as it currently is stated) +e.V. option to relicense.
6​ This library is free software; you can redistribute it and/or
7​ modify it under the terms of the GNU Lesser General Public
8​ License as published by the Free Software Foundation; either
9​ version 2.1 of the License, or (at your option) version 3, or any
10​ later version accepted by the membership of KDE e.V. (or its
11​ successor approved by the membership of KDE e.V.), which shall
12​ act as a proxy defined in Section 6 of version 3 of the license.
13​
14​ This library is distributed in the hope that it will be useful,
15​ but WITHOUT ANY WARRANTY; without even the implied warranty of
16​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17​ Library General Public License for more details.
18​
19​ You should have received a copy of the GNU Library General Public License
20​ along with this library; see the file COPYING.LIB. If not, write to
21​ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22​ Boston, MA 02110-1301, USA.
23​*/
24​#ifndef KTEXTEDITOR_INLINENOTEINTERFACE_H
25​#define KTEXTEDITOR_INLINENOTEINTERFACE_H
26​
27​#include <QString>
28​
29​#include <ktexteditor_export.h>
30​
31​#include <ktexteditor/cursor.h>
32​#include <ktexteditor/view.h>
33​
34​class QPainter;
35​
36​namespace KTextEditor
37​{
38​
39​class InlineNoteProvider;
40​
41​/**
42​ * @brief Inline notes interface for rendering notes in the text.
43​ *
44​ * @ingroup kte_group_view_extensions
45​ *
46​ * @section inlinenote_introduction Introduction
47​ *
48​ * The inline notes interface provides a way to render arbitrary things in
49​ * the text. The layout of the line is adapted to create space for the note.
50​ * Possible applications include showing a name of a function parameter on
51​ * call side or rendering square with color preview next to CSS color
52​ * property.
53​ *
54​ * To register as inline note provider, call registerInlineNoteProvider() with
55​ * an instance that inherits InlineNoteProvider. Finally, make sure you remove
56​ * your inline note provider by calling unregisterInlineNoteProvider().
57​ *
58​ * @section inlinenote_access Accessing the InlineNoteInterface
59​ *
60​ * The InlineNoteInterface is an extension interface for a
61​ * View, i.e. the View inherits the interface. Use qobject_cast to access the
62​ * interface:
63​ * @code
64​ * // view is of type KTextEditor::View*
65​ * KTextEditor::InlineNoteInterface *iface =
66​ * qobject_cast<KTextEditor::InlineNoteInterface*>(view);
67​ *
68​ * if (iface) {
69​ * // the implementation supports the interface
70​ * // myProvider inherits KTextEditor::InlineNoteProvider
71​ * iface->registerInlineNoteProvider(myProvider);
72​ * }
dhaumannUnsubmitted
Done

@author Sven Brauch, Michal Srb

dhaumann: @author Sven Brauch, Michal Srb
73​ * @endcode
74​ *
dhaumannUnsubmitted
Done

@since 5.50

dhaumann: @since 5.50
75​ * @see InlineNoteProvider
76​ * @see InlineNote
77​ *
78​ * @author Sven Brauch, Michal Srb
79​ * @since 5.50
80​ */
81​class KTEXTEDITOR_EXPORT InlineNoteInterface
82​{
83​public:
84​ InlineNoteInterface();
85​ virtual ~InlineNoteInterface();
86​
87​ /**
88​ * Register the inline note provider @p provider.
89​ *
90​ * Whenever a line is painted, the @p provider will be queried for notes
91​ * that should be painted in it. When the provider is about to be
92​ * destroyed, make sure to call unregisterTextHintProvider() to avoid a
93​ * dangling pointer.
94​ *
95​ * @param provider inline note provider
96​ * @see unregisterInlineNoteProvider(), InlineNoteProvider
97​ */
98​ virtual void registerInlineNoteProvider(KTextEditor::InlineNoteProvider *provider) = 0;
99​
100​ /**
101​ * Unregister the inline note provider @p provider.
dhaumannUnsubmitted
Done

Please add a d-pointer as placeholder.

private:

/**
 * private d-pointer
 */
class InlineNoteInterfacePrivate *const d = nullptr;
dhaumann: Please add a d-pointer as placeholder. private: /** * private d-pointer */…
102​ *
103​ * @param provider inline note provider to unregister
104​ * @see registerInlineNoteProvider(), InlineNoteProvider
105​ */
106​ virtual void unregisterInlineNoteProvider(KTextEditor::InlineNoteProvider *provider) = 0;
107​};
108​
109​}
110​
111​Q_DECLARE_INTERFACE(KTextEditor::InlineNoteInterface, "org.kde.KTextEditor.InlineNoteInterface")
112​
113​#endif
michalsrbUnsubmitted
Done

Perhaps this could be QVarLengthArray of some size too?

michalsrb: Perhaps this could be `QVarLengthArray` of some size too?
dhaumannUnsubmitted
Done

We discussed that here, and let's use QVector for now. If this turns out to be an issue, we will change for KF6.

dhaumann: We discussed that here, and let's use QVector for now. If this turns out to be an issue, we…
dhaumannUnsubmitted
Not Done

noteActivated -> inlineNoteActivated()

dhaumann: noteActivated -> inlineNoteActivated()
dhaumannUnsubmitted
Done
  • move to InlineNote
  • turn into enum class
dhaumann: - move to InlineNote - turn into enum class
dhaumannUnsubmitted
Done
  • API documentation is wrong
  • please use @param instead of \param everywhere, i.e. we prefer @xyz over \xyz
dhaumann: - API documentation is wrong - please use @param instead of \param everywhere, i.e. we prefer…
dhaumannUnsubmitted
Done

please add d-pointer:

private:
    class InlineNotePrivate * const d = nullptr;
dhaumann: please add d-pointer: private: class InlineNotePrivate * const d = nullptr;
dhaumannUnsubmitted
Done

can you try making all variables private?

dhaumann: can you try making all variables private?
dhaumannUnsubmitted
Done

There is only one @param note

dhaumann: There is only one @param note
dhaumannUnsubmitted
Not Done

I would prefer two functions:

virtual void inlineNoteFocusInEvent(const InlineNote& note, const QPoint& pos);
virtual void inlineNoteMoveEvent(const InlineNote& note, const QPoint& pos);
virtual void inlineNoteFocusOutEvent(const InlineNote& note);
dhaumann: I would prefer two functions: virtual void inlineNoteFocusInEvent(const InlineNote& note…
dhaumannUnsubmitted
Done

API docs missing for InlineNote, but we can add that later.

dhaumann: API docs missing for InlineNote, but we can add that later.
dhaumannUnsubmitted
Done

please initialize all members in-class.

dhaumann: please initialize all members in-class.