Namespace sh¶

namespace sh¶

Shallot root.

class MainInit

(Un)Initialization for main app.

Public Static Functions

void doInitialize()

void doShutdown()

Public Static Attributes

sh::base::SingletonInitializer *singletonInitializer = nullptr

sig_atomic_t caughtSigterm = 0

namespace actions¶

Infrastructure for actions (submenus, executable ones, and more), as shown in the toolbar and menus and used at some other places.

See the abstract base class sh::actions::AbstractActionItem for more.

class AbstractActionFactory

#include <actionfactory.h>

Abstract base class for an action factory.

It creates an instance of a certain subclass of AbstractActionItem. It can also check if it is defined to be created in a given situation (e.g. not all actions are visible in toolbar).

Subclassed by sh::actions::ActionFactory< T >, sh::scripting::api::ApiActionFactory

Public Functions

AbstractActionFactory(std::shared_ptr<sh::actions::ActionCategory> category, QList<std::shared_ptr<Predicate>> predicates): Is (for subclasses) intended to be directly constructed and registered once.

~AbstractActionFactory()

std::shared_ptr<ActionInstantiation> actionAvailable(ActionInstantiation *instantiation)

std::shared_ptr<sh::actions::AbstractActionItem> construct(QList<std::shared_ptr<sh::filesystem::FilesystemNode>> nodes) = 0

Private Members

std::shared_ptr<sh::actions::ActionCategory> category

QList<std::shared_ptr<Predicate>> predicates

class AbstractActionItem : public QObject, public std::enable_shared_from_this<AbstractActionItem>

#include <abstractactionitem.h>

Abstract base class for executable actions, submenus of them, and more.

See the subclasses of this class.

They are used at various places. The toolbar and context menus provide them to the user.

They can be registered e.g. in a sh::actions::ActionFactory or returned from sh::filesystem::FilesystemHandler.getActions in order to make them available.

Subclassed by sh::actions::ActionActionItem, sh::actions::HeaderActionItem, sh::actions::SeparatorActionItem, sh::actions::SubmenuActionItem

Public Functions

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

AbstractActionItem()

Signals

void changed(): Emits when some data changed.

Private Members

QString _text

QString _icon

bool _enabled

bool _visible

bool _ischeckable

bool _ischecked

bool _initialized

bool _initializing

bool _reinitialize

std::weak_ptr<AbstractActionItem> _parentAction = NO_PARENT

int _defaultActionPrecedence

Private Static Attributes

QWaitCondition initcondition

class ActionActionItem : public sh::actions::AbstractActionItem

#include <actionactionitem.h>

Abstract base class for an executable action.

It can be made visible in menus or the toolbar or executed directly.

Subclasses provide the actual implementation by implementing action. Execution can be triggered from outside by calling execute.

Public Functions

ActionActionItem(QString text, bool enabled = true, QString icon = QString(), int defaultActionPrecedence = 0, bool checkable = false, bool ischecked = false): Is (for subclasses) intended to be directly constructed from everywhere or by registering a factory somewhere.

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionCategory

#include <actioncategory.h>

Action categories are used for grouping actions in menus.

They provide the primary grouping in the toolbar an the context menus. Per default, the categories "create", "open" and "manage" exist.

Public Functions

ActionCategory(QString name, QString label, QString icon): Constructed only by the infrastructure and made available otherwise.

QString name(): The category name.

QString label(): The category label.

QString icon(): The category icon.

Public Static Functions

std::shared_ptr<ActionCategory> getByName(QString name): Gets a category by name.

std::shared_ptr<ActionCategory> add(QString name, QString label, QString icon): Adds a new category.

QList<std::shared_ptr<ActionCategory>> categories(): Returns a list of all existing categories.

void doInitialize()

void doShutdown()

Private Members

QString _name

QString _label

QString _icon

Private Static Attributes

QList<std::shared_ptr<ActionCategory>> _categories

class ActionDefaultPrecedenceValues

#include <abstractactionitem.h>

Reference values for calculating default precedence values of actions.

Public Static Attributes

const int PRECEDENCE_OPENFILE = 300000: Normal file open action.

const int PRECEDENCE_BUILTIN_SPECIAL_OPEN = 600000: Special open action.

class ActionExecutionInfo : public QObject

#include <actionexecutioninfo.h>

Programming interface for giving status infos and communication with the user in an action execution.

An instance is always available during an execution.

Public Functions

ActionExecutionInfo(QObject *parent = 0): Constructed only by the infrastructure and made available otherwise.

~ActionExecutionInfo()

void setVisualProcessFeedbackActive(bool active)

Specifies if there must be a visual process feedback.

The visual process feedback is typically realized as a dialog showing progress information.

Note: It can also appear in some situations, even if this property is set to false.

bool isVisualProcessFeedbackActive(): Determines if there must be a visual process feedback.

void setManualInterventionNeeded(bool isneeded): Specifies if manual input is currently required.

bool isManualInterventionNeeded(): Determines if manual input is currently required.

void startExecution(std::shared_ptr<sh::actions::AbstractActionItem> action): Triggers the beginning of the actual execution. .

void finishExecution(): Triggers the finishing of the execution. .

void setDetails(QString fromverb, QString fromobj, QString toverb = QString(), QString toobj = QString()): Sets some detail texts.

QString fromVerb(): Gets detail text ‘from-verb’.

QString fromObjectName(): Gets detail text ‘from-objectname’.

QString toVerb(): Gets detail text ‘to-verb’.

QString toObjectName(): Gets detail text ‘to-objectname’.

void setHead(QString text): Sets the header text.

QString head(): Gets the header text.

void setProgressIndeterminate(QString text = QString()): Sets progress information to ‘indeterminate’.

void setProgress(quint64 done, quint64 all, QString text): Sets progress information.

bool isProgressDeterminate(): Gets if progress information is ‘indeterminate’.

quint64 progressDone(): Gets count of finished items.

quint64 progressAll(): Gets count of all items.

QString progressText(): Gets progress information text.

sh::actions::ActionExecutionUserFeedback *userfeedback(): Program interface for interactive user input.

bool isCancelled(): Gets if the current action execution was cancelled.

void cancel()

Cancel the current action execution.

Used from outside, e.g. as handler for a ‘Cancel’ button.

void respectCancel(): Called regularly from an action execution code in order to cancel execution at that place, if the user has cancelled it.

void withExecuteGuards_infodlg(std::function<void()>int flags = 0, ): Executes code with different exception handlers for presenting exceptions in the action execution inside the action dialog (instead of the default exception dialog).

sh::filesystem::Operation *operation(): Program interface for operations on the filesystem (reading or writing).

void addChangedEurl(std::shared_ptr<const sh::filesystem::Eurl> eurl)

Reminds an important change of a certain node in the filesystem (file created, modified, removed?).

The infrastructure will force the ui to refresh those nodes.

void shutdown(bool success): Shuts down this execution info and releases resources.

Signals

void detailsChanged(): Signal for changed execution details.

void headChanged(): Signal for changed head.

void progressChanged(): Signal for changed progress.

void visualProcessFeedbackActiveChanged(): Signal for changed visibility-required.

void wasCancelled(): Signal for cancellation on user behalf.

bool manualInterventionNeededChanged(): Signal for changed manual-intervention-needed.

Private Functions

std::shared_ptr<sh::ui::ActionExecutionInfoDialog> createDialog()

std::shared_ptr<ui::ActionExecutionInfoPanel> createPanel(sh::ui::ActionExecutionInfoDialog *dialog)

Private Members

QMutex mutex

QString _head

QString _fromverb

QString _fromobj

QString _toverb

QString _toobj

bool _progressDeterminate

quint64 _progressDone

quint64 _progressAll

bool _visualProcessFeedbackActive = false

bool _wasAlwaysInvisible = true

bool _manualInterventionNeeded = false

QString _progressText

std::shared_ptr<sh::ui::ActionExecutionInfoDialog> infodialog = 0

std::shared_ptr<sh::ui::ActionExecutionInfoPanel> infopanel = 0

bool _iscancelled = false

sh::filesystem::Operation _operation

QList<std::shared_ptr<const sh::filesystem::Eurl>> changes

QStack<std::shared_ptr<sh::actions::AbstractActionItem>> stack

Private Slots

void _checkVisibilityOnce()

class ActionExecutionUserFeedback

#include <actionexecutionuserfeedback.h>

Methods for user interaction in an action execution.

When an action executes, it may need to ask the user for some input at some time. An action implementation can do so by calling those methods. It is available as a member of the ActionExecutionInfo class. An instance of it is available in each action execution.

Subclassed by sh::ui::ActionExecutionInfoDialog

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

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)

~ActionExecutionUserFeedback()

class Choice

#include <actionexecutionuserfeedback.h>

A data structure for a choice (in an GridformEntry).

Public Functions

Choice(QString label, QString text = QString())

Public Members

QString label

QString text

class Choices

#include <actionexecutionuserfeedback.h>

A data structure for a list of Choice instances.

Public Members

QList<Choice*> list

int selected = -1

class GridformEntries

#include <actionexecutionuserfeedback.h>

A data structure for a list of entries in a simple chooser grid form.

Public Functions

