KUrlNavigator

Search for usage in LXR

KUrlNavigator Class Reference

#include <KUrlNavigator>

Inheritance diagram for KUrlNavigator:

Signals

void activated ()
 
void activeTabRequested (const QUrl &url)
 
void editableStateChanged (bool editable)
 
void historyChanged ()
 
void newWindowRequested (const QUrl &url)
 
void returnPressed ()
 
void tabRequested (const QUrl &url)
 
void urlAboutToBeChanged (const QUrl &newUrl)
 
void urlChanged (const QUrl &url)
 
void urlsDropped (const QUrl &destination, QDropEvent *event)
 
void urlSelectionRequested (const QUrl &url)
 

Public Slots

void requestActivation ()
 
void savePosition (int x, int y)
 
void saveRootUrl (const QUrl &url)
 
void setLocationUrl (const QUrl &url)
 
void setUrl (const QUrl &url)
 

Public Member Functions

 KUrlNavigator (KFilePlacesModel *placesModel, const QUrl &url, QWidget *parent)
 
 KUrlNavigator (QWidget *parent=nullptr)
 
QStringList customProtocols () const
 
QWidgetdropWidget () const
 
KUrlComboBoxeditor () const
 
bool goBack ()
 
bool goForward ()
 
void goHome ()
 
bool goUp ()
 
int historyIndex () const
 
int historySize () const
 
QUrl historyUrl (int historyIndex) const
 
QUrl homeUrl () const
 
bool isActive () const
 
bool isPlacesSelectorVisible () const
 
bool isUrlEditable () const
 
QByteArray locationState (int historyIndex=-1) const
 
QUrl locationUrl (int historyIndex=-1) const
 
QPoint savedPosition () const
 
const QUrlsavedRootUrl () const
 
void saveLocationState (const QByteArray &state)
 
void setActive (bool active)
 
void setCustomProtocols (const QStringList &protocols)
 
void setHomeUrl (const QString &homeUrl)
 
void setHomeUrl (const QUrl &url)
 
void setPlacesSelectorVisible (bool visible)
 
void setShowFullPath (bool show)
 
void setShowHiddenFolders (bool showHiddenFolders)
 
void setSortHiddenFoldersLast (bool sortHiddenFoldersLast)
 
void setUrlEditable (bool editable)
 
bool showFullPath () const
 
bool showHiddenFolders () const
 
bool sortHiddenFoldersLast () const
 
QUrl uncommittedUrl () const
 
const QUrlurl () const
 
QUrl url (int index) const
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
 
bool acceptDrops () const const
 
QString accessibleDescription () const const
 
QString accessibleName () const const
 
QList< QAction * > actions () const const
 
void activateWindow ()
 
void addAction (QAction *action)
 
void addActions (QList< QAction * > actions)
 
void adjustSize ()
 
bool autoFillBackground () const const
 
QPalette::ColorRole backgroundRole () const const
 
QBackingStorebackingStore () const const
 
QSize baseSize () const const
 
QWidgetchildAt (const QPoint &p) const const
 
QWidgetchildAt (int x, int y) const const
 
QRect childrenRect () const const
 
QRegion childrenRegion () const const
 
void clearFocus ()
 
void clearMask ()
 
bool close ()
 
QMargins contentsMargins () const const
 
QRect contentsRect () const const
 
Qt::ContextMenuPolicy contextMenuPolicy () const const
 
QCursor cursor () const const
 
void customContextMenuRequested (const QPoint &pos)
 
WId effectiveWinId () const const
 
void ensurePolished () const const
 
Qt::FocusPolicy focusPolicy () const const
 
QWidgetfocusProxy () const const
 
QWidgetfocusWidget () const const
 
const QFontfont () const const
 
QFontInfo fontInfo () const const
 
QFontMetrics fontMetrics () const const
 
QPalette::ColorRole foregroundRole () const const
 
QRect frameGeometry () const const
 
QSize frameSize () const const
 
const QRectgeometry () const const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
 
QPixmap grab (const QRect &rectangle)
 
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
 
QGraphicsEffectgraphicsEffect () const const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const const
 
bool hasEditFocus () const const
 
bool hasFocus () const const
 
virtual bool hasHeightForWidth () const const
 
bool hasMouseTracking () const const
 
bool hasTabletTracking () const const
 
int height () const const
 
virtual int heightForWidth (int w) const const
 
