ParaView
pqProxyGroupMenuManager.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqProxyGroupMenuManager.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 pqProxyGroupMenuManager_h
33 #define pqProxyGroupMenuManager_h
34 
35 #include "pqApplicationComponentsModule.h"
36 #include <QMenu>
37 
38 class vtkPVXMLElement;
39 class vtkSMProxy;
40 
46 class PQAPPLICATIONCOMPONENTS_EXPORT pqProxyGroupMenuManager : public QObject
47 {
48  Q_OBJECT
49  typedef QObject Superclass;
50 
51 public:
58  pqProxyGroupMenuManager(QMenu* menu, const QString& resourceTagName);
60 
64  QMenu* menu() const { return static_cast<QMenu*>(this->parent()); }
65 
70  void setRecentlyUsedMenuSize(unsigned int val) { this->RecentlyUsedMenuSize = val; }
71 
72  unsigned int recentlyUsedMenuSize() const { return this->RecentlyUsedMenuSize; }
73 
77  QWidget* widgetActionsHolder() const;
78 
82  QList<QAction*> actions() const;
83 
87  vtkSMProxy* getPrototype(QAction* action) const;
88 
92  void addProxy(const QString& xmlgroup, const QString& xmlname);
93 
97  void removeProxy(const QString& xmlgroup, const QString& xmlname);
98 
103  QStringList getToolbarCategories() const;
104 
108  QList<QAction*> actions(const QString& category);
109 
113  QList<QAction*> actionsInToolbars();
114 
118  bool hideForTests(const QString& category) const;
119 
128  void addProxyDefinitionUpdateListener(const QString& proxyGroupName);
129  void removeProxyDefinitionUpdateListener(const QString& proxyGroupName);
130 
131 public slots:
138  void loadConfiguration(vtkPVXMLElement*);
139 
143  void lookForNewDefinitions();
144 
148  void removeProxyDefinitionUpdateObservers();
149 
153  void addProxyDefinitionUpdateObservers();
154 
158  void setEnabled(bool enable);
159 
164  void populateMenu();
165 
166 signals:
167  void triggered(const QString& group, const QString& name);
168 
173  void menuPopulated();
174 
175 protected slots:
176  void triggered();
177  void quickLaunch();
178  void switchActiveServer();
179 
180 protected:
184  bool Enabled;
185 
186  void loadRecentlyUsedItems();
187  void saveRecentlyUsedItems();
188  void populateRecentlyUsedMenu(QMenu*);
189 
193  QAction* getAction(const QString& pgroup, const QString& proxyname);
194 
195 private:
196  Q_DISABLE_COPY(pqProxyGroupMenuManager)
197 
198  class pqInternal;
199  pqInternal* Internal;
200 };
201 
202 #endif
unsigned int recentlyUsedMenuSize() const
void setRecentlyUsedMenuSize(unsigned int val)
When size>0 a recently used category will be added to the menu.
pqProxyGroupMenuManager is a menu-populator that fills up a menu with proxies defined in an XML confi...
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:152
This is used by vtkPVXMLParser to represent an XML document starting at the root element.
QMenu * menu() const
Access the menu.