Public Member Functions | Static Public Member Functions | List of all members
pqStandardRecentlyUsedResourceLoaderImplementation Class Reference

support loading states, and data files when loaded from pqRecentFilesMenu. More...

#include <pqStandardRecentlyUsedResourceLoaderImplementation.h>

Inheritance diagram for pqStandardRecentlyUsedResourceLoaderImplementation:
Inheritance graph
[legend]
Collaboration diagram for pqStandardRecentlyUsedResourceLoaderImplementation:
Collaboration graph
[legend]

Public Member Functions

 pqStandardRecentlyUsedResourceLoaderImplementation (QObject *parent=nullptr)
 
 ~pqStandardRecentlyUsedResourceLoaderImplementation () override
 
bool canLoad (const pqServerResource &resource) override
 Return true of the interface supports loading the given resource. More...
 
bool load (const pqServerResource &resource, pqServer *server) override
 Loads the resource and returns the true if successfully loaded, otherwise false. More...
 
QIcon icon (const pqServerResource &resource) override
 Return an icon, if any, to use for the resource. More...
 
QString label (const pqServerResource &resource) override
 Return label to use for the resource. More...
 
- Public Member Functions inherited from pqRecentlyUsedResourceLoaderInterface
virtual ~pqRecentlyUsedResourceLoaderInterface ()
 

Static Public Member Functions

static bool addDataFilesToRecentResources (pqServer *server, const QStringList &files, const QString &smgroup, const QString &smname)
 Add data files(s) to the recently used resources list. More...
 
static bool addStateFileToRecentResources (pqServer *server, const QString &file, vtkTypeUInt32 location=0x10)
 Add state file to the recently used resources list. More...
 

Additional Inherited Members

- Protected Member Functions inherited from pqRecentlyUsedResourceLoaderInterface
 pqRecentlyUsedResourceLoaderInterface ()
 

Detailed Description

support loading states, and data files when loaded from pqRecentFilesMenu.

pqStandardRecentlyUsedResourceLoaderImplementation is an implementation of the pqRecentlyUsedResourceLoaderInterface that support loading resources known to ParaView e.g. data files and state files. pqParaViewBehaviors instantiates this unless pqParaViewBehaviors::enableStandardRecentlyUsedResourceLoader is false.

Definition at line 26 of file pqStandardRecentlyUsedResourceLoaderImplementation.h.

Constructor & Destructor Documentation

◆ pqStandardRecentlyUsedResourceLoaderImplementation()

pqStandardRecentlyUsedResourceLoaderImplementation::pqStandardRecentlyUsedResourceLoaderImplementation ( QObject *  parent = nullptr)

◆ ~pqStandardRecentlyUsedResourceLoaderImplementation()

pqStandardRecentlyUsedResourceLoaderImplementation::~pqStandardRecentlyUsedResourceLoaderImplementation ( )
override

Member Function Documentation

◆ canLoad()

bool pqStandardRecentlyUsedResourceLoaderImplementation::canLoad ( const pqServerResource resource)
overridevirtual

Return true of the interface supports loading the given resource.

Implements pqRecentlyUsedResourceLoaderInterface.

◆ load()

bool pqStandardRecentlyUsedResourceLoaderImplementation::load ( const pqServerResource resource,
pqServer server 
)
overridevirtual

Loads the resource and returns the true if successfully loaded, otherwise false.

If returned false, the resource is treated as defunct and may be removed. from the recent list.

Implements pqRecentlyUsedResourceLoaderInterface.

◆ icon()

QIcon pqStandardRecentlyUsedResourceLoaderImplementation::icon ( const pqServerResource resource)
overridevirtual

Return an icon, if any, to use for the resource.

Default implementation simply returns an empty QIcon.

Reimplemented from pqRecentlyUsedResourceLoaderInterface.

◆ label()

QString pqStandardRecentlyUsedResourceLoaderImplementation::label ( const pqServerResource resource)
overridevirtual

Return label to use for the resource.

Implements pqRecentlyUsedResourceLoaderInterface.

◆ addDataFilesToRecentResources()

static bool pqStandardRecentlyUsedResourceLoaderImplementation::addDataFilesToRecentResources ( pqServer server,
const QStringList &  files,
const QString &  smgroup,
const QString &  smname 
)
static

Add data files(s) to the recently used resources list.

◆ addStateFileToRecentResources()

static bool pqStandardRecentlyUsedResourceLoaderImplementation::addStateFileToRecentResources ( pqServer server,
const QString &  file,
vtkTypeUInt32  location = 0x10 
)
static

Add state file to the recently used resources list.


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