void hide ()
 
Qt::InputMethodHints inputMethodHints () const const
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const const
 
void insertAction (QAction *before, QAction *action)
 
void insertActions (QAction *before, QList< QAction * > actions)
 
bool isActiveWindow () const const
 
bool isAncestorOf (const QWidget *child) const const
 
bool isEnabled () const const
 
bool isEnabledTo (const QWidget *ancestor) const const
 
bool isEnabledToTLW () const const
 
bool isFullScreen () const const
 
bool isHidden () const const
 
bool isMaximized () const const
 
bool isMinimized () const const
 
bool isModal () const const
 
bool isTopLevel () const const
 
bool isVisible () const const
 
bool isVisibleTo (const QWidget *ancestor) const const
 
bool isWindow () const const
 
bool isWindowModified () const const
 
QLayoutlayout () const const
 
Qt::LayoutDirection layoutDirection () const const
 
QLocale locale () const const
 
void lower ()
 
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapFromGlobal (const QPoint &pos) const const
 
QPoint mapFromParent (const QPoint &pos) const const
 
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapToGlobal (const QPoint &pos) const const
 
QPoint mapToParent (const QPoint &pos) const const
 
QRegion mask () const const
 
int maximumHeight () const const
 
QSize maximumSize () const const
 
int maximumWidth () const const
 
int minimumHeight () const const
 
QSize minimumSize () const const
 
virtual QSize minimumSizeHint () const const
 
int minimumWidth () const const
 
void move (const QPoint &)
 
void move (int x, int y)
 
QWidgetnativeParentWidget () const const
 
QWidgetnextInFocusChain () const const
 
QRect normalGeometry () const const
 
void overrideWindowFlags (Qt::WindowFlags flags)
 
virtual QPaintEnginepaintEngine () const const override
 
const QPalettepalette () const const
 
QWidgetparentWidget () const const
 
QPoint pos () const const
 
QWidgetpreviousInFocusChain () const const
 
 QWIDGETSIZE_MAX QWIDGETSIZE_MAX
 
void raise ()
 
QRect rect () const const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void repaint ()
 
void repaint (const QRect &rect)
 
void repaint (const QRegion &rgn)
 
void repaint (int x, int y, int w, int h)
 
void resize (const QSize &)
 
void resize (int w, int h)
 
bool restoreGeometry (const QByteArray &geometry)
 
QByteArray saveGeometry () const const
 
QScreenscreen () const const
 
void scroll (int dx, int dy)
 
void scroll (int dx, int dy, const QRect &r)
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setAttribute (Qt::WidgetAttribute attribute, bool on)
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 
void setContentsMargins (const QMargins &margins)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setDisabled (bool disable)
 
void setEditFocus (bool enable)
 
void setEnabled (bool)
 
void setFixedHeight (int h)
 
void setFixedSize (const QSize &s)
 
void setFixedSize (int w, int h)
 
void setFixedWidth (int w)
 
void setFocus ()
 
void setFocus (Qt::FocusReason reason)
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *w)
 
void setFont (const QFont &)
 
void setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (const QRect &)
 
void setGeometry (int x, int y, int w, int h)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setHidden (bool hidden)
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &bitmap)
 
void setMask (const QRegion &region)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 
void setParent (QWidget *parent)
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 
void setShortcutAutoRepeat (int id, bool enable)
 
void setShortcutEnabled (int id, bool enable)
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *style)
 
void setStyleSheet (const QString &styleSheet)
 
void setTabletTracking (bool enable)
 
void setToolTip (const QString &)
 
void setToolTipDuration (int msec)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 
virtual void setVisible (bool visible)
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlag (Qt::WindowType flag, bool on)
 
void setWindowFlags (Qt::WindowFlags type)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowIconText (const QString &)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowModified (bool)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &role)
 
void setWindowState (Qt::WindowStates windowState)
 
void setWindowTitle (const QString &)
 
void show ()
 
void showFullScreen ()
 
void showMaximized ()
 
void showMinimized ()
 
void showNormal ()
 
QSize size () const const
 
virtual QSize sizeHint () const const
 
QSize sizeIncrement () const const
 
QSizePolicy sizePolicy () const const
 
void stackUnder (QWidget *w)
 
QString statusTip () const const
 
QStylestyle () const const
 
QString styleSheet () const const
 
