Namespace sh::ui¶

namespace sh::ui

User interface.

This is the presentation layer. The classes directly from here are abstract; often even technically, but clearly from conceptual perspective. Find non-abstract user interface implementations in sub-namespaces.

Typedefs

typedef QList<sh::ui::FilePropertyDialogTabActionsView*> TabViewStructWidgets

typedef QPair<std::shared_ptr<sh::ui::FilePropertyDialogTab>, TabViewStructWidgets> TabViewStruct

Enums

enum ExceptionDialogResult

Enumeration of decisions the user can make in an ExceptionDialog.

Values:

enumerator Shutdown

enumerator Close

enumerator Cancel

enumerator Retry

enum FileViewMode

Values:

enumerator IconView

enumerator ListView

class _ActionExecutionInfoPanel_HelperQObject : public QObject

#include <actionexecutioninfopanel.h>

A helper for some signal/slot stuff of in ActionExecutionInfoPanel.

Public Functions

void _emit_clicked()

void _emit_visibilityChanged()

Signals

void clicked()

void visibilityChanged()

class _FilePropertyDialogTabActionsView_HelperQObject : public QObject

#include <filepropertydialogtabactionsview.h>

A helper for some signal/slot stuff of in FilePropertyDialogTabActionsView.

Public Functions

void _emit_buttonTriggered(int i)

Signals

void buttonTriggered(int i)

class _MainWindow_HelperQObject : public QObject

#include <mainwindow.h>

A helper for some signal/slot stuff of in MainWindow.

Public Functions

void _emit_currentDirectoryChanged()

void _emit_globalViewOptionsChanged()

void _emit_currentProfileChanged()

void _emit_currentFileViewChanged()

void _emit_fileViewCountChanged()

void _emit_fileViewOptionsChanged(int i)

Signals

void currentDirectoryChanged()

void globalViewOptionsChanged()

void currentProfileChanged()

void currentFileViewChanged()

void fileViewCountChanged()

void fileViewOptionsChanged(int)

class _SearchPanelConfiguration_HelperQObject : public QObject: #include <searchpanelconfiguration.h>
A helper for some signal/slot stuff of in SearchPanelConfiguration.

class AboutDialog : public sh::ui::Dialog

#include <aboutdialog.h>

The ‘About’ dialog.

Subclassed by sh::ui::qt::QtAboutDialog, sh::ui::web::WebAboutDialog

Public Functions

AboutDialog()

qint64 dialogId()

Returns the dialog id.

Each instance has an id unique in the complete Shallot process lifetime.

Must be called in main thread.

bool isInited()

Returns if this dialog is initialized.

Must be called in main thread.

bool wasAccepted()

Returns if this dialog was ‘accepted’ by the user (typically by clicking some ‘OK’ button).

Must be called in main thread.

void waitClosed()

Wait until the user closed the dialog in some way.

May be called in any thread.

void close()

Closes the dialog.

Must be called in main thread.

bool wasClosed()

Returns if this dialog was closed.

Must be called in main thread.

DialogManager *manager(): Returns the DialogManager which hosts this dialog.

class ActionExecutionInfoDialog : public sh::actions::ActionExecutionUserFeedback

#include <actionexecutioninfodialog.h>

Progress dialog for action executions.

Subclassed by sh::ui::qt::QtActionExecutionInfoDialog, sh::ui::web::WebActionExecutionInfoDialog

Public Types

enum MessageBoxButton

Buttons in a message box from ActionExecutionUserFeedback.

Values:

enumerator NONE = 0

enumerator OK = 1 << 0

enumerator Continue = 1 << 1

enumerator Cancel = 1 << 2

enumerator Retry = 1 << 3

enumerator Yes = 1 << 4

enumerator No = 1 << 5

Public Functions

ActionExecutionInfoDialog(sh::actions::ActionExecutionInfo *info)

void setDetails(QString fv, QString fob, QString tv, QString tob) = 0: Sets the item details text (‘from a/foo.jpg’, ‘to b/foo.jpg’). .

void setHead(QString txt) = 0: Sets the header text. .

void setProgress(bool isDeterminate, quint64 done, quint64 all, QString text) = 0: Sets the progress. .

bool isLogicallyVisible(): Returns if this dialog is logically visible (i.e. set visible by the action).

void setLogicallyVisible(bool v): Sets if this dialog is logically visible (i.e. set visible by the action). .

bool isBackground(): Returns if this dialog is currently in background mode (i.e. not visible).

void setBackground(bool v): Sets if this dialog is currently in background mode (i.e. not visible). .

void setForceForeground(bool v): Sets if this dialog is currently forced to be visible in foreground. .

int messageBox(QString text, QList<QString> answers, QString icon = QString(), int defaultanswer = -1, int cancelanswer = -1, QList<QString> answericons = QList<QString>()) = 0