GridformEntries(): Is intended to be directly constructed from everywhere.

~GridformEntries()

GridformEntry *newEntry(QString label)

Public Members

QList<GridformEntry*> list

class GridformEntry

#include <actionexecutionuserfeedback.h>

A data structure for an entry in a simple chooser grid form.

Public Functions

GridformEntry(QString label, Choices choices): Constructed only indirectly.

~GridformEntry()

int addChoice(QString label, QString text = QString())

Public Members

QString label

Choices choices

template<class T> class ActionFactory : public sh::actions::AbstractActionFactory

#include <actionfactory.h>

A typical implementation for an action factory.

See base class for more.

Public Functions

ActionFactory(std::shared_ptr<sh::actions::ActionCategory> category, QList<std::shared_ptr<Predicate>> predicates)

std::shared_ptr<sh::actions::AbstractActionItem> construct(QList<std::shared_ptr<sh::filesystem::FilesystemNode>> nodes)

std::shared_ptr<ActionInstantiation> actionAvailable(ActionInstantiation *instantiation)

class ActionInstantiation

#include <actionfactory.h>

Holds various data around action creation.

Action creation is a process, which begins with querying all actions available for certain nodes. The action factories evaluate availabilities and store some construction information here. Many parties are involved in working with it. The created action, is stored in this object as well.

Public Functions

ActionInstantiation(QList<std::shared_ptr<sh::filesystem::FilesystemNode>> selectedNodes = {}, std::shared_ptr<sh::filesystem::FilesystemNode> currentDirectory = nullptr): Constructor for a typical fresh instance, containing infos about selected items and some more.

ActionInstantiation(const ActionInstantiation &s) = default: Clones an existing instance.

ActionInstantiation(const ActionInstantiation &s, std::shared_ptr<sh::actions::AbstractActionItem> createdAction): Clones an existing instance and sets createdAction. This is a convenience constructor used for some special cases.

Public Members

QList<std::shared_ptr<sh::filesystem::FilesystemNode>> selectedNodes: The selected nodes (initially: what’s selected in the active file list).

std::shared_ptr<sh::filesystem::FilesystemNode> currentDirectory: The current directory (which is visible in the active file list).

bool resolveLinks = true: If links shall be resolved for evaluation and action creation.

bool isLookupOnCurrentDirectoryLevel = false: If this instantiation refers to a lookup for actions on ‘current directory level’ (instead of ‘selection level’).

AbstractActionFactory *actionfactory = 0: The action faction.

std::shared_ptr<ActionCategory> category = 0: The action category.

std::shared_ptr<AbstractActionItem> createdAction = 0: The created action.

QKeySequence shortcut: The requested keyboard shortcut for the action.

int positionIndex = 0: The position information index.

class ActionsManager : public QObject, public sh::base::Singleton

#include <actionsmanager.h>

Factory for actions which are valid for a given list of FileSystemNode and tools for placing actions in some gui elements.

Public Functions

void getActions(std::shared_ptr<ActionInstantiation> instantiation, std::function<void(QList<std::shared_ptr<ActionInstantiation>>, QList<std::shared_ptr<sh::actions::ActionInstantiation>>)> callback, std::function<void(std::shared_ptr<ActionInstantiation>)> initializedcallback = [](std::shared_ptr< ActionInstantiation >){})

Asychonously gets actions for a list of sh::filesystem::FilesystemNode.

Parameters

nodes: The list of nodes.
callback: This callback is called once the list is fetched.
initializedcallback: This callback is called for each result action after initialization.

void getDefaultAction(QList<std::shared_ptr<sh::actions::AbstractActionItem>> actionList, std::function<void(std::shared_ptr<sh::actions::ActionActionItem>)> callback)

Determines the default action for a given list of actions.

Parameters

actionList: The list of all available actions.
callback: This callback is called when the default action was found (with an already initialized action).

void getActionForShortcut(QList<std::shared_ptr<filesystem::FilesystemNode>> selectedNodes, std::shared_ptr<filesystem::FilesystemNode> folderNode, int key, Qt::KeyboardModifiers modifiers, std::function<void(std::shared_ptr<sh::actions::AbstractActionItem>)> callback)

Asychonously gets the action for a shortcut.

Parameters

selectedNodes: The nodes which are currently selected in the active fileview.
folderNode: The folder which is shown by the active fileview.
key: The keypress character code.
modifiers: The keypress modifiers.
callback: This callback is called when an action was found (with an already initialized action).

void registerActionFactory(std::shared_ptr<sh::actions::AbstractActionFactory> actionFactory)

Registers an action factory.

This makes an action implementation available in the toolbar and context menus.

QList<std::shared_ptr<sh::actions::ActionActionItem>> runningActions(): Returns a list of all currently running actions.

void doInitialize(): Executes singleton initialization.

void doShutdown(): Executes singleton shutdown.

void shutdown(): Shutdown down this singleton.

bool isAlive(): Returns if this singleton is alive (true until its shutdown begins).

Signals

void runningActionsChanged(): Emitted when the list of running actions changed.

Public Static Functions

QString selectionLabel(QList<std::shared_ptr<sh::filesystem::FilesystemNode>> selection): Returns a short header label text for a node selection.

QString directoryLabel(std::shared_ptr<sh::filesystem::FilesystemNode> directory): Returns a short header label text for a current directory.

void sortAndSeparateActions(QList<std::shared_ptr<ActionInstantiation>> *actions): Sorts a lists of actionitems and adds separators between groups. Modifies the given list.

Private Functions

ActionsManager()

QList<std::shared_ptr<ActionInstantiation>> _getActions_raw(std::shared_ptr<ActionInstantiation> instantiation)

void _emit_runningActionsChanged()

void recursivelyInitializeAction(std::shared_ptr<sh::actions::ActionInstantiation> actsit, std::function<void(std::shared_ptr<sh::actions::ActionInstantiation>)> callback, QList<std::shared_ptr<sh::actions::ActionInstantiation>> sits = {}, )

Recursively initializes a list of action items and calls a callback for each action item recursively afterwards.

Parameters

actions: List of all action items to traverse.
callback: This callback is called for each action item (even indirectly in a subtree hierarchy).

void _getDefaultAction_helper(QList<std::shared_ptr<sh::actions::AbstractActionItem>> actionList, std::shared_ptr<GDAHstruct> gdah): Internal helper for the public getDefaultAction() method.

std::shared_ptr<sh::actions::ActionsManager::RunningActionsCounter> _actionExecutionStarted(std::shared_ptr<sh::actions::ActionActionItem> action): Helper for updating _runningactions. .

Private Members

QList<std::shared_ptr<sh::actions::AbstractActionFactory>> _actionfactories

QMutex _mutex_actionfactories

QList<std::shared_ptr<sh::actions::ActionActionItem>> _runningactions

QMutex _mutex_runningactions

Friends

friend class ActionActionItem

struct GDAHstruct

Internal data structure used for _getDefaultAction_helper();.

Public Functions

GDAHstruct() = default

GDAHstruct(const GDAHstruct &o) = default

Public Members

sh::tools::AtomicCounter counter

std::function<void(std::shared_ptr<sh::actions::ActionActionItem>)> callback

int currentValue = 0

QList<std::shared_ptr<sh::actions::AbstractActionItem>> initialActionList

std::shared_ptr<sh::actions::AbstractActionItem> currentAction = 0

class RunningActionsCounter

Helper for updating _runningactions. .

Public Functions

RunningActionsCounter(ActionsManager *manager, std::shared_ptr<sh::actions::ActionActionItem> action)

~RunningActionsCounter()

Private Members

ActionsManager *_manager

std::shared_ptr<sh::actions::ActionActionItem> _action

class ByRegExpPredicate : public sh::actions::Predicate

#include <actionfactory.h>

Shows actions only when the selection paths matches a regular expression.

Public Functions

ByRegExpPredicate(QString regexp)

bool evaluate(ActionInstantiation *instantiation)

Evaluates if the predicate is solved.

If it returns true, the evaluation proceeds and eventually succeeds. If false, it stops at this place.

void prepare(ActionInstantiation *instantiation): Prepares the evaluation.

Private Members

QRegExp filterRegExp

class DontResolveLinksPredicate : public sh::actions::Predicate

#include <actionfactory.h>

Disables links resolving.

Public Functions

DontResolveLinksPredicate()

void prepare(ActionInstantiation *instantiation): Prepares the evaluation.

bool evaluate(ActionInstantiation *instantiation)

Evaluates if the predicate is solved.

If it returns true, the evaluation proceeds and eventually succeeds. If false, it stops at this place.

class HeaderActionItem : public sh::actions::AbstractActionItem

#include <headeractionitem.h>

A header.

Use it as all the other AbstractActionItem classes. It will lead to a visual header in the parent menu.

Public Functions

HeaderActionItem(QString text, QString icon = QString()): Is intended to be directly constructed from everywhere.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class HideOnCurrentDirectoryLevelPredicate : public sh::actions::Predicate

#include <actionfactory.h>

Shows actions only when not searching for ‘current directory level’ actions.

Public Functions

HideOnCurrentDirectoryLevelPredicate()

bool evaluate(ActionInstantiation *instantiation)

