blob: d6da51b47a647601032c13ee1e29b96c8d1f248c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
/*
This file is part of the KDE project
SPDX-FileCopyrightText: 2020 Felix Ernst <[email protected]>
SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#ifndef DOLPHINURLNAVIGATOR_H
#define DOLPHINURLNAVIGATOR_H
#include <KUrlNavigator>
/**
* @brief Extends KUrlNavigator in a Dolphin-specific way.
*
* Makes sure that Dolphin preferences and settings are
* applied to all constructed DolphinUrlNavigators.
* @see KUrlNavigator
*
* To apply changes to all instances of this class @see DolphinUrlNavigatorsController.
*/
class DolphinUrlNavigator : public KUrlNavigator
{
Q_OBJECT
public:
/**
* Applies all Dolphin-specific settings to a KUrlNavigator
* @see KUrlNavigator::KurlNavigator()
*/
DolphinUrlNavigator(QWidget *parent = nullptr);
/**
* Applies all Dolphin-specific settings to a KUrlNavigator
* @see KUrlNavigator::KurlNavigator()
*/
DolphinUrlNavigator(const QUrl &url, QWidget *parent = nullptr);
~DolphinUrlNavigator() override;
// TODO: Fix KUrlNavigator::sizeHint() instead.
QSize sizeHint() const override;
/**
* Wraps the visual state of a DolphinUrlNavigator so it can be passed around.
* This notably doesn't involve the locationUrl or history.
*/
struct VisualState {
bool isUrlEditable;
bool hasFocus;
QString text;
int cursorPosition;
int selectionStart;
int selectionLength;
};
/**
* Retrieve the visual state of this DolphinUrlNavigator.
* If two DolphinUrlNavigators have the same visual state they should look identical.
*
* @return a copy of the visualState of this object. Ownership of this copy is transferred
* to the caller via std::unique_ptr.
*/
std::unique_ptr<VisualState> visualState() const;
/**
* @param visualState A struct describing the new visual state of this object.
*/
void setVisualState(const VisualState &visualState);
/**
* Clears the text in the text field
*/
void clearText() const;
/**
* Displays placeholder text in the URL navigator
*/
void setPlaceholderText(const QString &text);
/**
* Sets the visibility of the read-only badge at the end of the breadcrumb.
*/
void setReadOnlyBadgeVisible(bool visible);
/**
* Returns the visibility of the read-only badge at the end of the breadcrumb.
*/
bool readOnlyBadgeVisible() const;
public Q_SLOTS:
/**
* Switches to "breadcrumb" mode if the editable mode is not set to be
* preferred in the Dolphin settings.
*/
void slotReturnPressed();
Q_SIGNALS:
/**
* Escape was pressed, and the focus should return to the view.
*/
void requestToLoseFocus();
protected:
/**
* Return focus back to the view when pressing Escape and this would have no other effect (e.g. deselecting or changing edit mode).
*/
void keyPressEvent(QKeyEvent *keyEvent) override;
};
#endif // DOLPHINURLNAVIGATOR_H
|