int inputBox(QString text, QList<QString> answers, QString *value, QString icon = QString(), int defaultanswer = -1, int cancelanswer = -1, int valuePreselectFrom = -1, int valuePreselectTo = -1) = 0

int multilineInputBox(QString text, QList<QString> answers, QString *value, QString icon = QString(), int defaultanswer = -1, int cancelanswer = -1) = 0

int simpleChooserGridform(QString text, GridformEntries *entries, QStringList answers, int defaultanswer = -1, int cancelanswer = -1) = 0

bool credentialsDialog(QString text, bool showDomain, bool showUsername, bool showPassword, bool showAnonymous, bool showRemember, QString *domain, QString *username, QString *password, bool *isAnonymous, bool *isRemember) = 0

bool unixPermissionsDialog(bool *userMayRead, bool *userMayWrite, bool *userMayExecute, bool *groupMayRead, bool *groupMayWrite, bool *groupMayExecute, bool *othersMayRead, bool *othersMayWrite, bool *othersMayExecute, bool *sticky, bool *setuid, bool *setgid, QStringList users, QStringList groups, QString *ownerUser, QString *ownerGroup) = 0

QString simpleInputBox(QString text, QString deflt, int valuePreselectFrom = -1, int valuePreselectTo = -1)

int simpleMessageBox(QString text, int buttons = (int)MessageBoxButton::OK, QString icon = QString(), int defaultbutton = (MessageBoxButton)0, int cancelbutton = (MessageBoxButton)0)

class ActionExecutionInfoPanel

#include <actionexecutioninfopanel.h>

Abstract class for a status bar info-panel for an action execution.

Subclassed by sh::ui::qt::QtActionExecutionInfoPanel, sh::ui::web::WebActionExecutionInfoPanel

Public Functions

void setLabel(QString s) = 0: Sets the label text. .

void setProgress(bool isProgressDeterminate, quint64 progressDone, quint64 progressAll) = 0: Sets the progress. .

void setForceForeground(bool v) = 0: Sets if the associated action is currently forced to be visible in foreground. .

void setPanelVisible(bool v) = 0: Sets if the panel is visible. .

void setWidth(int width) = 0: Sets the panel with (in pixels). .

void onClicked(std::function<void()> fctQObject *owner = 0, ): Sets a handler for a click on the button (optionally bound to an owner lifetime).

void onDestroyed(std::function<void()> fctQObject *owner = 0, ): Sets a handler for panel removal (optionally bound to an owner lifetime).

void onVisibilityChanged(std::function<void()> fctQObject *owner = 0, ): Sets a handler for panel visibility changes (optionally bound to an owner lifetime).

~ActionExecutionInfoPanel()

class ColumnDimensions

#include <columndimensions.h>

Auxiliary data structure for persistent column dimensions.

It stores the width of a column whenever it changes and restores it when needed (mostly when Shallot starts).

Public Functions

ColumnDimensions(int index): Constructed only by the infrastructure and made available otherwise.

void store()

bool remove()

void setWidth(QString col, int width)

int getWidth(QString col, int defaultval)

Public Members

int index

Private Functions

std::unique_ptr<QSettings> db()

Private Members

QHash<QString, int> dims

class Dialog : public std::enable_shared_from_this<Dialog>

#include <dialog.h>

Abstract subclass for Shallot dialogs (in child windows).

Subclasses of Dialog represent particular dialog types (like ManageBookmarksDialog).

For each ui mode, there typically is an implementation for all of these types, implementing one of this dialog types subclasses (mentioned before) and also some ui mode specific class.

Note: Unless stated otherwise, all methods must be called from main thread!

Note: It’s not allowed to show one web dialog instance more than once. After closing it, it’s sole use is to fetch answer data from it.

Note: You should not create instances directly. It’s required to use DialogManager::createAndShowDialog() for actually showing those dialogs. Even this should not be used directly, because call depends on the current ui mode. Use the show*() methods in sh::ui::MainWindow for creating dialogs in a ui mode independent way.

Subclassed by sh::ui::AboutDialog, sh::ui::ExceptionDialog, sh::ui::FilePropertyDialog, sh::ui::LogViewDialog, sh::ui::ManageBookmarksDialog, sh::ui::ManageProfilesDialog, sh::ui::OpenWithDialog, sh::ui::StoreProfileDialog, sh::ui::TuningDialog

Public Functions

Dialog()

~Dialog()

qint64 dialogId()

Returns the dialog id.

Each instance has an id unique in the complete Shallot process lifetime.

Must be called in main thread.

bool isInited()

Returns if this dialog is initialized.

Must be called in main thread.

bool wasAccepted()

Returns if this dialog was ‘accepted’ by the user (typically by clicking some ‘OK’ button).

