#include <QPushButton>
#include <QWidget>
+#include <initializer_list>
+
namespace Admin
{
class Bar;
class QAction;
class QGridLayout;
class QUrl;
-class DolphinSearchBox;
+namespace Search
+{
+class Bar;
+}
class DolphinStatusBar;
+class KFileItemList;
namespace SelectionMode
{
class TopBar;
}
+/**
+ * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
+ */
+bool isSearchUrl(const QUrl &url);
+
/**
* @short Represents a view for the directory content
* including the navigation bar, filter bar and status bar.
* as soon as the URL has been changed. Per default the grabbing
* of the focus is enabled.
*/
- void setAutoGrabFocus(bool grab);
- bool autoGrabFocus() const;
-
- QString currentSearchText() const;
+ void setGrabFocusOnUrlChange(bool grabFocus);
const DolphinStatusBar *statusBar() const;
DolphinStatusBar *statusBar();
*/
void disconnectUrlNavigator();
+ /**
+ * Sets the visibility of this objects search configuration user interface. This search bar is the primary interface in Dolphin to search for files and
+ * folders.
+ *
+ * The signal searchBarVisibilityChanged will be emitted when the new visibility state is different from the old.
+ *
+ * Typically an animation will play when the search bar is shown or hidden, so the visibility of the bar will not necessarily match @p visible when this
+ * method returns. Instead use isSearchBarVisible(), which will always communicate the visibility state the search bar is heading to.
+ *
+ * @see Search::Bar.
+ * @see isSearchBarVisible().
+ */
+ void setSearchBarVisible(bool visible);
+
+ /** @returns true if the search bar is visible while not being in the process to hide itself. */
+ bool isSearchBarVisible() const;
+
+ /**
+ * Moves keyboard focus to the search bar. The search term is fully selected to allow easy replacing.
+ */
+ void setFocusToSearchBar();
+
/**
* Sets a selection mode that is useful for quick and easy selecting or deselecting of files.
* This method is the central authority about enabling or disabling selection mode:
/**
* Shows the message \message with the given type \messageType non-modal above the view-content.
+ * \buttonActions defines actions which the user can trigger as a response to this message. They are presented as buttons below the \message.
*/
- void showMessage(const QString &message, KMessageWidget::MessageType messageType);
+ void showMessage(const QString &message, KMessageWidget::MessageType messageType, std::initializer_list<QAction *> buttonActions = {});
+
+ /**
+ * Forwards to DolphinStatusBar::showProgress(). Only exception: The button to cancel the task is hidden.
+ * @see DolphinStatusBar::showProgress().
+ */
+ void showProgress(const QString ¤tlyRunningTaskTitle, int progressPercent);
/**
* Refreshes the view container to get synchronized with the (updated) Dolphin settings.
* false, if it is hidden or currently animating towards a hidden state. */
bool isFilterBarVisible() const;
- /** Returns true if the search mode is enabled. */
- bool isSearchModeEnabled() const;
-
/**
* @return Text that should be used for the current URL when creating
* a new place.
*/
void setFilterBarVisible(bool visible);
- /**
- * Enables the search mode, if \p enabled is true. In the search mode the URL navigator
- * will be hidden and replaced by a line editor that allows to enter a search term.
- */
- void setSearchModeEnabled(bool enabled);
-
/** Used to notify the m_selectionModeBottomBar that there is no other ViewContainer in the tab. */
void slotSplitTabDisabled();
*/
void showFilterBarChanged(bool shown);
/**
- * Is emitted whenever the search mode has changed its state.
+ * Is emitted whenever a change to the search bar's visibility is invoked. The visibility change might not have actually already taken effect by the time
+ * this signal is emitted because typically the showing and hiding is animated.
+ * @param visible The visibility state the search bar is going to end up at.
+ * @see Search::Bar.
+ * @see setSearchBarVisible().
+ * @see isSearchBarVisible().
*/
- void searchModeEnabledChanged(bool enabled);
+ void searchBarVisibilityChanged(bool visible);
void selectionModeChanged(bool enabled);
*/
void showItemInfo(const KFileItem &item);
- /**
- * Sets the Admin::Bar visible or invisible based on whether \a url is an admin url.
- */
- void updateAdminBarVisibility(const QUrl &url);
-
void closeFilterBar();
/**
/** Requests the focus for the view \a m_view. */
void requestFocus();
- /**
- * Gets the search URL from the searchbox and starts searching.
- */
- void startSearching();
- void openSearchBox();
- void closeSearchBox();
-
/**
* Stops the loading of a directory. Is connected with the "stopPressed" signal
* from the statusbar.
void slotStatusBarZoomLevelChanged(int zoomLevel);
+ /**
+ * Creates and shows an error message based on \p message and \p kioErrorCode.
+ */
+ void slotErrorMessageFromView(const QString &message, const int kioErrorCode);
+
/**
* Slot that calls showMessage(message, KMessageWidget::Error).
*/
void slotOpenUrlFinished(KJob *job);
private:
- /**
- * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
- */
- bool isSearchUrl(const QUrl &url) const;
-
/**
* Saves the state of the current view: contents position,
* root URL, ...
*/
QString getNearestExistingAncestorOfPath(const QString &path) const;
+ /**
+ * Update the geometry of statusbar depending on what mode it is using.
+ */
+ void updateStatusBarGeometry();
+
+ /**
+ * @return Preferred geometry of the small statusbar.
+ */
+ QRect preferredSmallStatusBarGeometry();
+
+protected:
+ bool eventFilter(QObject *object, QEvent *event) override;
+
private:
QGridLayout *m_topLayout;
*/
QPointer<DolphinUrlNavigator> m_urlNavigatorConnected;
- DolphinSearchBox *m_searchBox;
+ Search::Bar *m_searchBar;
bool m_searchModeEnabled;
/// A bar shown at the top of the view to signify that the view is currently viewed and acted on with elevated privileges.
Admin::Bar *m_adminBar;
+ /// An action to switch to the admin protocol. This variable will always be nullptr unless kio-admin was installed. @see Admin::WorkerIntegration.
+ QAction *m_authorizeToEnterFolderAction;
KMessageWidget *m_messageWidget;
DolphinStatusBar *m_statusBar;
QTimer *m_statusBarTimer; // Triggers a delayed update
QElapsedTimer m_statusBarTimestamp; // Time in ms since last update
- bool m_autoGrabFocus;
+ bool m_grabFocusOnUrlChange;
/**
* The visual state to be applied to the next UrlNavigator that gets
* connected to this ViewContainer.
projects / dolphin.git / blobdiff