#include <RecentFilesAction.h>

Inheritance diagram for hdps::gui::RecentFilesAction:

Classes
class	Dialog

class	FilterModel

class	Model

Signals
void	triggered (const QString &filePath)

void	recentFilesChanged (const RecentFiles &recentFiles)

Signals inherited from hdps::gui::WidgetAction
void	idChanged (const QString &id)

void	sortIndexChanged (std::int32_t sortIndex)

void	stretchChanged (std::int32_t stretch)

void	forceHiddenChanged (bool forceHidden)

void	forceDisabledChanged (bool forceDisabled)

void	highlightingChanged (const HighlightOption &highlightOption)

void	isPublishedChanged (const bool &isPublished)

void	isConnectedChanged (const bool &isConnected)

void	actionConnected (WidgetAction *action)

void	actionDisconnected (WidgetAction *action)

void	connectionPermissionsChanged (std::int32_t connectionPermissions)

void	configurationFlagToggled (const ConfigurationFlag &configurationFlag, bool set)

void	configurationChanged (std::int32_t configuration)

void	scopeChanged (const Scope &scope)

void	textChanged (const QString &text)

void	locationChanged (const QString &location)

Public Member Functions
Q_INVOKABLE	RecentFilesAction (QObject *parent, const QString &settingsKey="", const QString &fileType="", const QString &shortcutPrefix="", const QIcon &icon=QIcon())

void	initialize (const QString &settingsKey, const QString &fileType, const QString &shortcutPrefix, const QIcon &icon)

void	addRecentFilePath (const QString &filePath)

QString	getSettingsKey () const

QString	getFileType () const

QString	getShortcutPrefix () const

QIcon	getIcon () const

Model &	getModel ()

const FilterModel &	getFilterModel () const

TriggerAction &	getEditAction ()

QMenu *	getMenu ()

void	updateRecentFilePaths ()

QStringList	getRecentFilePaths () const

RecentFiles	getRecentFiles () const

Public Member Functions inherited from hdps::gui::WidgetAction
	WidgetAction (QObject *parent, const QString &title)

	~WidgetAction ()

virtual WidgetAction *	getParentAction () const final

virtual WidgetActions	getParentActions () const final

virtual WidgetActions	getChildren () const final

virtual bool	isRoot () const final

virtual bool	isLeaf () const final

virtual QWidget *	createWidget (QWidget *parent) override final

virtual QWidget *	createCollapsedWidget (QWidget *parent) const final

virtual QWidget *	createLabelWidget (QWidget *parent, const std::int32_t &widgetFlags=0x00001) const final

virtual QMenu *	getContextMenu (QWidget *parent=nullptr)

QWidget *	createWidget (QWidget *parent, const std::int32_t &widgetFlags)

virtual std::int32_t	getSortIndex () const final

virtual void	setSortIndex (const std::int32_t &sortIndex) final

virtual std::int32_t	getStretch () const final

virtual void	setStretch (const std::int32_t &stretch) final

virtual bool	getForceHidden () const final

virtual void	setForceHidden (bool forceHidden) final

virtual bool	isVisible () const final

virtual bool	getForceDisabled () const final

virtual void	setForceDisabled (bool forceDisabled) final

virtual bool	isEnabled () const final

void	setText (const QString &text)

virtual QString	getLocation () const

virtual std::int32_t	getDefaultWidgetFlags () const final

virtual void	setDefaultWidgetFlags (const std::int32_t &widgetFlags) final

virtual void	setDefaultWidgetFlag (const std::int32_t &widgetFlags, bool unset=false) final

virtual HighlightOption	getHighlighting () const final

virtual bool	isHighlighted () const final

virtual void	setHighlighting (const HighlightOption &highlighting) final

virtual void	setHighlighted (bool highlighted) final

virtual void	highlight () final

virtual void	unHighlight () final

virtual Scope	getScope () const final

virtual bool	isPrivate () const final

virtual bool	isPublic () const final

virtual bool	isPublished () const final

virtual bool	isConnected () const final

virtual bool	mayConnectToPublicAction (const WidgetAction *publicAction) const final

virtual bool	publish (const QString &name="", bool allowDuplicateName=false) final

virtual WidgetAction *	getPublicAction () final

virtual WidgetAction *	getPublicCopy () const final

virtual const WidgetActions	getConnectedActions () const final

virtual WidgetActions &	getConnectedActions () final

virtual bool	mayPublish (ConnectionContextFlag connectionContextFlags) const final

virtual bool	mayConnect (ConnectionContextFlag connectionContextFlags) const final

virtual bool	mayDisconnect (ConnectionContextFlag connectionContextFlags) const final

virtual std::int32_t	getConnectionPermissions () const final