bool testAttribute (Qt::WidgetAttribute attribute) const const
 
QString toolTip () const const
 
int toolTipDuration () const const
 
QWidgettopLevelWidget () const const
 
bool underMouse () const const
 
void ungrabGesture (Qt::GestureType gesture)
 
void unsetCursor ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void update ()
 
void update (const QRect &rect)
 
void update (const QRegion &rgn)
 
void update (int x, int y, int w, int h)
 
void updateGeometry ()
 
bool updatesEnabled () const const
 
QRegion visibleRegion () const const
 
QString whatsThis () const const
 
int width () const const
 
QWidgetwindow () const const
 
QString windowFilePath () const const
 
Qt::WindowFlags windowFlags () const const
 
QWindowwindowHandle () const const
 
QIcon windowIcon () const const
 
void windowIconChanged (const QIcon &icon)
 
QString windowIconText () const const
 
void windowIconTextChanged (const QString &iconText)
 
Qt::WindowModality windowModality () const const
 
qreal windowOpacity () const const
 
QString windowRole () const const
 
Qt::WindowStates windowState () const const
 
QString windowTitle () const const
 
void windowTitleChanged (const QString &title)
 
Qt::WindowType windowType () const const
 
WId winId () const const
 
int x () const const
 
int y () const const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
 
int depth () const const
 
int devicePixelRatio () const const
 
qreal devicePixelRatioF () const const
 
int height () const const
 
int heightMM () const const
 
int logicalDpiX () const const
 
int logicalDpiY () const const
 
bool paintingActive () const const
 
int physicalDpiX () const const
 
int physicalDpiY () const const
 
int width () const const
 
int widthMM () const const
 

Additional Inherited Members

- Public Types inherited from QWidget
enum  RenderFlag
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
 
- Properties inherited from QWidget
 acceptDrops
 
 accessibleDescription
 
 accessibleName
 
 autoFillBackground
 
 baseSize
 
 childrenRect
 
 childrenRegion
 
 contextMenuPolicy
 
 cursor
 
 enabled
 
 focus
 
 focusPolicy
 
 font
 
 frameGeometry
 
 frameSize
 
 fullScreen
 
 geometry
 
 height
 
 inputMethodHints
 
 isActiveWindow
 
 layoutDirection
 
 locale
 
 maximized
 
 maximumHeight
 
 maximumSize
 
 maximumWidth
 
 minimized
 
 minimumHeight
 
 minimumSize
 
 minimumSizeHint
 
 minimumWidth
 
 modal
 
 mouseTracking
 
 normalGeometry
 
 palette
 
 pos
 
 rect
 
 size
 
 sizeHint
 
 sizeIncrement
 
 sizePolicy
 
 statusTip
 
 styleSheet
 
 tabletTracking
 
 toolTip
 
 toolTipDuration
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
 
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
void setTabOrder (QWidget *first, QWidget *second)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QWidget
 DrawChildren
 
 DrawWindowBackground
 
 IgnoreMask
 
typedef RenderFlags
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Public Attributes inherited from QPaintDevice
 PdmDepth
 
 PdmDevicePixelRatio
 
 PdmDevicePixelRatioScaled
 
 PdmDpiX
 
 PdmDpiY
 
 PdmHeight
 
 PdmHeightMM
 
 PdmNumColors
 
 PdmPhysicalDpiX
 
 PdmPhysicalDpiY
 
 PdmWidth
 
 PdmWidthMM
 
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
 
virtual void changeEvent (QEvent *event)
 
virtual void closeEvent (QCloseEvent *event)
 
virtual void contextMenuEvent (QContextMenuEvent *event)
 
void create (WId window, bool initializeWindow, bool destroyOldWindow)
 
void destroy (bool destroyWindow, bool destroySubWindows)
 
virtual void dragEnterEvent (QDragEnterEvent *event)
 
virtual void dragLeaveEvent (QDragLeaveEvent *event)
 
virtual void dragMoveEvent (QDragMoveEvent *event)
 
virtual void dropEvent (QDropEvent *event)
 
virtual void enterEvent (QEvent *event)
 
virtual bool event (QEvent *event) override
 
virtual void focusInEvent (QFocusEvent *event)
 
bool focusNextChild ()
 
virtual bool focusNextPrevChild (bool next)
 
virtual void focusOutEvent (QFocusEvent *event)
 
bool focusPreviousChild ()
 
