Tulip  5.1.0
Large graphs analysis and drawing
RenamePropertyDialog.h
1 /*
2  *
3  * This file is part of Tulip (http://tulip.labri.fr)
4  *
5  * Authors: David Auber and the Tulip development Team
6  * from LaBRI, University of Bordeaux
7  *
8  * Tulip is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *
13  * Tulip is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU General Public License for more details.
17  *
18  */
19 ///@cond DOXYGEN_HIDDEN
20 
21 #ifndef RENAMEPROPERTYDIALOG_H
22 #define RENAMEPROPERTYDIALOG_H
23 
24 #include <tulip/tulipconf.h>
25 
26 class QWidget;
27 
28 namespace tlp {
29 class PropertyInterface;
30 
31 /**
32  * @brief Provide a dialog that allow user to rename a property.
33  *
34  * The easiest way to use this class is to use the renameProperty static function.
35  *
36  **/
37 
38 class TLP_QT_SCOPE RenamePropertyDialog {
39 public:
40 
41  /**
42  * @brief This is a convenience static function to rename a property using a dialog. If the user presses Cancel or an error occurs, it returns false.
43  *
44  * The function creates a modal property rename dialog with the given property, and parent widget.
45  *
46  * @param toRenameProp The property to rename.
47  **/
48  static bool renameProperty(tlp::PropertyInterface* toRenameProp,
49  QWidget* parent=NULL);
50 
51 };
52 }
53 #endif // RENAMEPROPERTYDIALOG_H
54 ///@endcond
PropertyInterface describes the interface of a graph property.