Evaluates if the predicate is solved.

If it returns true, the evaluation proceeds and eventually succeeds. If false, it stops at this place.

void prepare(ActionInstantiation *instantiation): Prepares the evaluation.

class HideOnSelectionLevelPredicate : public sh::actions::Predicate

#include <actionfactory.h>

Shows actions only when not searching for ‘selection level’ actions.

Public Functions

HideOnSelectionLevelPredicate()

bool evaluate(ActionInstantiation *instantiation)

Evaluates if the predicate is solved.

If it returns true, the evaluation proceeds and eventually succeeds. If false, it stops at this place.

void prepare(ActionInstantiation *instantiation): Prepares the evaluation.

class KeyShortcutPredicate : public sh::actions::Predicate

#include <actionfactory.h>

Sets a keyboard shortcut.

Public Functions

KeyShortcutPredicate(QKeySequence shortcut, bool triggersOnCurrentDirectoryLevel)

void prepare(ActionInstantiation *instantiation): Prepares the evaluation.

bool evaluate(ActionInstantiation *instantiation)

Evaluates if the predicate is solved.

If it returns true, the evaluation proceeds and eventually succeeds. If false, it stops at this place.

Private Members

QKeySequence shortcut

bool triggersOnCurrentDirectoryLevel

class OnDirectoriesPredicate : public sh::actions::Predicate

#include <actionfactory.h>

Shows actions only on directories.

Public Functions

OnDirectoriesPredicate()

bool evaluate(ActionInstantiation *instantiation)

Evaluates if the predicate is solved.

If it returns true, the evaluation proceeds and eventually succeeds. If false, it stops at this place.

void prepare(ActionInstantiation *instantiation): Prepares the evaluation.

class OnFilesPredicate : public sh::actions::Predicate

#include <actionfactory.h>

Shows actions only on files.

Public Functions

OnFilesPredicate()

bool evaluate(ActionInstantiation *instantiation)

Evaluates if the predicate is solved.

If it returns true, the evaluation proceeds and eventually succeeds. If false, it stops at this place.

void prepare(ActionInstantiation *instantiation): Prepares the evaluation.

class OnLinksPredicate : public sh::actions::Predicate

#include <actionfactory.h>

Shows actions only on links.

Public Functions

OnLinksPredicate()

bool evaluate(ActionInstantiation *instantiation)

Evaluates if the predicate is solved.

If it returns true, the evaluation proceeds and eventually succeeds. If false, it stops at this place.

void prepare(ActionInstantiation *instantiation): Prepares the evaluation.

class OnSingleEntrySelectionPredicate : public sh::actions::Predicate

#include <actionfactory.h>

Shows actions only on single-entry selections.

Public Functions

OnSingleEntrySelectionPredicate()

bool evaluate(ActionInstantiation *instantiation)

Evaluates if the predicate is solved.

If it returns true, the evaluation proceeds and eventually succeeds. If false, it stops at this place.

void prepare(ActionInstantiation *instantiation): Prepares the evaluation.

class PositionIndexPredicate : public sh::actions::Predicate

#include <actionfactory.h>

Sets a positioning information index.

Public Functions

PositionIndexPredicate(int positionIndex)

void prepare(ActionInstantiation *instantiation): Prepares the evaluation.

bool evaluate(ActionInstantiation *instantiation)

Evaluates if the predicate is solved.

If it returns true, the evaluation proceeds and eventually succeeds. If false, it stops at this place.

Private Members

int positionIndex

class Predicate

#include <actionfactory.h>

Controls when and how an action is created in the action factory.

Subclassed by sh::actions::ByRegExpPredicate, sh::actions::DontResolveLinksPredicate, sh::actions::HideOnCurrentDirectoryLevelPredicate, sh::actions::HideOnSelectionLevelPredicate, sh::actions::KeyShortcutPredicate, sh::actions::OnDirectoriesPredicate, sh::actions::OnFilesPredicate, sh::actions::OnLinksPredicate, sh::actions::OnSingleEntrySelectionPredicate, sh::actions::PositionIndexPredicate

Public Functions

Predicate()

void prepare(ActionInstantiation *instantiation): Prepares the evaluation.

bool evaluate(ActionInstantiation *instantiation)

Evaluates if the predicate is solved.

If it returns true, the evaluation proceeds and eventually succeeds. If false, it stops at this place.

~Predicate()

class SeparatorActionItem : public sh::actions::AbstractActionItem

#include <separatoractionitem.h>

A separator.

Use it as all the other AbstractActionItem classes. It will lead to a visual separator in the parent menu.

Public Functions

SeparatorActionItem(): Is intended to be directly constructed from everywhere.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class SubmenuActionItem : public sh::actions::AbstractActionItem

#include <submenuactionitem.h>

Abstract base class for a submenu.

It can be made visible in menus or the toolbar or executed directly.

Subclasses fill the submenu with other actions in order to be useful.

Subclassed by sh::actions::common::ActionAbstractTransferTo, sh::actions::common::ActionBookmarkFolder, sh::actions::common::ActionGroups, sh::actions::common::ActionHistoryNavigate, sh::actions::common::ActionOpenFileWith, sh::actions::common::ActionOpenTerminal, sh::actions::mainmenu::ActionApplyProfile, sh::actions::mainmenu::ActionMain, sh::actions::mainmenu::ActionNumberFileviews, sh::scripting::api::ApiSubmenuActionItem

Public Functions

SubmenuActionItem(QString text, const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems = {}, bool enabled = true, QString icon = QString(), int defaultActionPrecedence = 0, bool checkable = false, bool ischecked = false): Is (for subclasses) intended to be directly constructed from everywhere or by registering a factory somewhere.

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

Private Members

QList<std::shared_ptr<sh::actions::AbstractActionItem>> _subitems

namespace common¶

Implementations of actions.

Subclasses of sh::actions::AbstractActionItem (and possibly some auxiliary stuff). Many action implementations used in Shallot are here. You can find other actions in the sibling namespaces and a few very special ones at different places.

class ActionAbstractTransferTo : public sh::actions::SubmenuActionItem

#include <actiontransferto.h>

Abstract action for transferring a selection to some other locations (e.g. to other file views, bookmarks).

Subclassed by sh::actions::common::ActionTransferToCopy, sh::actions::common::ActionTransferToMove

Public Functions

ActionAbstractTransferTo(QString text, QString icon, QList<std::shared_ptr<sh::filesystem::FilesystemNode>> nodes)

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

Friends

friend class ActionTransferToHelper

class ActionAbstractTransferTree : public sh::actions::ActionActionItem

#include <actionabstracttransfertree.h>

Abstract action for transferring (copying, moving, et al) a tree of items.

Subclassed by sh::actions::common::ActionCopyTree

Public Functions

ActionAbstractTransferTree(QList<std::shared_ptr<const sh::filesystem::Eurl>> sources, std::shared_ptr<const sh::filesystem::Eurl> destination)

~ActionAbstractTransferTree()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void makereadableunits(double *value, QString *vunit)

class MyFilesystemOperationProgressMonitor : public sh::filesystem::FilesystemOperationProgressMonitor

#include <actionabstracttransfertree.h>

Public Functions

MyFilesystemOperationProgressMonitor(ActionExecutionInfo *info)

bool hasItemInfo(): Checks if this progress monitor provides information about how many items of a certain total number are transferred so far.

quint64 doneItems(): Checks how many items are transferred so far.

quint64 allItems(): Checks how many items are to be transferred in total (as predicted in the current moment).

bool hasBytesInfo(): Checks if this progress monitor provides information about how many byte of a certain total number are transferred so far.

quint64 doneBytes(): Checks how many bytes are transferred so far.

quint64 allBytes(): Checks how many bytes are to be transferred in total (as predicted in the current moment).

QString getItemInfoFrom(): Returns the current source of transfer (as textual information).

QString getItemInfoTo(): Returns the current destination of transfer (as textual information).

QString estimation(): Returns the current performance and time estimation (as textual information).

class ActionAddToBookmarks : public sh::actions::ActionActionItem

#include <actionbookmarks.h>

Action for bookmarking a directory.

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionBookmark : public sh::actions::ActionActionItem

#include <actionbookmarks.h>

Action for navigating to a certain bookmark.

Public Functions

ActionBookmark(QString label, std::shared_ptr<const sh::filesystem::Eurl> eurl)

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionBookmarkFolder : public sh::actions::SubmenuActionItem

#include <actionbookmarks.h>

Submenu action of bookmarks.

Subclassed by sh::actions::common::ActionBookmarks

Public Functions

ActionBookmarkFolder(QString label)

void addSubitem(std::shared_ptr<sh::actions::AbstractActionItem> item)

void clearSubitems()

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

class ActionBookmarks : public sh::actions::common::ActionBookmarkFolder

#include <actionbookmarks.h>

Bookmarking action (the main one you see in the toolbar)

Public Functions

ActionBookmarks()

void initialize(): Initialize the action. This should make the time-consuming parts, e.g. for determining a label or enabled state.

void addSubitem(std::shared_ptr<sh::actions::AbstractActionItem> item)

void clearSubitems()

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

class ActionClipboardCopy : public sh::actions::ActionActionItem