virtual void hideEvent (QHideEvent *event)
 
virtual void initPainter (QPainter *painter) const const override
 
virtual void inputMethodEvent (QInputMethodEvent *event)
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void leaveEvent (QEvent *event)
 
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 
virtual void mouseMoveEvent (QMouseEvent *event)
 
virtual void mousePressEvent (QMouseEvent *event)
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 
virtual void moveEvent (QMoveEvent *event)
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
 
virtual void paintEvent (QPaintEvent *event)
 
virtual void resizeEvent (QResizeEvent *event)
 
virtual void showEvent (QShowEvent *event)
 
virtual void tabletEvent (QTabletEvent *event)
 
void updateMicroFocus ()
 
virtual void wheelEvent (QWheelEvent *event)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Widget that allows to navigate through the paths of an URL.

The URL navigator offers two modes:

  • Editable: The URL of the location is editable inside an editor. By pressing RETURN the URL will get activated.
  • Non editable ("breadcrumb view"): The URL of the location is represented by a number of buttons, where each button represents a path of the URL. By clicking on a button the path will get activated. This mode also supports drag and drop of items.

The mode can be changed by clicking on the empty area of the URL navigator. It is recommended that the application remembers the setting or allows to configure the default mode (see KUrlNavigator::setUrlEditable()).

The URL navigator remembers the URL history during navigation and allows to go back and forward within this history.

In the non editable mode ("breadcrumb view") it can be configured whether the full path should be shown. It is recommended that the application remembers the setting or allows to configure the default mode (see KUrlNavigator::setShowFullPath()).

The typical usage of the KUrlNavigator is:

It is recommended, that the application remembers the state of the QAbstractItemView when the URL has been changed. This allows to restore the view state when going back in history. KUrlNavigator offers support for remembering the view state:

Definition at line 69 of file kurlnavigator.h.

Constructor & Destructor Documentation

◆ KUrlNavigator() [1/2]

KUrlNavigator::KUrlNavigator ( QWidget parent = nullptr)
Since
4.5

Definition at line 907 of file kurlnavigator.cpp.

◆ KUrlNavigator() [2/2]

KUrlNavigator::KUrlNavigator ( KFilePlacesModel placesModel,
const QUrl url,
QWidget parent 
)
Parameters
placesModelModel for the places which are selectable inside a menu. A place can be a bookmark or a device. If it is 0, no places selector is displayed.
urlURL which is used for the navigation or editing.
parentParent widget.

Definition at line 912 of file kurlnavigator.cpp.

Member Function Documentation

◆ activated

void KUrlNavigator::activated ( )
signal

Is emitted, if the URL navigator has been activated by an user interaction.

See also
KUrlNavigator::setActive()

◆ activeTabRequested

void KUrlNavigator::activeTabRequested ( const QUrl url)
signal

Is emitted if the URL url should be opened in a new active tab because the user clicked on a breadcrumb with the middle mouse button with the shift modifier pressed or left-clicked with both the ctrl and shift modifiers pressed.

Since
5.89

◆ customProtocols()

QStringList KUrlNavigator::customProtocols ( ) const
Returns
The custom protocols if they are set, QStringList() otherwise.

Definition at line 1214 of file kurlnavigator.cpp.

◆ dropWidget()

QWidget * KUrlNavigator::dropWidget ( ) const

The child widget that received the QDropEvent when dropping on the URL navigator.

You can pass this widget to KJobWidgets::setWindow() if you need to show a drop menu with KIO::drop().

Returns
Child widget that has received the last drop event, or nullptr if nothing has been dropped yet on the URL navigator.
Since
5.37
See also
KIO::drop()

Definition at line 1219 of file kurlnavigator.cpp.

◆ editableStateChanged

void KUrlNavigator::editableStateChanged ( bool  editable)
signal

Is emitted, if the editable state for the URL has been changed (see KUrlNavigator::setUrlEditable()).

◆ editor()

KUrlComboBox * KUrlNavigator::editor ( ) const
Returns
The used editor when the navigator is in the edit mode
See also
KUrlNavigator::setUrlEditable()

Definition at line 1203 of file kurlnavigator.cpp.

◆ goBack()

bool KUrlNavigator::goBack ( )

Goes back one step in the URL history.

