pqCustomViewpointButtonDialog.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqCustomViewpointButtonDialog.h
5 
6  Copyright (c) 2005-2008 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 pqCustomViewpointButtonDialog_h
33 #define pqCustomViewpointButtonDialog_h
34 
35 #include "pqComponentsModule.h"
36 
37 #include <QDialog>
38 #include <QLineEdit>
39 #include <QList>
40 #include <QPointer>
41 #include <QPushButton>
42 #include <QString>
43 #include <QStringList>
44 
45 class pqCustomViewpointButtonDialogUI;
47 
48 /*
49  * @class pqCustomViewpointDialog
50  * @brief Dialog for configuring custom view buttons.
51  *
52  * Provides the machinery for associating the current camera configuration
53  * to a custom view button, and importing or exporting all of the custom view
54  * button configurations.
55  *
56  * @section thanks Thanks
57  * This class was contributed by SciberQuest Inc.
58  *
59  * @sa pqCameraDialog
60  */
62 {
63  Q_OBJECT
64 
65 public:
69  pqCustomViewpointButtonDialog(QWidget* parent, Qt::WindowFlags f, QStringList& toolTips,
70  QStringList& configurations, QString& currentConfig);
71 
73 
77  const static QString DEFAULT_TOOLTIP;
78 
82  const static int MINIMUM_NUMBER_OF_ITEMS;
83 
87  const static int MAXIMUM_NUMBER_OF_ITEMS;
88 
93  void setToolTipsAndConfigurations(const QStringList& toolTips, const QStringList& configs);
94 
96 
101  void setToolTips(const QStringList& toolTips);
102  QStringList getToolTips();
104 
106 
111  void setConfigurations(const QStringList& configs);
112  QStringList getConfigurations();
114 
116 
119  void setCurrentConfiguration(const QString& config);
120  QString getCurrentConfiguration();
122 
123 private Q_SLOTS:
124  void appendRow();
125  void importConfigurations();
126  void exportConfigurations();
127  void clearAll();
128 
129  void assignCurrentViewpoint();
130  void deleteRow();
131 
132 private: // NOLINT(readability-redundant-access-specifiers)
133  pqCustomViewpointButtonDialog() = default;
134  QStringList Configurations;
135  QString CurrentConfiguration;
136  pqCustomViewpointButtonDialogUI* ui;
137 
138  friend class pqCustomViewpointButtonDialogUI;
139 };
140 #endif
#define PQCOMPONENTS_EXPORT
A reader for XML camera configuration.
static const int MINIMUM_NUMBER_OF_ITEMS
Constant variable that defines the minimum number of items.
static const QString DEFAULT_TOOLTIP
Constant variable that contains the default name for the tool tips.
static const int MAXIMUM_NUMBER_OF_ITEMS
Constant variable that defines the maximum number of items.