#include <actionclipboard.h>

Action for copying to clipboard.

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionClipboardCut : public sh::actions::ActionActionItem

#include <actionclipboard.h>

Action for cutting to clipboard.

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionClipboardPaste : public sh::actions::ActionActionItem

#include <actionclipboard.h>

Action for pasting from clipboard.

Public Functions

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

bool shortcutTriggersOnFolder()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionClipboardPasteAsLink : public sh::actions::ActionActionItem

#include <actionclipboard.h>

Action for pasting from clipboard as link.

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionCopyTree : public sh::actions::common::ActionAbstractTransferTree

#include <actioncopytree.h>

Action copying a filesystem tree to some other place.

Subclassed by sh::actions::common::ActionMoveTree

Public Functions

ActionCopyTree(QList<std::shared_ptr<const sh::filesystem::Eurl>> sources, std::shared_ptr<const sh::filesystem::Eurl> destination)

void action(sh::actions::ActionExecutionInfo *info): The action implementation, i.e. what the actions should actually do.

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void makereadableunits(double *value, QString *vunit)

class ActionCreateFile : public sh::actions::ActionActionItem

#include <actioncreatefile.h>

Action for creating a new file.

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionCreateFolder : public sh::actions::ActionActionItem

#include <actioncreatefolder.h>

Action for creating a new directory.

Public Functions

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

bool shortcutTriggersOnFolder()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionDeleteItems : public sh::actions::ActionActionItem

#include <actiondeleteitems.h>

Action deleting a list of filesystem items.

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionExecute : public sh::actions::ActionActionItem

#include <actionexecute.h>

Action executing a file (if executable).

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionGroups : public sh::actions::SubmenuActionItem

#include <actiongroups.h>

Action for showing registered actions grouped by an sh::actions::ActionCategory.

Public Functions

ActionGroups(std::shared_ptr<sh::actions::ActionCategory> category)

void setGroupActions(std::shared_ptr<sh::actions::ActionInstantiation> rootsituation, QList<std::shared_ptr<sh::actions::ActionInstantiation>> selacts, QList<std::shared_ptr<sh::actions::ActionInstantiation>> diracts)

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

class ActionHistoryNavigate : public sh::actions::SubmenuActionItem

#include <actionnavigation.h>

Abstract action for navigating in the directory history stack (stepwise or randomly).

Subclassed by sh::actions::common::ActionHistoryNavigateBackward, sh::actions::common::ActionHistoryNavigateForward

Public Functions

ActionHistoryNavigate(QString text, std::function<QList<sh::tools::HistoryTracker<std::shared_ptr<const sh::filesystem::Eurl>>::HistoryEntry>()> _getentriesfctQString icon, )

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

class ActionHistoryNavigateBackward : public sh::actions::common::ActionHistoryNavigate

#include <actionnavigation.h>

Action for navigating backward in the directory history stack.

Public Functions

ActionHistoryNavigateBackward()

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

class ActionHistoryNavigateForward : public sh::actions::common::ActionHistoryNavigate

#include <actionnavigation.h>

Action for navigating forward in the directory history stack.

Public Functions

ActionHistoryNavigateForward()

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

class ActionManageBookmarks : public sh::actions::ActionActionItem

#include <actionbookmarks.h>

Action for managing bookmarks.

Public Functions

ActionManageBookmarks()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionMoveTree : public sh::actions::common::ActionCopyTree

#include <actionmovetree.h>

Action moving a filesystem tree to some other place.

Public Functions

ActionMoveTree(QList<std::shared_ptr<const sh::filesystem::Eurl>> sources, std::shared_ptr<const sh::filesystem::Eurl> destination)

void action(sh::actions::ActionExecutionInfo *info): The action implementation, i.e. what the actions should actually do.

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void makereadableunits(double *value, QString *vunit)

class ActionNavigateInHistory : public sh::actions::ActionActionItem

#include <actionnavigation.h>

Action for navigating to one particular place in the directory history stack.

Public Functions

ActionNavigateInHistory(sh::ui::FileView *filelist, int idx, std::shared_ptr<const sh::filesystem::Eurl> eurl, bool isdefault)

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionOpenArchive : public sh::actions::ActionActionItem

#include <actionopenarchive.h>

Action opening a sharc archive (by creating a root node for it).

Subclassed by sh::filesystemhandlers::ArchiveFilesystemHandler::ActionOpenTarArchive, sh::filesystemhandlers::ArchiveFilesystemHandler::ActionOpenZipArchive

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionOpenDirectoryInNewWindow : public sh::actions::ActionActionItem

#include <actionopendirectoryinnewwindow.h>

Action for opening a file with a automatically chosen program.

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionOpenFile : public sh::actions::ActionActionItem

#include <actionopenfile.h>

Action for opening a file with a automatically chosen program.

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionOpenFileWith : public sh::actions::SubmenuActionItem

#include <actionopenfilewith.h>

Submenu action for opening a file with a manually chosen program.

Public Functions

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

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

Public Static Functions

void waitProgramClosedIfNeeded(sh::actions::ActionExecutionInfo *info, QStringList filelist)

void doInitialize()

void doShutdown()

Friends

friend class ActionOpenFile

class _ActionOpenFileWithEntry : public sh::actions::ActionActionItem

Public Functions

_ActionOpenFileWithEntry(QList<std::shared_ptr<sh::filesystem::FilesystemNode>> nodes, QString name, QString cmd, QStringList arguments, QStringList rememberformimetype)

void action(sh::actions::ActionExecutionInfo *info): The action implementation, i.e. what the actions should actually do.

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Public Members

QString _command

QStringList _commandArguments

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

Signals

void changed(): Emits when some data changed.

class _ActionOpenFileWithUI : public sh::actions::ActionActionItem

Public Functions

_ActionOpenFileWithUI(QList<std::shared_ptr<sh::filesystem::FilesystemNode>> nodes, QString mimetype)

void action(sh::actions::ActionExecutionInfo *info): The action implementation, i.e. what the actions should actually do.

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Public Members

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

QString _mimetype

Signals

void changed(): Emits when some data changed.

class ActionOpenSharcArchive : public sh::actions::ActionActionItem

#include <actionopensharcarchive.h>

Action opening a sharc archive (by creating a root node for it).

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionOpenTerminal : public sh::actions::SubmenuActionItem

#include <actionopenterminal.h>

Action submenu with actions for opening commandline terminals.

Public Functions

ActionOpenTerminal(QString dir)

void initialize(): Initialize the action. This should make the time-consuming parts, e.g. for determining a label or enabled state.

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

class ActionOpenTerminalAsRoot : public sh::actions::common::ActionOpenTerminalAsUser

#include <actionopenterminal.h>

Action for opening a commandline terminal as root.

Public Functions

ActionOpenTerminalAsRoot(QString dir)

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionOpenTerminalAsUser : public sh::actions::ActionActionItem

#include <actionopenterminal.h>

Action for opening a commandline terminal (with current user).

Subclassed by sh::actions::common::ActionOpenTerminalAsRoot

Public Functions

ActionOpenTerminalAsUser(QString dir)

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionRenameItem : public sh::actions::ActionActionItem

#include <actionrenameitem.h>

Action for renaming items.

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionShowProperties : public sh::actions::ActionActionItem

#include <actionshowproperties.h>

Action for showing the properties dialog for filesystem nodes.

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionTransferToCopy : public sh::actions::common::ActionAbstractTransferTo

#include <actiontransferto.h>

Action for copying a selection to some other locations.

Public Functions

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

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize(): Only called by the Shallot infrastructure for initialization.

void doShutdown(): Only called by the Shallot infrastructure for initialization.

class ActionTransferToHelper : public sh::actions::ActionActionItem

#include <actiontransferto.h>

This action is used as subitems in ActionAbstractTransferTo.

Public Functions

ActionTransferToHelper(QString text, QString icon, std::shared_ptr<const sh::filesystem::Eurl> transferto, std::shared_ptr<ActionAbstractTransferTo> root)

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionTransferToMove : public sh::actions::common::ActionAbstractTransferTo

#include <actiontransferto.h>

Action for moving a selection to some other locations.

Public Functions

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

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

namespace mainmenu¶

Implementation of the main menu.

Subclasses of sh::actions::AbstractActionItem (and possibly some auxiliary stuff). You can find other actions in the sibling namespaces and a few very special ones at different places.

class ActionAbout : public sh::actions::ActionActionItem

#include <actionabout.h>

Action showing the Shallot about box.

Public Functions

ActionAbout()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionAbstractSelectNodes : public sh::actions::ActionActionItem

#include <actionselect.h>

Abstract subclass for actions which select some nodes in the current file view.

Subclassed by sh::actions::mainmenu::ActionInvertNodeSelection, sh::actions::mainmenu::ActionSelectAllNodes

Public Functions

ActionAbstractSelectNodes(QString text)

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionApplyProfile : public sh::actions::SubmenuActionItem

#include <actionapplyprofile.h>

Submenu action for switching the current profile.

Public Functions

ActionApplyProfile()

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

class ActionApplyProfileX : public sh::actions::ActionActionItem

Action for switching the current profile to a certain one.