Must be called in main thread.

void waitClosed()

Wait until the user closed the dialog in some way.

May be called in any thread.

void close()

Closes the dialog.

Must be called in main thread.

bool wasClosed()

Returns if this dialog was closed.

Must be called in main thread.

DialogManager *manager(): Returns the DialogManager which hosts this dialog.

Private Functions

void setup(DialogManager *manager, qint64 dialogId): Sets manager and id for this dialog (right after creation).

Private Members

DialogManager *_manager

qint64 _dialogId = -1

bool _closed = false

bool _inited = false

Friends

friend class MainWindow

friend class DialogManager

class DialogManager

#include <dialog.h>

Creates and drives dialogs (in child windows), i.e. instances of Dialog.

Subclass it for implementing the low level mechanisms for handling dialogs in a particular ui mode (e.g. qt, web).

The infrastructure will use one of this implementations for creating and managing most kinds of dialogs.

Subclassed by sh::ui::qt::QtDialogManager, sh::ui::web::WebDialogManager

Public Functions

std::shared_ptr<Dialog> getDialogById(qint64 id)

Returns a Dialog by dialog id.

Must be called in main thread.

QList<std::shared_ptr<Dialog>> getAllDialogs()

Returns a list of all dialogs currently shown (in order of creation).

Must be called in main thread.

QList<qint64> getAllDialogIds()

Returns a list of dialog ids of all dialogs currently shown (in order of creation).

Must be called in main thread.

template<class TDlg, typename ...Args> std::shared_ptr<TDlg> createAndShowDialog(Args... args)

Creates and shows a Dialog by class and constructor parameters.

Those dialogs (TDlg) have to implement Dialog (typically a subclass of it, representing a particular dialog, like FilePropertyDialog), and also some ui mode (e.g. qt, web) specific class (depends on that ui mode).

You typically should not have to use it outside of MainWindow or subclasses. The MainWindow interface allows to create all available dialogs in a ui mode independent way.

May be called in any thread.

Return: The created Dialog instance.

~DialogManager()

Private Functions

void closeDialog(std::shared_ptr<Dialog> dialog)

Closes this dialog, including internal bookkeeping.

Must be called in main thread.

void initAndShowDialog(std::shared_ptr<Dialog> dialog)

Initializes and shows a freshly created dialog.

Must be called in main thread.

bool wasAccepted(std::shared_ptr<Dialog> dialog) = 0

Returns if the dialog was ‘accepted’ by the user (typically by clicking some ‘OK’ button).

The result is undefined before the dialog was closed.

Must be called in main thread.

void waitClosed(std::shared_ptr<Dialog> dialog) = 0

Wait until the user closed the dialog in some way.

May be called in any thread.

void stopDialog(std::shared_ptr<Dialog> dialog) = 0

This method implements the ui mode specific mechanism for stopping (i.e. closing) a dialog.

Must be called in main thread.

void showDialog(std::shared_ptr<Dialog> dialog) = 0

This method implements the ui mode specific mechanism for showing a dialog.

Must be called in main thread.

Private Members

QHash<qint64, std::shared_ptr<Dialog>> _openDialogs

qint64 _nextDialogId = 0

Friends

friend class Dialog

class ExceptionDialog : public sh::ui::Dialog

#include <exceptiondialog.h>

The ‘Exception’ dialog.

Subclassed by sh::ui::qt::QtExceptionDialog, sh::ui::web::WebExceptionDialog

Public Functions

ExceptionDialog(QString error1, QString error2, QString details, QString icon, bool mayRetry, bool mayClose, bool mayCancel, bool showLoglabelAndDetails)

Parameters

error1: The 1st error text.
error2: The 2nd error text.
details: The error details.
icon: An icon (as name resolveable by sh::base::IconManager).
mayRetry: If it’s allowed to retry.
mayClose: If it’s allowed to just close and continue without closing Shallot.
mayCancel: If it’s allowed to cancel, i.e. throwing a sh::exceptions::CancelException.
showLoglabelAndDetails: If the dialog shall allow to read the details.

QString error1(): Returns the 1st error text.

QString error2(): Returns the 2nd error text.

QString details(): Returns the error details.

QString icon(): Returns the icon (as name resolveable by sh::base::IconManager).

bool mayRetry(): Returns if it’s allowed to retry.

bool mayClose(): Returns if it’s allowed to just close and continue without closing Shallot.

bool mayCancel(): Returns if it’s allowed to cancel, i.e. throwing a sh::exceptions::CancelException.

bool showLoglabelAndDetails(): Returns if the dialog shall allow to read the details.

ExceptionDialogResult answer() = 0: Returns the answer the user has given in this dialog.

qint64 dialogId()

Returns the dialog id.