The signals KUrlNavigator::urlAboutToBeChanged(), KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged() are emitted if true is returned. False is returned if the beginning of the history has already been reached and hence going back was not possible. The history index (see KUrlNavigator::historyIndex()) is increased by one if the operation was successful.

Definition at line 950 of file kurlnavigator.cpp.

◆ goForward()

bool KUrlNavigator::goForward ( )

Goes forward one step in the URL history.

The signals KUrlNavigator::urlAboutToBeChanged(), KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged() are emitted if true is returned. False is returned if the end of the history has already been reached and hence going forward was not possible. The history index (see KUrlNavigator::historyIndex()) is decreased by one if the operation was successful.

Definition at line 955 of file kurlnavigator.cpp.

◆ goHome()

void KUrlNavigator::goHome ( )

Goes to the home URL and remembers the old URL in the history.

The signals KUrlNavigator::urlAboutToBeChanged(), KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged() are emitted.

See also
KUrlNavigator::setHomeUrl()

Definition at line 965 of file kurlnavigator.cpp.

◆ goUp()

bool KUrlNavigator::goUp ( )

Goes up one step of the URL path and remembers the old path in the history.

The signals KUrlNavigator::urlAboutToBeChanged(), KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged() are emitted if true is returned. False is returned if going up was not possible as the root has been reached.

Definition at line 960 of file kurlnavigator.cpp.

◆ historyChanged

void KUrlNavigator::historyChanged ( )
signal

Is emitted, if the history has been changed.

Usually the history is changed if a new URL has been selected.

◆ historyIndex()

int KUrlNavigator::historyIndex ( ) const
Returns
The history index of the current location, where 0 <= history index < KUrlNavigator::historySize(). 0 is the most recent history entry.

Definition at line 1198 of file kurlnavigator.cpp.

◆ historySize()

int KUrlNavigator::historySize ( ) const
Returns
The amount of locations in the history. The data for each location can be retrieved by KUrlNavigator::locationUrl() and KUrlNavigator::locationState().

Definition at line 1193 of file kurlnavigator.cpp.

◆ historyUrl()

QUrl KUrlNavigator::historyUrl ( int  historyIndex) const
Returns
URL for the history element with the index historyIndex. The history index 0 represents the most recent URL.
Since
4.3
Deprecated:
Since 4.5, use KUrlNavigator::locationUrl(historyIndex) instead.

Definition at line 1266 of file kurlnavigator.cpp.

◆ isActive()

bool KUrlNavigator::isActive ( ) const
Returns
True, if the URL navigator is in the active mode.
See also
KUrlNavigator::setActive()

Definition at line 1026 of file kurlnavigator.cpp.

◆ isPlacesSelectorVisible()

bool KUrlNavigator::isPlacesSelectorVisible ( ) const
Returns
True, if the places selector is visible.

Definition at line 1047 of file kurlnavigator.cpp.

◆ isUrlEditable()

bool KUrlNavigator::isUrlEditable ( ) const
Returns
True, if the URL is editable within a line editor. If false is returned, each part of the URL is presented by a button for fast navigation ("breadcrumb view").

Definition at line 991 of file kurlnavigator.cpp.

◆ locationState()

QByteArray KUrlNavigator::locationState ( int  historyIndex = -1) const
Returns
Location state given by historyIndex. If historyIndex is smaller than 0, the state of the current location is returned.
See also
KUrlNavigator::saveLocationState()
Since
4.5

Definition at line 945 of file kurlnavigator.cpp.

◆ locationUrl()

QUrl KUrlNavigator::locationUrl ( int  historyIndex = -1) const
Returns
URL of the location given by the historyIndex. If historyIndex is smaller than 0, the URL of the current location is returned.
Since
4.5

Definition at line 933 of file kurlnavigator.cpp.

◆ newWindowRequested

void KUrlNavigator::newWindowRequested ( const QUrl url)
signal

Is emitted if the URL url should be opened in a new window because the user left-clicked on a breadcrumb with the shift modifier pressed.

Since
5.89

◆ requestActivation

void KUrlNavigator::requestActivation ( )
slot

Activates the URL navigator (KUrlNavigator::isActive() will return true) and emits the signal KUrlNavigator::activated().

See also
KUrlNavigator::setActive()

Definition at line 1072 of file kurlnavigator.cpp.

◆ returnPressed

void KUrlNavigator::returnPressed ( )
signal

This signal is emitted when the Return or Enter key is pressed.