Public Functions

ActionApplyProfileX(QString profilename, bool checked)

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionFileViewChangeIconDimension : public sh::actions::ActionActionItem

#include <actionfileviewchangeicondimension.h>

Action for changing the icon size.

Subclassed by sh::actions::mainmenu::ActionFileViewDecreaseIconDimension, sh::actions::mainmenu::ActionFileViewIncreaseIconDimension

Public Functions

ActionFileViewChangeIconDimension(QString name, int direction, QString icon, QKeySequence shortcut)

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionFileViewDecreaseIconDimension : public sh::actions::mainmenu::ActionFileViewChangeIconDimension

#include <actionfileviewchangeicondimension.h>

Action for decreasing the icon size.

Public Functions

ActionFileViewDecreaseIconDimension()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionFileviewFilesizeFormatting : public sh::actions::ActionActionItem

#include <actionfileviewfilesizeformatting.h>

Action for toggling the filesize formatting mode for the current fileview.

Public Functions

ActionFileviewFilesizeFormatting()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionFileViewIncreaseIconDimension : public sh::actions::mainmenu::ActionFileViewChangeIconDimension

#include <actionfileviewchangeicondimension.h>

Action for increasing the icon size.

Public Functions

ActionFileViewIncreaseIconDimension()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionFileviewShowHiddenFiles : public sh::actions::ActionActionItem

#include <actionfileviewshowhiddenfiles.h>

Action which toggles the visibility of hidden files in the current fileview.

Public Functions

ActionFileviewShowHiddenFiles()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionFileviewView : public sh::actions::ActionActionItem

#include <actionfileviewview.h>

Action which toggles between icon- and listmode for the current fileview.

Public Functions

ActionFileviewView()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionGotoDirectory : public sh::actions::ActionActionItem

#include <actiongotodirectory.h>

Action which toggles the visibility of hidden files in the current fileview.

Public Functions

ActionGotoDirectory()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionHelp : public sh::actions::ActionActionItem

#include <actionhelp.h>

Action for opening the Shallot help system.

Public Functions

ActionHelp()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionInvertNodeSelection : public sh::actions::mainmenu::ActionAbstractSelectNodes

#include <actionselect.h>

Action for inverting the node selection in the current file view.

Public Functions

ActionInvertNodeSelection()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Private Members

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

class ActionMain : public sh::actions::SubmenuActionItem, public sh::base::Singleton

#include <actionmain.h>

Submenu action providing the Shallot main menu.

Public Functions

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

void doInitialize(): Executes singleton initialization.

void doShutdown(): Executes singleton shutdown.

void shutdown(): Shutdown down this singleton.

bool isAlive(): Returns if this singleton is alive (true until its shutdown begins).

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

Private Functions

ActionMain()

class ActionManageSavedSettings : public sh::actions::ActionActionItem

#include <actionmanagesavedsettings.h>

Action for opening the ‘Manage saved settings’ dialog.

Public Functions

ActionManageSavedSettings()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionNumberFileviews : public sh::actions::SubmenuActionItem

#include <actionnumberfileviews.h>

Submenu action for changing the number of fileviews.

Public Functions

ActionNumberFileviews()

const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems(): Returns the list of subitems from this submenu.

void setSubitems(const QList<std::shared_ptr<sh::actions::AbstractActionItem>> subitems): Sets the subitems.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void subitemsChanged(): Emits when the list of subitems changed.

void changed(): Emits when some data changed.

Friends

friend class ActionNumberFileviews_Add

friend class ActionNumberFileviews_Remove

friend class ActionNumberFileviews_Remove_Current

class ActionNumberFileviews_Add : public sh::actions::ActionActionItem

#include <actionnumberfileviews.h>

Action for adding a new fileview.

Public Functions

ActionNumberFileviews_Add(QList<std::shared_ptr<sh::filesystem::FilesystemNode>> nodes = {})

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionNumberFileviews_Remove : public sh::actions::ActionActionItem

#include <actionnumberfileviews.h>

Action for removing a certain fileview.

Public Functions

ActionNumberFileviews_Remove(int i, bool deflt)

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionNumberFileviews_Remove_Current : public sh::actions::ActionActionItem

#include <actionnumberfileviews.h>

Action for removing the current fileview (for keyboard shortcut).

Public Functions

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

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

Public Static Functions

void doInitialize()

void doShutdown()

class ActionQuit : public sh::actions::ActionActionItem

#include <actionquit.h>

Action for closing Shallot.

Public Functions

ActionQuit()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionRefresh : public sh::actions::ActionActionItem

#include <actionrefresh.h>

Action for refreshing the current view.

Public Functions

ActionRefresh()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionSaveSettings : public sh::actions::ActionActionItem

#include <actionsavesettings.h>

Action for opening the ‘Save settings’ dialog.

Public Functions

ActionSaveSettings()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionSearch : public sh::actions::ActionActionItem

#include <actionsearch.h>

Action for opening the ‘Save settings’ dialog.

Public Functions

ActionSearch()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionSelectAllNodes : public sh::actions::mainmenu::ActionAbstractSelectNodes

#include <actionselect.h>

Action for selecting all nodes in the current file view.

Public Functions

ActionSelectAllNodes()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionSetWindowTitlePattern : public sh::actions::ActionActionItem

#include <actionsetwindowtitlepattern.h>

Action for setting the window title pattern.

Public Functions

ActionSetWindowTitlePattern()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionShowDetailPanel : public sh::actions::ActionActionItem

#include <actionshowdetailpanel.h>

Action for toggling the visibility of the detail panel.

Public Functions

ActionShowDetailPanel()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionShowFolderTree : public sh::actions::ActionActionItem

#include <actionshowfoldertree.h>

Action for toggling the visibility of the directory tree.

Public Functions

ActionShowFolderTree()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionShowLog : public sh::actions::ActionActionItem

#include <actionshowlog.h>

Action for showing the Shallot log in a dialog.

Public Functions

ActionShowLog()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionTreeStickyness : public sh::actions::ActionActionItem

#include <actiontreestickyness.h>

Action for toggling the stickyness of the directory tree to the fileviews.

Public Functions

ActionTreeStickyness()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

class ActionTuning : public sh::actions::ActionActionItem

#include <actiontuning.h>

Action for opening the ‘Tuning’ dialog.

Public Functions

ActionTuning()

void execute(): Executes this action.

void execute(sh::actions::ActionExecutionInfo *info): Executes this action.

QKeySequence shortcuthint(): Returns the keyboard shortcut for triggering this action.

bool shortcuthintTriggersOnCurrentDirectory(): Checks if using the keyboard shortcut shall trigger the action on the current directory (or on the entry selection).

void setShortcuthint(QKeySequence shortcut, bool triggersOnCurrentDirectory = false): Sets the keyboard shortcut for triggering this action.

QString text(): Returns the displayed text for this action.

QString icon(): Returns the icon for this action.

bool enabled(): Checks if this action is enabled.

bool isChecked(): Checks if this action is checked (has a cross in the ui).

bool isCheckable(): Checks if this action is checkable (can have a cross in the ui).

int defaultActionPrecedence() const

Returns the precedence for becoming the default action of a parent submenu.

This e.g. leads to a bold label.

The action with the highest value becomes the default. Only values >0 will be considered. See ActionDefaultPrecedenceValues for reference values.

void setText(QString text): Sets the displayed text.

void setIcon(QString icon): Sets the icon.

void setEnabled(bool enabled): Sets if the item is enabled.

void setChecked(bool checked): Sets if the item is checked (has a cross in the ui).

void setVisible(bool visible): Sets the visibility of this item.

bool visible(): Checks the visibility of this item (non-recursively).

std::weak_ptr<AbstractActionItem> parentAction(): Returns the parent action, if it is added to a container.

void _setParentAction(std::shared_ptr<AbstractActionItem> parent): Sets the parent action. .

void initializeAsync(std::function<void()> oninitialized = 0): Asynchonously initializes the action.

void initializeSync(): Synchonously initializes the action.

bool isInitialized(): Checks if this action is initialized.

bool isInitializing(): Checks if this action is initializing.

Signals

void changed(): Emits when some data changed.

namespace base¶

Core logic.

Includes common data structures and some basic infrastructure. Some other namespaces in sh contain parts of the infrastructure as well.

Enums

enum LogSeverity¶

The severity of a log message.

Values:

enumerator DEBUG = 0¶

enumerator INFO = 100¶

enumerator _DEFAULT = INFO ¶

enumerator WARNING = 200¶

enumerator ERROR = 300¶

enumerator E_RROR = ERROR ¶

class IconManager : public QObject, public sh::base::Singleton

#include <iconmanager.h>

Fetches icons according to theme availability and settings.

Public Functions

QIcon getIcon(QString mainname, QString emblemname = QString(), QString miniemblemname = QString(), QStringList tags = QStringList()): Creates a QIcon from the icon name(s). Uses a cache.

QIcon getIconByFullname(QString fullname): Creates a QIcon from the icon fullname. Uses a cache.

QIcon getIcon(QIcon mainicon, QString emblemname, QString miniemblemname, QStringList tags): Creates a QIcon based on an existing one. Uncached.