virtual bool	isConnectionPermissionFlagSet (ConnectionPermissionFlag connectionPermissionsFlag) final

virtual void	setConnectionPermissionsFlag (ConnectionPermissionFlag connectionPermissionsFlag, bool unset=false, bool recursive=false) final

virtual void	setConnectionPermissions (std::int32_t connectionPermissions, bool recursive=false) final

virtual void	setConnectionPermissionsToNone (bool recursive=false) final

virtual void	setConnectionPermissionsToForceNone (bool recursive=false) final

virtual void	setConnectionPermissionsToAll (bool recursive=false) final

virtual void	cacheConnectionPermissions (bool recursive=false) final

virtual void	restoreConnectionPermissions (bool recursive=false) final

virtual void	startDrag () final

virtual bool	isResettable () const final

virtual void	reset () final

virtual void	setSettingsPrefix (const QString &settingsPrefix, const bool &load=true) final

virtual void	setSettingsPrefix (plugin::Plugin *plugin, const QString &settingsPrefix, const bool &load=true) final

virtual QString	getSettingsPrefix () const

virtual void	loadFromSettings () final

virtual void	saveToSettings () final

virtual QVector< WidgetAction * >	findChildren (const QString &searchString, bool recursive=true) const final

virtual QSize	getPopupSizeHint () const final

virtual void	setPopupSizeHint (const QSize &popupSizeHint) final

virtual std::int32_t	getConfiguration () const final

virtual bool	isConfigurationFlagSet (ConfigurationFlag configurationFlag) const final

virtual void	setConfigurationFlag (ConfigurationFlag configurationFlag, bool unset=false, bool recursive=false) final

virtual void	setConfiguration (std::int32_t configuration, bool recursive=false) final

virtual QString	getTypeString (bool humanFriendly=false) const final

void	fromVariantMap (const QVariantMap &variantMap) override

QVariantMap	toVariantMap () const override

virtual void	cacheState (const QString &name="cache") final

virtual void	restoreState (const QString &name="cache", bool remove=true) final

virtual void	setStudioMode (bool studioMode, bool recursive=true) final

Public Member Functions inherited from hdps::util::Serializable
	Serializable (const QString &serializationName="")

virtual QString	getId () const final

virtual void	setId (const QString &id) final

virtual QString	getSerializationName () const final

virtual void	setSerializationName (const QString &serializationName) final

virtual void	fromParentVariantMap (const QVariantMap &parentVariantMap)

virtual void	insertIntoVariantMap (QVariantMap &variantMap) const final

virtual void	fromJsonDocument (const QJsonDocument &jsonDocument) final

virtual QJsonDocument	toJsonDocument () const final

virtual void	fromJsonFile (const QString &filePath="") final

virtual void	toJsonFile (const QString &filePath="") final

virtual void	makeUnique () final

Additional Inherited Members
Public Types inherited from hdps::gui::WidgetAction
enum class	Scope { Private , Public }

enum class	HighlightOption { None , Moderate , Strong }

enum class	ConfigurationFlag { VisibleInMenu = 0x00001 , InternalUseOnly = 0x00002 , NoLabelInGroup = 0x00004 , ForceCollapsedInGroup = 0x00008 , ForceExpandedInGroup = 0x00010 , User = 0x00100 , Default = 0 }

enum	ConnectionContextFlag { Api = 0x00008 , Gui = 0x00010 , ApiAndGui = Api \| Gui }
	‍** Describes the connection context options *‍/ More...

enum class	ConnectionPermissionFlag { None = 0x00000 , PublishViaApi = 0x00001 , PublishViaGui = 0x00002 , PublishViaApiAndGui = PublishViaApi \| PublishViaGui , ConnectViaApi = 0x00008 , ConnectViaGui = 0x00010 , ConnectViaApiAndGui = ConnectViaApi \| ConnectViaGui , DisconnectViaApi = 0x00040 , DisconnectViaGui = 0x00080 , DisconnectViaApiAndGui = DisconnectViaApi \| DisconnectViaGui , ForceNone = 0x00100 , All = PublishViaApiAndGui \| ConnectViaApiAndGui \| DisconnectViaApiAndGui , Default = All }

Public Types inherited from hdps::util::Serializable
enum class	State { Idle , Reading , Writing }

Static Public Member Functions inherited from hdps::util::Serializable
static QString	createId ()

Static Public Attributes inherited from hdps::gui::WidgetAction
static QMap< Scope, QString >	scopeNames

Protected Member Functions inherited from hdps::gui::WidgetAction
virtual void	makePublic (bool recursive=true) final

virtual void	connectToPublicAction (WidgetAction *publicAction, bool recursive)