◆ savedPosition()

QPoint KUrlNavigator::savedPosition ( ) const
Returns
The saved contents position of the upper left corner for the current URL.
Deprecated:
Since 4.5, use KUrlNavigator::locationState() instead.

Definition at line 1287 of file kurlnavigator.cpp.

◆ savedRootUrl()

const QUrl & KUrlNavigator::savedRootUrl ( ) const
Returns
The saved root URL for the current URL (see KUrlNavigator::saveRootUrl()).
Deprecated:
Since 4.5, use KUrlNavigator::locationState() instead.

Definition at line 1274 of file kurlnavigator.cpp.

◆ saveLocationState()

void KUrlNavigator::saveLocationState ( const QByteArray state)

Saves the location state described by state for the current location.

It is recommended that at least the scroll position of a view is remembered and restored when traversing through the history. Saving the location state should be done when the signal KUrlNavigator::urlAboutToBeChanged() has been emitted. Restoring the location state (see KUrlNavigator::locationState()) should be done when the signal KUrlNavigator::urlChanged() has been emitted.

Example:

QByteArray state;
data << QPoint(x, y);
data << ...;
...
urlNavigator->saveLocationState(state);
Since
4.5

Definition at line 938 of file kurlnavigator.cpp.

◆ savePosition

void KUrlNavigator::savePosition ( int  x,
int  y 
)
slot

Saves the coordinates of the contents for the current history element.

Deprecated:
Since 4.5, use KUrlNavigator::saveLocationState() instead.

Definition at line 1104 of file kurlnavigator.cpp.

◆ saveRootUrl

void KUrlNavigator::saveRootUrl ( const QUrl url)
slot

Saves the used root URL of the content for the current history element.

Deprecated:
Since 4.5, use KUrlNavigator::saveLocationState() instead.

Definition at line 1095 of file kurlnavigator.cpp.

◆ setActive()

void KUrlNavigator::setActive ( bool  active)

Set the URL navigator to the active mode, if active is true.

The active mode is default. The inactive mode only differs visually from the active mode, no change of the behavior is given.

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.

Definition at line 1009 of file kurlnavigator.cpp.

◆ setCustomProtocols()

void KUrlNavigator::setCustomProtocols ( const QStringList protocols)

If an application supports only some special protocols, they can be set with protocols .

Definition at line 1208 of file kurlnavigator.cpp.

◆ setHomeUrl() [1/2]

void KUrlNavigator::setHomeUrl ( const QString homeUrl)
Deprecated:
Since 4.5, use setHomeUrl(const QUrl& url) instead.

Definition at line 1296 of file kurlnavigator.cpp.

◆ setHomeUrl() [2/2]

void KUrlNavigator::setHomeUrl ( const QUrl url)

Sets the home URL used by KUrlNavigator::goHome().

If no home URL is set, the default home path of the user is used.

Since
4.5

Definition at line 974 of file kurlnavigator.cpp.

◆ setLocationUrl

void KUrlNavigator::setLocationUrl ( const QUrl url)
slot

Sets the location to url.

The old URL is added to the history. The signals KUrlNavigator::urlAboutToBeChanged(), KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged() are emitted. Use KUrlNavigator::locationUrl() to read the location.

Since
4.5

Definition at line 1063 of file kurlnavigator.cpp.

◆ setPlacesSelectorVisible()

void KUrlNavigator::setPlacesSelectorVisible ( bool  visible)

Sets the places selector visible, if visible is true.

The places selector allows to select the places provided by the places model passed in the constructor. Per default the places selector is visible.

Definition at line 1031 of file kurlnavigator.cpp.

◆ setShowFullPath()

void KUrlNavigator::setShowFullPath ( bool  show)

Shows the full path of the URL even if a place represents a part of the URL.

Assuming that a place called "Pictures" uses the URL /home/user/Pictures. An URL like /home/user/Pictures/2008 is shown as [Pictures] > [2008] in the breadcrumb view, if showing the full path is turned off. If showing the full path is turned on, the URL is shown as [/] > [home] > [Pictures] > [2008].

Since
4.2

Definition at line 996 of file kurlnavigator.cpp.

◆ setShowHiddenFolders()

void KUrlNavigator::setShowHiddenFolders ( bool  showHiddenFolders)

Sets whether to show hidden folders in the subdirectories popup.

Since
5.87

