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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/***************************************************************************
* Copyright (C) 2006 by Peter Penz (<[email protected]>) *
* Copyright (C) 2006 by Aaron J. Seigo (<[email protected]>) *
* Copyright (C) 2006 by Patrice Tremblay *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
#ifndef URLNAVIGATOR_H
#define URLNAVIGATOR_H
#include <kurl.h>
#include <QWidget>
class KBookmarkManager;
class QMouseEvent;
/**
* @brief Navigation bar which contains the current shown URL.
*
* The URL navigator offers two modes:
* - Editable: Represents the 'classic' mode, where the current URL
* is editable inside a line editor.
* - Non editable: The URL is represented by a number of buttons, where
* clicking on a button results in activating the URL
* the button represents. This mode also supports drag
* and drop of items.
*
* The mode can be changed by a toggle button located on the left side of
* the navigator.
*
* The URL navigator also remembers the URL history and allows to go
* back and forward within this history.
*/
class UrlNavigator : public QWidget
{
Q_OBJECT
public:
UrlNavigator(KBookmarkManager* bookmarkManager, const KUrl& url, QWidget* parent);
virtual ~UrlNavigator();
/** Returns the current active URL. */
const KUrl& url() const;
/** Returns the portion of the current active URL up to the button at index. */
KUrl url(int index) const;
/** Returns the amount of items in the history */
int historySize() const;
/** Returns the saved position from the history */
QPoint savedPosition() const;
/**
* Goes back one step in the URL history. The signals
* UrlNavigator::urlChanged and UrlNavigator::historyChanged
* are submitted.
*/
void goBack();
/**
* Goes forward one step in the URL history. The signals
* UrlNavigator::urlChanged and UrlNavigator::historyChanged
* are submitted.
*/
void goForward();
/**
* Goes up one step of the URL path. The signals
* UrlNavigator::urlChanged and UrlNavigator::historyChanged
* are submitted.
*/
void goUp();
/**
* Goes to the home URL. The signals UrlNavigator::urlChanged
* and UrlNavigator::historyChanged are submitted.
*/
void goHome();
/**
* Sets the home URL used by goHome().
*/
void setHomeUrl(const QString& homeUrl);
/**
* @return True, if the URL is editable by the user within a line editor.
* If false is returned, each part of the URL is presented by a button
* for fast navigation.
*/
bool isUrlEditable() const;
/**
* Allows to edit the URL of the navigation bar if \a editable
* is true, and sets the focus accordingly.
* If \a editable is false, each part of
* the URL is presented by a button for a fast navigation.
*/
void setUrlEditable(bool editable);
/**
* Set the URL navigator to the active mode, if \a active
* is true. The active mode is default. Using the URL navigator
* in the inactive mode is useful when having split views,
* where the inactive view is indicated by an inactive URL
* navigator visually.
*/
void setActive(bool active);
/**
* Returns true, if the URL navigator is in the active mode.
* @see UrlNavigator::setActive()
*/
bool isActive() const;
/**
* Sets whether or not to show hidden files in lists
*/
void setShowHiddenFiles( bool show );
/**
* Returns true if the URL navigator is set to show hidden files
*/
bool showHiddenFiles() const; // TODO rename, looks like a verb
/**
* Handles the dropping of the URLs \a urls to the given
* destination \a destination and emits the signal urlsDropped.
*/
void dropUrls(const KUrl::List& urls,
const KUrl& destination);
public slots:
/**
* Sets the current active URL.
* The signals UrlNavigator::urlChanged and UrlNavigator::historyChanged
* are submitted.
*/
void setUrl(const KUrl& url);
/**
* Activates the URL navigator (UrlNavigator::isActive() will return true)
* and emits the signal 'activationChanged()'.
*/
void requestActivation();
/**
* Stores the coordinates of the contents into
* the current history element.
*/
void storeContentsPosition(int x, int y);
signals:
/**
* Is emitted, if the URL navigator has been activated by
* a user interaction.
*/
void activated();
/**
* Is emitted, if the URL has been changed e. g. by
* the user.
* @see setUrl()
*/
void urlChanged(const KUrl& url);
/**
* Is emitted, if the history has been changed. Usually
* the history is changed if a new URL has been selected.
*/
void historyChanged();
/**
* Is emitted if the URLs \a urls have been dropped
* to the destination \a destination.
*/
void urlsDropped(const KUrl::List& urls,
const KUrl& destination);
protected:
/**
* If the Escape key is pressed, the navigation bar should switch
* to the browse mode.
*/
virtual void keyReleaseEvent(QKeyEvent* event);
/**
* Paste the clipboard content as URL, if the middle mouse
* button has been clicked.
*/
virtual void mouseReleaseEvent(QMouseEvent* event);
private:
Q_PRIVATE_SLOT(d, void slotReturnPressed(const QString& text))
Q_PRIVATE_SLOT(d, void slotRemoteHostActivated())
Q_PRIVATE_SLOT(d, void slotProtocolChanged(const QString& protocol))
Q_PRIVATE_SLOT(d, void switchView())
//Q_PRIVATE_SLOT(d, void slotRedirection(const KUrl&, const KUrl&))
private:
class Private;
Private* const d;
Q_DISABLE_COPY( UrlNavigator )
};
#endif
|
