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 
44 class PQAPPLICATIONCOMPONENTS_EXPORT pqProxyGroupMenuManager : public QObject
45 {
46  Q_OBJECT
47  typedef QObject Superclass;
48 public:
53  pqProxyGroupMenuManager(QMenu* menu, const QString& resourceTagName);
55 
57  QMenu* menu() const
58  { return static_cast<QMenu*>(this->parent()); }
59 
62  void setRecentlyUsedMenuSize(unsigned int val)
63  { this->RecentlyUsedMenuSize = val; }
64 
65  unsigned int recentlyUsedMenuSize() const
66  { return this->RecentlyUsedMenuSize; }
67 
69  QWidget* widgetActionsHolder() const;
70 
72  QList<QAction*> actions() const;
73 
75  vtkSMProxy* getPrototype(QAction* action) const;
76 
78  void addProxy(const QString& xmlgroup, const QString& xmlname);
79 
81  void removeProxy(const QString& xmlgroup, const QString& xmlname);
82 
85  QStringList getToolbarCategories() const;
86 
88  QList<QAction*> actions(const QString& category);
89 
91  QList<QAction*> actionsInToolbars();
92 
94  bool hideForTests(const QString& category) const;
95 
102  void addProxyDefinitionUpdateListener(const QString& proxyGroupName);
103  void removeProxyDefinitionUpdateListener(const QString& proxyGroupName);
104 
105 public slots:
110  void loadConfiguration(vtkPVXMLElement*);
111 
113  void lookForNewDefinitions();
114 
116  void removeProxyDefinitionUpdateObservers();
117 
119  void addProxyDefinitionUpdateObservers();
120 
122  void setEnabled(bool enable);
123 
126  void populateMenu();
127 
128 signals:
129  void triggered(const QString& group, const QString& name);
130 
133  void menuPopulated();
134 
135 protected slots:
136  void triggered();
137  void quickLaunch();
138  void switchActiveServer();
139 
140 protected:
142  vtkPVXMLElement* MenuRoot;
144  bool Enabled;
145 
146  void loadRecentlyUsedItems();
147  void saveRecentlyUsedItems();
148  void populateRecentlyUsedMenu(QMenu*);
149 
151  QAction* getAction(const QString& pgroup, const QString& proxyname);
152 
153 private:
154  Q_DISABLE_COPY(pqProxyGroupMenuManager)
155 
156  class pqInternal;
157  pqInternal* Internal;
158 };
159 
160 #endif
161 
162 
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...
QMenu * menu() const
Access the menu.