Definition at line 1224 of file kurlnavigator.cpp.

◆ setSortHiddenFoldersLast()

void KUrlNavigator::setSortHiddenFoldersLast ( bool  sortHiddenFoldersLast)

Sets whether to sort hidden folders in the subdirectories popup last.

Since
5.87

Definition at line 1234 of file kurlnavigator.cpp.

◆ setUrl

void KUrlNavigator::setUrl ( const QUrl url)
slot

Sets the location to url.

Deprecated:
Since 4.5, use KUrlNavigator::setLocationUrl(url).

Definition at line 1087 of file kurlnavigator.cpp.

◆ setUrlEditable()

void KUrlNavigator::setUrlEditable ( bool  editable)

Allows to edit the URL of the navigation bar if editable is true, and sets the focus accordingly.

If editable is false, each part of the URL is presented by a button for a fast navigation ("breadcrumb view").

Definition at line 984 of file kurlnavigator.cpp.

◆ showFullPath()

bool KUrlNavigator::showFullPath ( ) const
Returns
True, if the full path of the URL should be shown in the breadcrumb view.
Since
4.2

Definition at line 1004 of file kurlnavigator.cpp.

◆ showHiddenFolders()

bool KUrlNavigator::showHiddenFolders ( ) const

Returns whether to show hidden folders in the subdirectories popup.

Since
5.87

Definition at line 1229 of file kurlnavigator.cpp.

◆ sortHiddenFoldersLast()

bool KUrlNavigator::sortHiddenFoldersLast ( ) const

Returns whether to sort hidden folders in the subdirectories popup last.

Since
5.87

Definition at line 1239 of file kurlnavigator.cpp.

◆ tabRequested

void KUrlNavigator::tabRequested ( const QUrl url)
signal

Is emitted if the URL url should be opened in a new inactive tab because the user clicked on a breadcrumb with the middle mouse button or left-clicked with the ctrl modifier pressed.

Since
4.5

◆ uncommittedUrl()

QUrl KUrlNavigator::uncommittedUrl ( ) const
Returns
The currently entered, but not accepted URL. It is possible that the returned URL is not valid.

Definition at line 1052 of file kurlnavigator.cpp.

◆ url() [1/2]

const QUrl & KUrlNavigator::url ( ) const
Returns
The current URL of the location.
Deprecated:
Since 4.5, use KUrlNavigator::locationUrl() instead.

Definition at line 1245 of file kurlnavigator.cpp.

◆ url() [2/2]

QUrl KUrlNavigator::url ( int  index) const
Returns
The portion of the current URL up to the path part given by index. Assuming that the current URL is /home/peter/Documents/Music, then the following URLs are returned for an index:
  • index <= 0: /home
  • index is 1: /home/peter
  • index is 2: /home/peter/Documents
  • index >= 3: /home/peter/Documents/Music
Deprecated:
Since 4.5. It should not be necessary for a client of KUrlNavigator to query this information.

Definition at line 1258 of file kurlnavigator.cpp.

◆ urlAboutToBeChanged

void KUrlNavigator::urlAboutToBeChanged ( const QUrl newUrl)
signal

Is emitted, before the location URL is going to be changed to newUrl.

The signal KUrlNavigator::urlChanged() will be emitted after the change has been done. Connecting to this signal is useful to save the state of a view with KUrlNavigator::saveLocationState().

Since
4.5

◆ urlChanged

void KUrlNavigator::urlChanged ( const QUrl url)
signal

Is emitted, if the location URL has been changed e.

g. by the user.

See also
KUrlNavigator::setUrl()

◆ urlsDropped

void KUrlNavigator::urlsDropped ( const QUrl destination,
QDropEvent event 
)
signal

Is emitted if a dropping has been done above the destination destination.

The receiver must accept the drop event if the dropped data can be handled.

Since
4.2

◆ urlSelectionRequested

void KUrlNavigator::urlSelectionRequested ( const QUrl url)
signal

When the URL is changed and the new URL (e.g. /home/user1/) is a parent of the previous URL (e.g. /home/user1/data/stuff), then this signal is emitted and url is set to the child directory of the new URL which is an ancestor of the old URL (in the example paths this would be /home/user1/data/).

This signal allows file managers to pre-select the directory that the user is navigating up from.

Since
5.37.0

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Tue Dec 6 2022 03:56:08 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.