Tulip 5.7.1
Large graphs analysis and drawing
Loading...
Searching...
No Matches
RenamePropertyDialog.h
1/*
2 *
3 * This file is part of Tulip (https://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
26class QWidget;
27
28namespace tlp {
29class 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
38class TLP_QT_SCOPE RenamePropertyDialog {
39public:
40 /**
41 * @brief This is a convenience static function to rename a property using a dialog. If the user
42 *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
45 *widget.
46 *
47 * @param toRenameProp The property to rename.
48 **/
49 static bool renameProperty(tlp::PropertyInterface *toRenameProp, QWidget *parent = nullptr);
50};
51} // namespace tlp
52#endif // RENAMEPROPERTYDIALOG_H
53///@endcond
PropertyInterface describes the interface of a graph property.