Each instance has an id unique in the complete Shallot process lifetime.

Must be called in main thread.

bool isInited()

Returns if this dialog is initialized.

Must be called in main thread.

bool wasAccepted()

Returns if this dialog was ‘accepted’ by the user (typically by clicking some ‘OK’ button).

Must be called in main thread.

void waitClosed()

Wait until the user closed the dialog in some way.

May be called in any thread.

void close()

Closes the dialog.

Must be called in main thread.

bool wasClosed()

Returns if this dialog was closed.

Must be called in main thread.

DialogManager *manager(): Returns the DialogManager which hosts this dialog.

Private Members

QString _error1

QString _error2

QString _details

QString _icon

bool _mayRetry

bool _mayClose

bool _mayCancel

bool _showLoglabelAndDetails

class FilePropertyDialog : public sh::ui::Dialog

#include <filepropertydialog.h>

The ‘File Properties’ dialog.

Subclassed by sh::ui::qt::QtFilePropertyDialog, sh::ui::web::WebFilePropertyDialog

Public Functions

~FilePropertyDialog()

FilePropertyDialog(QList<std::shared_ptr<sh::filesystem::FilesystemNode>> nodes)

void refresh() = 0: Refreshes the dialog content.

QList<std::shared_ptr<FilePropertyDialogTab>> tabs(): Returns a list of all tabs.

sh::ui::FilePropertyDialogTabActionsView *widgetAt(std::shared_ptr<FilePropertyDialogTab> tab, int i): Returns the widget from a tab at a certain index.

int widgetCount(std::shared_ptr<FilePropertyDialogTab> tab): Returns the number of widgets in a tab.

sh::ui::FilePropertyDialogTabTableView *createTabViewTable() = 0: Creates a new tab view table sub-widget.

sh::ui::FilePropertyDialogTabTextView *createTabViewText() = 0: Creates a new tab view text sub-widget.

sh::ui::FilePropertyDialogTabIconTextBannerView *createTabViewIconTextBanner() = 0: Creates a new tab view icon text banner sub-widget.

qint64 dialogId()

Returns the dialog id.

Each instance has an id unique in the complete Shallot process lifetime.

Must be called in main thread.

bool isInited()

Returns if this dialog is initialized.

Must be called in main thread.

bool wasAccepted()

Returns if this dialog was ‘accepted’ by the user (typically by clicking some ‘OK’ button).

Must be called in main thread.

void waitClosed()

Wait until the user closed the dialog in some way.

May be called in any thread.

void close()

Closes the dialog.

Must be called in main thread.

bool wasClosed()

Returns if this dialog was closed.

Must be called in main thread.

DialogManager *manager(): Returns the DialogManager which hosts this dialog.

Public Static Functions

void addTabFactory(int i, std::shared_ptr<FilePropertyDialogTabFactory> factory)

Adds a FilePropertyDialogTabFactory so the Properties dialogs show its content.

See also the REGISTER_FILEPROPERTYDIALOGTAB macro.

Parameters

i: An index which controls the display order. Use one of the REGISTER_FILEPROPERTYDIALOGTAB_INDEX_* values in FilePropertyDialogTabFactory as base values.

Private Members

QList<std::shared_ptr<sh::filesystem::FilesystemNode>> _nodes

QList<TabViewStruct> _tabs

Private Static Attributes

QHash<int, std::shared_ptr<FilePropertyDialogTabFactory>> _propertytabs

Friends

friend class FilePropertyDialogTab

class FilePropertyDialogTab : public std::enable_shared_from_this<FilePropertyDialogTab>

#include <filepropertydialog.h>

Abstract base class for one tab in the Properties dialog (containing a list of widgets).

Subclass and register this class for providing additional content in the Properties dialog.

Register it by using the REGISTER_FILEPROPERTYDIALOGTAB macro (or by adding a FilePropertyDialogTabFactory via FilePropertyDialog::addTabFactory).

Subclassed by sh::filepropertydialogtabs::FilePropertyDialogTabExtendedAttributes, sh::filepropertydialogtabs::FilePropertyDialogTabGeneral, sh::filepropertydialogtabs::FilePropertyDialogTabUnixPermissions, sh::filepropertydialogtabs::FilePropertyDialogTabWindows, sh::scripting::api::ApiFilePropertyDialogTab

Public Functions

QString title() = 0: The tab title. .

QString titleWithoutMnemonic(): The tab title without mnemonic.

QList<QString> properties() = 0

Returns the list of property labels (one entry for each widget).

Each property is displayed with a header and a widget (created in createWidget) with some content (populated in updateWidget).

void populateWidget(int i, FilePropertyDialogTabActionsView *widget) = 0

Populates the tab widget for the i-th property.

Typically uses the FilePropertyDialog::create* methods to create sub-widgets.