QPixmap getPixmap(QString name, int size = 22): Creates a QPixmap for an icon name. Uncached.

~IconManager()

void doInitialize(): Executes singleton initialization.

void doShutdown(): Executes singleton shutdown.

void shutdown(): Shutdown down this singleton.

bool isAlive(): Returns if this singleton is alive (true until its shutdown begins).

Private Functions

IconManager()

QIcon _getIcon(QString name)

QImage _colourImage(QImage img, QColor color)

Private Members

QMutex cachemutex

QHash<QString, QIcon> cache

QList<GetIconStrategy*> getIconStrategies

std::shared_ptr<sh::configuration::ConfigurationValue> cfgvalPreferredStrategy

class GetIconStrategy

Subclassed by sh::base::IconManager::IncludedGetIconStrategy, sh::base::IconManager::QIconFromThemeGetIconStrategy

Public Functions

QIcon getIcon(QString name) = 0

~GetIconStrategy()

class IncludedGetIconStrategy : public sh::base::IconManager::GetIconStrategy

Public Functions

IncludedGetIconStrategy()

QIcon getIcon(QString name)

Private Members

QColor brandingcolor1

QColor brandingcolor2

class QIconFromThemeGetIconStrategy : public sh::base::IconManager::GetIconStrategy

Public Functions

QIconFromThemeGetIconStrategy()

QIcon getIcon(QString name)

Private Members

QHash<QString, QString> _aliases

class Logger : public QObject, public sh::base::Singleton

#include <logger.h>

The logging manager.

Use it for writing messages to the Shallot log and for reading from it.

Note: Logging is easiest by the LOG_* macros like SH_LOG_INFO (and it provides more meta data!).

Public Functions

void logException(sh::exceptions::Exception &ex, LogSeverity severity = LogSeverity::ERROR, QString source = QString()): Logs an exception.

void log(QString message, LogSeverity severity, QString source = QString()): Logs a message.

QString getLogAsText(LogSeverity minseverity = LogSeverity::DEBUG): Returns all logged messages as one text.

QList<LogMessage*> logMessages(): Returns the list of logged messages.

QString logPrefix(): Returns the log prefix, i.e. an optional string all log output begins with.

~Logger()

void doInitialize(): Executes singleton initialization.

void doShutdown(): Executes singleton shutdown.

void shutdown(): Shutdown down this singleton.

bool isAlive(): Returns if this singleton is alive (true until its shutdown begins).

Signals

void newLogMessageArrived(): Emitted when a new log message was written.

Private Functions

Logger()

Private Members

QMutex mutex

QList<LogMessage*> _logMessages

QString _logPrefix

struct LogMessage

#include <logger.h>

A single log message.

Public Members

QString message

LogSeverity severity

QString source

QDateTime time

class MainThread

#include <mainthread.h>

The main thread.

Lots of data structure may only accessed from the main thread. The UI and the sh::filesystem::FilesystemModel also live in this thread (although some functions there may allow multi-threading in some ways).

Public Static Functions

sh::base::ThreadDispatcher *dispatcher(): The sh::base::ThreadDispatcher, which allows to execute code in the main thread.

class ShallotProcess : public sh::base::Singleton

#include <shallotprocess.h>

Provides parameters given from the user by command line and some more simple infos.

Public Functions

QString uiMode(): The ui mode (e.g. “qt”, “web”) specified on command line.

QMap<QString, QString> configurationValueAssignments(): The configuration value assignments set on command line.

QList<QString> configurationValueFiles(): The configuration value files set on command line.

QString parameterValue(QString key, QString deflt = QString()): Returns the command line parameter value for a key as string.

QStringList parameterValueList(QString key): Returns the command line parameter value for a key as list of strings (for multiple parameter usage).

qint64 parameterValueInt(QString key, qint64 deflt = 0): Returns the command line parameter value for a key as integer.

QStringList parameters(): Returns the list of keys of all specified command line parameter names.

QString initialWorkDirectory(): Returns the initial directory specified on command line.

QString logPrefix(): Returns the log prefix (i.e. an optional string all log output begins with) specified on command line.

QStringList lang(): Returns the ui language specified on command line.

QColor brandingColor(): Returns the Shallot branding color (typically a dark red).

int minport(): Return the minimal allowed port specified on command line (for web ui).

int maxport(): Return the maximal allowed port specified on command line (for web ui).

int workerminport(): Return the minimal allowed port specified on command line for spawing web workers with (for web ui).

int workermaxport(): Return the maximal allowed port specified on command line for spawing web workers with (for web ui).

int maxnumberworkers(int deflt): Maximum number of workers specified on command line.

int maxnumberworkersperhost(int deflt): Maximum number of workers per host specified on command line.

int maxmemorypercent(int deflt): Maximum memory in percent specified on command line.

int maxmemorypercentglobal(int deflt): Maximum memory in percent globally specified on command line.

int maxbrowserawayseconds(int deflt): Maximum browser away time in seconds specified on command line.

int maxidlenessseconds(int deflt): Maximum user idleness time in seconds specified on command line.

void doInitialize(): Executes singleton initialization.

void doShutdown(): Executes singleton shutdown.

void shutdown(): Shutdown down this singleton.

bool isAlive(): Returns if this singleton is alive (true until its shutdown begins).

Public Static Functions

QString userDataDir(): Returns the path to a storage for per-user data. It resides somewhere within the user home directory.

QString shallotDataDir(): Returns the directory of the Shallot program data. It contains the static files which are part of the Shallot program.

QString revisionString(): Returns the Shallot revision string, i.e. the exact version number. Note: This is only updated by a special build tool (anise) and not by directly compiling via qmake.

QString homepage(): Returns the url to the Shallot homepage.

QDateTime buildtime(): Returns the time when this Shallot build was created. Note: This is only updated by a special build tool (anise) and not by directly compiling via qmake.

Private Functions

ShallotProcess()

Private Members

QMutex _brandingcolormutex

QMap<QString, QStringList> _cmdlineargs

QString _workdir

QString _ui

QMap<QString, QString> _cfgvalassignments

QList<QString> _cfgvalfiles

QColor _brandingcolor

std::shared_ptr<sh::configuration::ConfigurationValue> cfgvalBrandingColor

int _minport = 0

int _maxport = 0

int _workerminport = 0

int _workermaxport = 0

class Singleton

#include <singletoninitializer.h>

A singleton with initialization on Shallot startup and shutdown in the end.

See SingletonInitializer.

Subclassed by sh::actions::ActionsManager, sh::actions::mainmenu::ActionMain, sh::base::IconManager, sh::base::Logger, sh::base::ShallotProcess, sh::configuration::ConfigurationManager, sh::detailcolumns::DetailColumnCustomAttributes, sh::detailcolumns::DetailColumnDirectSymlinkTarget, sh::detailcolumns::DetailColumnExtendedAttributes, sh::detailcolumns::DetailColumnFilesize, sh::detailcolumns::DetailColumnMimetype, sh::detailcolumns::DetailColumnMtime, sh::detailcolumns::DetailColumnResolvedSymlink, sh::exceptions::ExceptionHandlerSettingsManager, sh::filesystem::FilesystemHandlerRegister, sh::filesystem::FilesystemModel, sh::filesystem::FilesystemModelDirectoryTreeProxy, sh::filesystem::FilesystemModelDirectoryTreeProxyVisibilityEnforcements, sh::filesystemhandlers::GnomeIODevicesFilesystemHandler, sh::filesystemhandlers::GnomeIONetworkFilesystemHandler, sh::filesystemhandlers::GnomeIOSmbFilesystemHandler, sh::filesystemhandlers::LocalFilesystemHandler, sh::filesystemhandlers::SharcFilesystemHandler, sh::paneldetails::PanelDetailManager, sh::scripting::api::ApiGlobalObject, sh::scripting::PythonScriptInterpreter, sh::scripting::ScriptingEngine, sh::search::SearchFilesystemHandler, sh::search::SearchManager, sh::settings::SettingsManager, sh::tools::accounts::AccountsManager, sh::tools::Benchmarking, sh::tools::BookmarkManager, sh::tools::DataExchange, sh::tools::filetypes::FileTypeManager, sh::tools::filetypes::UserDefinedOpenMethodDeterminationStrategy, sh::tools::LocalFilesystemWatcher, sh::tools::LocalFilesystemWatcherConnector, sh::tools::OperationsCache, sh::tools::ThumbnailManager, sh::tools::VisibleViews

Public Functions

void doInitialize(): Executes singleton initialization.

void doShutdown(): Executes singleton shutdown.

void shutdown(): Shutdown down this singleton.

bool isAlive(): Returns if this singleton is alive (true until its shutdown begins).

~Singleton()

Singleton(const Singleton&) = delete

Singleton(Singleton&&) = delete

Private Members

QMutex _mutex_shutdown

bool _shutdown = false

class SingletonInitializer

#include <singletoninitializer.h>

Takes care of initialization and shutdown of infrastructure singletons.

It is a very early part of shallot core infrastructure. Singletons typically participate by using those macros:

