pqStandardRecentlyUsedResourceLoaderImplementation.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqStandardRecentlyUsedResourceLoaderImplementation.h
5 
6  Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
7  All rights reserved.
8 
9  ParaView is a free software; you can redistribute it and/or modify it
10  under the terms of the ParaView license version 1.2.
11 
12  See License_v1.2.txt for the full ParaView license.
13  A copy of this license can be obtained by contacting
14  Kitware Inc.
15  28 Corporate Drive
16  Clifton Park, NY 12065
17  USA
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
23 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 ========================================================================*/
32 #ifndef pqStandardRecentlyUsedResourceLoaderImplementation_h
33 #define pqStandardRecentlyUsedResourceLoaderImplementation_h
34 
36 
37 #include "pqApplicationComponentsModule.h" // needed for export macros
38 #include <QObject> // needed for QObject
39 #include <QStringList> // needed for QStringList
40 
52  : public QObject,
54 {
55  Q_OBJECT
57 
58  typedef QObject Superclass;
59 
60 public:
63 
64  bool canLoad(const pqServerResource& resource) override;
65  bool load(const pqServerResource& resource, pqServer* server) override;
66  QIcon icon(const pqServerResource& resource) override;
67  QString label(const pqServerResource& resource) override;
68 
72  static bool addDataFilesToRecentResources(
73  pqServer* server, const QStringList& files, const QString& smgroup, const QString& smname);
74 
78  static bool addStateFileToRecentResources(pqServer* server, const QString& file);
79 
80 private:
82 
83  bool loadState(const pqServerResource& resource, pqServer* server);
84  bool loadData(const pqServerResource& resource, pqServer* server);
85 };
86 
87 #endif
virtual bool load(const pqServerResource &resource, pqServer *server)=0
Loads the resource and returns the true if successfully loaded, otherwise false.
#define PQAPPLICATIONCOMPONENTS_EXPORT
virtual bool canLoad(const pqServerResource &resource)=0
Return true of the interface supports loading the given resource.
abstract interface used to load recently used resources.
virtual QString label(const pqServerResource &resource)=0
Return label to use for the resource.
support loading states, and data files when loaded from pqRecentFilesMenu.
virtual QIcon icon(const pqServerResource &resource)
Return an icon, if any, to use for the resource.
pqServerResource encapsulates a resource in ParaView.
pqServer (should be renamed to pqSession) is a pqServerManagerModelItem subclass that represents a vt...
Definition: pqServer.h:64