virtual void	connectToPublicActionByName (const QString &publicActionName) final

virtual void	disconnectFromPublicAction (bool recursive)

virtual QWidget *	getWidget (QWidget *parent, const std::int32_t &widgetFlags)

Static Protected Member Functions inherited from hdps::util::Serializable
static void	fromVariantMap (Serializable *serializable, const QVariantMap &variantMap)

static void	fromVariantMap (Serializable &serializable, const QVariantMap &variantMap, const QString &key)

static QVariantMap	toVariantMap (const Serializable *serializable)

static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap, const QString &key)

static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap)

Detailed Description

Recent files action class

Action class for storing and editing recent file paths and saving them to settings.

Author: Thomas Kroes

Constructor & Destructor Documentation

◆ RecentFilesAction()

hdps::gui::RecentFilesAction::RecentFilesAction	(	QObject *	parent,
		const QString &	settingsKey = `""`,
		const QString &	fileType = `""`,
		const QString &	shortcutPrefix = `""`,
		const QIcon &	icon = `QIcon()`
	)

Constructor

Parameters

parent	Pointer to parent object
settingsKey	Settings key where the recent file paths are stored
fileType	Type of file e.g. project or workspace
shortcutPrefix	Prefix of the shortcut
icon	Icon in menu

Member Function Documentation

◆ addRecentFilePath()

void hdps::gui::RecentFilesAction::addRecentFilePath ( const QString & filePath )

Add recent filePath

Parameters

filePath Recent file path

◆ getEditAction()

TriggerAction & hdps::gui::RecentFilesAction::getEditAction ( )

Get edit action

Returns: Action which triggers a dialog in which the recent file paths can be edited

◆ getFileType()

QString hdps::gui::RecentFilesAction::getFileType ( ) const

Get file type

Returns: Recent file type

◆ getFilterModel()

const RecentFilesAction::FilterModel & hdps::gui::RecentFilesAction::getFilterModel ( ) const

Get filter model

Returns: Reference to filter model

◆ getIcon()

QIcon hdps::gui::RecentFilesAction::getIcon ( ) const

Get icon

Returns: Icon for the recent file type

◆ getMenu()

QMenu * hdps::gui::RecentFilesAction::getMenu ( )

Get recent file paths menu

Returns: Pointer to menu

◆ getModel()

RecentFilesAction::Model & hdps::gui::RecentFilesAction::getModel ( )

Get model

Returns: Reference to model

◆ getRecentFilePaths()

QStringList hdps::gui::RecentFilesAction::getRecentFilePaths ( ) const

Get recent file paths

Returns: File paths as string list

◆ getRecentFiles()

RecentFiles hdps::gui::RecentFilesAction::getRecentFiles ( ) const

Get recent files

Returns: Recent files list

◆ getSettingsKey()

QString hdps::gui::RecentFilesAction::getSettingsKey ( ) const

Get settings key

Returns: Settings key where the recent file paths will be stored

◆ getShortcutPrefix()

QString hdps::gui::RecentFilesAction::getShortcutPrefix ( ) const

Get shortcut prefix

Returns: Shortcut prefix (if empty, no shortcut is created)

◆ initialize()

void hdps::gui::RecentFilesAction::initialize	(	const QString &	settingsKey,
		const QString &	fileType,
		const QString &	shortcutPrefix,
		const QIcon &	icon
	)

Initializes the action

Parameters

parent	Pointer to parent object
settingsKey	Settings key where the recent file paths are stored
fileType	Type of file e.g. project or workspace
shortcutPrefix	Prefix of the shortcut
icon	Icon in menu

◆ recentFilesChanged

void hdps::gui::RecentFilesAction::recentFilesChanged ( const RecentFiles & recentFiles )

signal

Signals that recent files changed

Parameters

recentFiles Recent files which changed

◆ triggered

void hdps::gui::RecentFilesAction::triggered ( const QString & filePath )

signal

Signals that recent filePath is triggered

◆ updateRecentFilePaths()

void hdps::gui::RecentFilesAction::updateRecentFilePaths ( )

Grab latest recent file paths from settings and update model

The documentation for this class was generated from the following files:

D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/actions/RecentFilesAction.h
D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/actions/RecentFilesAction.cpp

Classes

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RecentFilesAction()

Member Function Documentation

◆ addRecentFilePath()

◆ getEditAction()

◆ getFileType()

◆ getFilterModel()

◆ getIcon()

◆ getMenu()

◆ getModel()

◆ getRecentFilePaths()

◆ getRecentFiles()

◆ getSettingsKey()

◆ getShortcutPrefix()

◆ initialize()

◆ recentFilesChanged

◆ triggered

◆ updateRecentFilePaths()