DECLARE_SINGLETON(STYPE): Used inside the singleton class definition. STYPE is the singleton’s class. It must be a subclass of sh::base::Singleton. It will get a static std::shared_ptr<STYPE> instance() method by that.

REGISTER_SINGLETON(NS, STYPE, GROUPNAME): Used inside the source file. NS is the namespace of the singleton. STYPE is the singleton’s class. GROUPNAME is the singleton group name (used for dependency handling, see later).

For singleton groups, there is REGISTER_SINGLETON_GROUP(GROUPNAME, ...): GROUPNAME is the group name used for grouping singletons together. Additional arguments are other group names; those groups are considered as dependencies, which must be fulfilled before this group can.

For just initializing stuff via static methods (without a singleton instance), use REGISTER_STATICINIT(NS, STYPE, GROUPNAME): NS is the namespace of the class to initialize. STYPE is the class to initialize. It must provide public static void doInitialize() and static void doShutdown(). GROUPNAME is the group name.

Public Functions

void callInitializers(): Executes all create-callbacks at first, then all init-callbacks. In both runs, the callbacks with lower index come first. Afterwards, the singletons are considered as up and running.

SingletonInitializer(): Constructed only by the infrastructure and made available otherwise.

~SingletonInitializer()

void shutdown(): Executes all shutdown-callbacks at first, then all remove-callbacks. The callback order is the reversed one of callInitializers. Afterwards, the singletons are considered as shut down and removed.

Public Static Functions

char registerGroup(QString groupname, QStringList groupdeps)

Registers a singleton group.

You should typically use REGISTER_SINGLETON_GROUP. See SingletonInitializer.

char registerSingleton(QString name, std::function<std::shared_ptr<Singleton>()> instancefctQString groupname, )

Registers a singleton.

You should typically use DECLARE_SINGLETON and REGISTER_SINGLETON. See SingletonInitializer.

QThread *initializerThread()

bool isShutdown(): If the singletons are completely shut down and removed.

Private Types

std::tuple< QString, QString, std::function< std::shared_ptr< Singleton >)> > SingletonTuple

typedef std::tuple<QString, QStringList> SingletonGroupTuple

Private Static Functions

bool dependsOn(QString group, QString depgroup)

Private Static Attributes

QList<SingletonTuple> *_singletons

QHash<QString, SingletonGroupTuple> *_groups

bool _isshutdown = false

QMutex shutdownmutex

class ThreadDispatcher : public QObject

#include <threaddispatcher.h>

Dispatcher for sync/async invocation of functions into the associated thread.

Public Functions

ThreadDispatcher(QObject *parent, QThread *thread): Constructed only by the infrastructure and made available otherwise.

void invokeSync(std::function<void()>)

Synchronously executes a function in the dispatcher’s thread.

If it already runs in the current thread, it just executes the function. It returns when the function is completely executed.

void invokeAsync(std::function<void()>)

Asynchronously executes a function in the dispatcher’s thread.

It directly returns. The actual execution will take place in a later message loop iteration of that thread.

void invokeAsync(std::function<void()>std::shared_ptr<void> obj1, std::shared_ptr<void> obj2 = 0, std::shared_ptr<void> obj3 = 0, ): Like the other variant, but it can also conserve some shared pointers until after execution.

bool inThread(): Returns if the current thread is already equal to the dispatcher’s thread (so dispatching isn’t required).

Signals

void _invoked()

Private Functions

void _invokeAsync(std::function<void()>)

Private Members

QMutex callsmutex

QThread *_thread

QQueue<std::function<void()>> _queue

Private Slots

void slot_invoked()

class ThreadPool : public QObject

#include <threadpool.h>

A pool of worker threads doing some short jobs from a queue.

Public Static Functions

void enqueueForce(std::function<void()> fct): Enqueues code to the threadpool.

void enqueueForce(std::function<void()> fctstd::shared_ptr<void> obj1, std::shared_ptr<void> obj2 = 0, std::shared_ptr<void> obj3 = 0, )

Enqueues code to the threadpool.

It can also conserve some shared pointers until after execution.

void enqueueForceBeyondAsyncCallBarrier(std::function<void()> fctstd::shared_ptr<void> obj1 = 0, std::shared_ptr<void> obj2 = 0, std::shared_ptr<void> obj3 = 0, )

Enqueues code to the threadpool and forbids async calls within it. This is useful for ensuring that no code might access a certain object after its deletion.

It can also conserve some shared pointers until after execution.

void enqueueIfIn(std::function<void()> fctQThread *thread, ): Enqueues code to the threadpool if currently in thread. Otherwise executes directly.

void enqueueIfInMain(std::function<void()> fct): Enqueues code to the threadpool if currently in main thread. Otherwise executes directly.

void doShutdown(): Only called by the Shallot infrastructure for shutdown.

bool isShuttingDown()

bool isShutdown()

int getThreadCount()

void respectThreadAbort()

void doInitialize()

Private Static Functions

void _enqueueForce(std::function<void()> fct)

Private Static Attributes

const int THREAD_COUNT = 10

QMutex poolmutex

QWaitCondition pooladdedcondition

QList<std::function<void()>> tasks

bool _shutsdown = false

QList<ThreadPoolThread*> _threads

int _threadsalive = 0

Friends

friend class ThreadPoolThread

class ThreadPoolThread : public QThread

#include <threadpool.h>

A thread in the thread pool.

Friends

friend class ThreadPool

namespace configuration¶

Configuration, so everything you see in ‘Finetuning’, and some other data (e.g. get shallot program directory).

Enums

enum ConfigurationCategory¶

Categories of Configursh::configuration::ConfigurationValuentations. They are used for grouping them in the dialogs. There is no difference in behavior implied by this choice.

Values:

enumerator CategoryNone = 0¶: No category.

enumerator CategoryGUI = 1¶: User interface category.

enumerator CategoryBehavior = 2¶: Behavioral configuration category.

enumerator CategoryExternalTools = 3¶: External tools category.

class ConfigurationManager : public QObject, public sh::base::Singleton

#include <configurationmanager.h>

Manages the Shallot configuration.

This is the more static part of Shallot. Much more stuff, i.e. everything you see in ‘Manage saved settings’, is in sh::settings::SettingsManager.

Public Functions

std::shared_ptr<ConfigurationValue> registerConfigValue(QString name, QVariant deflt, ConfigurationValueType *valuetype = 0, QString desc = "", ConfigurationCategory cat = CategoryNone, QString longdesc = "", QString changehint = ""): Creates and registers a new ConfigurationValue. This is typically done once at the beginning. Each registered instance is shown in the ‘Tuning’ dialog and can be set (for making changes) and observed (for applying changes) in code as well. Useful e.g. for some internal bookkeeping or for exotic machine-wide configuration values (path to some tool, …).

QList<std::shared_ptr<ConfigurationValue>> getAllConfigurationValues(): Returns a list of all registered configuration value instances.

void doInitialize(): Executes singleton initialization.

void doShutdown(): Executes singleton shutdown.

void shutdown(): Shutdown down this singleton.

bool isAlive(): Returns if this singleton is alive (true until its shutdown begins).

Private Functions

QVariant getFixedConfigValue(QString key): Returns a non-null value if ‘key’ was set in a fixed way (e.g. via command line).

ConfigurationManager()

Private Members

QHash<QString, std::shared_ptr<ConfigurationValue>> _configvalues

QHash<QString, QVariant> _fixed_configvalues

bool _fixed_configvalues_initialized = false

QMutex _mutex

class ConfigurationValueImpl : public sh::configuration::ConfigurationValue

Public Functions

ConfigurationValueImpl(QString name, QVariant deflt, QString desc, QString longdesc, ConfigurationCategory cat, ConfigurationValueType *valuetype, QString changehint, ConfigurationManager *mgr)

void setConfigValue(QVariant value) override: Sets a new configuration value.

QVariant getConfigValueVariant() override: Returns the current value of this instance as variant.

bool mayChange() override: Returns if changes are allowed.

int getConfigValueInt(): Returns the current value of this instance as integer.

double getConfigValueFloat(): Returns the current value of this instance as floating point number.

bool getConfigValueBool(): Returns the current value of this instance as boolean.

QString getConfigValueString(): Returns the current value of this instance as string.

void consumeValue(QObject *o, std::function<void()> h)

Adds a consumer function, triggered directly and whenever the value changes.

Parameters

o: For lifetime monitoring.

QString name(): Returns the internal name of this configuration.

QString description(): Returns the short description of this configuration.

QString longDescription(): Returns the long description of this configuration.

ConfigurationCategory category(): Returns the category of this configuration (mainly for UI structuring).

QString changeHint(): Returns the change hint text of this configuration.

QVariant defaultValue(): Returns the default value of this configuration.

ConfigurationValueType *valueType(): Returns the value type of this configuration.

Public Static Functions

ConfigurationValueType *valueTypeString(): Returns the string type for configuration values.

ConfigurationValueType *valueTypeInteger(): Returns the integer type for configuration values.

ConfigurationValueType *valueTypeFloat(): Returns the floating point number type for configuration values.

ConfigurationValueType *valueTypeBoolean(): Returns the boolean type for configuration values.

ConfigurationValueType *valueTypeLocalFilePath(): Returns the filepath type for configuration values.

Private Members

ConfigurationManager *mgr

class ConfigurationValue

#include <configurationvalue.h>

Abstract base class for a configuration value which is managed in the Tuning dialog.

Each instance can get and set the value associated to it.

You should typically not need to override it. See sh::configuration::ConfigurationManager. See Shallot documentation for more details.

Subclassed by sh::configuration::ConfigurationManager::ConfigurationValueImpl

Public Functions

ConfigurationValue(QString name, QVariant deflt, QString desc, QString longdesc, ConfigurationCategory cat, ConfigurationValueType *valuetype, QString changehint)

int getConfigValueInt(): Returns the current value of this instance as integer.

double getConfigValueFloat(): Returns the current value of this instance as floating point number.

bool getConfigValueBool(): Returns the current value of this instance as boolean.

QString getConfigValueString(): Returns the current value of this instance as string.

QVariant getConfigValueVariant() = 0: Returns the current value of this instance as variant.

void setConfigValue(QVariant value) = 0: Sets a new configuration value.

bool mayChange() = 0: Returns if changes are allowed.

void consumeValue(QObject *o, std::function<void()> h)

Adds a consumer function, triggered directly and whenever the value changes.

Parameters

o: For lifetime monitoring.

QString name(): Returns the internal name of this configuration.

QString description(): Returns the short description of this configuration.

QString longDescription(): Returns the long description of this configuration.

ConfigurationCategory category(): Returns the category of this configuration (mainly for UI structuring).

QString changeHint(): Returns the change hint text of this configuration.

QVariant defaultValue(): Returns the default value of this configuration.

ConfigurationValueType *valueType(): Returns the value type of this configuration.

Public Static Functions

ConfigurationValueType *valueTypeString(): Returns the string type for configuration values.

ConfigurationValueType *valueTypeInteger(): Returns the integer type for configuration values.

ConfigurationValueType *valueTypeFloat(): Returns the floating point number type for configuration values.

ConfigurationValueType *valueTypeBoolean(): Returns the boolean type for configuration values.

ConfigurationValueType *valueTypeLocalFilePath(): Returns the filepath type for configuration values.

Friends

friend class ConfigurationManager

friend class ConfigurationValueType

class ConfigurationValueType

#include <configurationvaluetype.h>

Abstract base class for a configuration value type.

Each subclass implements support for a certain type of configuration values (e.g. string, integer, …).

Subclassed by sh::configuration::ConfigurationValueTypeBoolean, sh::configuration::ConfigurationValueTypeFloat, sh::configuration::ConfigurationValueTypeInteger, sh::configuration::ConfigurationValueTypeLocalFilePath, sh::configuration::ConfigurationValueTypeString

Public Functions

QString valueDescription(QVariant v)

QVariant parse(QString input)

class ConfigurationValueTypeBoolean : public sh::configuration::ConfigurationValueType

#include <configurationvaluetype.h>

Configuration value type ‘boolean’.

Public Functions

QString valueDescription(QVariant v)

QVariant parse(QString input)

class ConfigurationValueTypeFloat : public sh::configuration::ConfigurationValueType

#include <configurationvaluetype.h>

Configuration value type ‘float’.

Public Functions

QString valueDescription(QVariant v)

QVariant parse(QString input)

class ConfigurationValueTypeInteger : public sh::configuration::ConfigurationValueType

#include <configurationvaluetype.h>

Configuration value type ‘integer’.

Public Functions

QString valueDescription(QVariant v)

QVariant parse(QString input)

class ConfigurationValueTypeLocalFilePath : public sh::configuration::ConfigurationValueType

#include <configurationvaluetype.h>

Configuration value type ‘file path’.

Public Functions

QString valueDescription(QVariant v)

QVariant parse(QString input)

class ConfigurationValueTypeString : public sh::configuration::ConfigurationValueType

#include <configurationvaluetype.h>

Configuration value type ‘string’.

Public Functions

QString valueDescription(QVariant v)

QVariant parse(QString input)

namespace detailcolumns¶

Implementations of detail columns.

Subclasses of sh::filesystem::DetailColumn (and possibly some auxiliary stuff). They are shown in the fileviews and can be queried in code.

class DetailColumnCustomAttributes : public sh::filesystem::DetailColumn, public sh::base::Singleton

#include <detailcolumncustomattributes.h>

Detail column which determines the custom attributes.

Custom attributes are filesystem handler specific values about files (like permissions).

Public Functions

void applyValueByEurl(std::shared_ptr<const sh::filesystem::Eurl> eurl, sh::filesystem::Operation *op, QVariant value) override

QString name(): The internal unique name.

QString displayName(): The display name.

bool isValueAvailable(std::shared_ptr<FilesystemNode> node): Checks if a value for this detail is available for one given node.

QVariant value(std::shared_ptr<FilesystemNode> node, bool ignoreAged = false)

Returns the value for this detail for one given node.

Parameters

ignoreAged: If no value should be returned which is older than the last request (not useful for nearly all cases).

QString displayValue(std::shared_ptr<FilesystemNode> node, const sh::filesystem::FilesystemModelFileviewProxy *viewmodel): Returns the stringified value for this details for one given node considering the configuration of a view.

QVariant requestValue(std::shared_ptr<FilesystemNode> node, sh::filesystem::Operation *op = 0, bool withNodeValues = false, bool withOperationsCache = true): Requests to determine the value for this detail for one given node. Blocks until the value is available. Get it with the value method afterwards.

bool sort_doTypediff(): If sorting should separate files and directories.

int sort_order(std::shared_ptr<FilesystemNode> n1, std::shared_ptr<FilesystemNode> n2): The sorting order.

uint displayIndex(): Controls which place this column should get in the user interface.

QVariant computeValue(std::shared_ptr<FilesystemNode> node, sh::filesystem::Operation *op): Returns a freshly determined value for this column and the given node. It neither asks nor populates any caches or storages.

int defaultWidth()

bool isRightAligned()

void applyValueByEurl(std::shared_ptr<const sh::filesystem::Eurl> eurl, sh::filesystem::Operation *op, QVariant value)

Applies the detail value to a given eurl (without using any caches).

Used for transferring some details when a file transfer occurs.

Optionally implement the one of the applyValueBy… methods and register the instance with sh::filesystem::FilesystemOperation::addTransferrableDetailColumn. For performance reasons, you should decide to implement applyValueByEurl.

void applyValueByNode(std::shared_ptr<FilesystemNode> node, sh::filesystem::Operation *op, QVariant value)

Applies the detail value to a given node (without using any caches).

Used for transferring some details when a file transfer occurs.

Optionally implement the one of the applyValueBy… methods and register the instance with sh::filesystem::FilesystemOperation::addTransferrableDetailColumn. For performance reasons, you should decide to implement applyValueByEurl.

void doShutdown(): Executes singleton shutdown.

void shutdown(): Shutdown down this singleton.

bool isAlive(): Returns if this singleton is alive (true until its shutdown begins).

Public Static Functions

QMap<QString, QString> getMapByValue(QVariant val): Converts the QVariant(QString) from native detail column representation to a QString/QString map.

QVariant VALUE_UNAVAILABLE(): A special value expressing that the value is not yet available.

void registerKnownDetailColumn(QString name, std::shared_ptr<DetailColumn> column)

std::shared_ptr<DetailColumn> findKnownDetailColumn(QString name)

Public Static Attributes

const uint DISPLAYINDEX_CORE = 10000

const uint DISPLAYINDEX_INTERESTING = 20000

const uint DISPLAYINDEX_EXOTIC = 30000

Private Functions

DetailColumnCustomAttributes()

class DetailColumnDirectSymlinkTarget : public sh::filesystem::DetailColumn, public sh::base::Singleton

#include <detailcolumndirectsymlinktarget.h>

Detail column which determines the direct symlink target (by resolving a link once).

Public Functions

QString name(): The internal unique name.

QString displayName(): The display name.

bool isValueAvailable(std::shared_ptr<FilesystemNode> node): Checks if a value for this detail is available for one given node.

QVariant value(std::shared_ptr<FilesystemNode> node, bool ignoreAged = false)

Returns the value for this detail for one given node.

Parameters

ignoreAged: If no value should be returned which is older than the last request (not useful for nearly all cases).

QString displayValue(std::shared_ptr<FilesystemNode> node, const sh::filesystem::FilesystemModelFileviewProxy *viewmodel): Returns the stringified value for this details for one given node considering the configuration of a view.

QVariant requestValue(std::shared_ptr<FilesystemNode> node, sh::filesystem::Operation *op = 0, bool withNodeValues = false, bool withOperationsCache = true): Requests to determine the value for this detail for one given node. Blocks until the value is available. Get it with the value method afterwards.

bool sort_doTypediff(): If sorting should separate files and directories.

int sort_order(std::shared_ptr<FilesystemNode> n1, std::shared_ptr<FilesystemNode> n2): The sorting order.

uint displayIndex(): Controls which place this column should get in the user interface.

QVariant computeValue(std::shared_ptr<FilesystemNode> node, sh::filesystem::Operation *op): Returns a freshly determined value for this column and the given node. It neither asks nor populates any caches or storages.

int defaultWidth()

bool isRightAligned()