File indexing completed on 2024-05-12 05:43:33

0001 /*
0002     Copyright (C) 2015 Volker Krause <vkrause@kde.org>
0003 
0004     This program is free software; you can redistribute it and/or modify it
0005     under the terms of the GNU Library General Public License as published by
0006     the Free Software Foundation; either version 2 of the License, or (at your
0007     option) any later version.
0008 
0009     This program is distributed in the hope that it will be useful, but WITHOUT
0010     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0011     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
0012     License for more details.
0013 
0014     You should have received a copy of the GNU General Public License
0015     along with this program.  If not, see <https://www.gnu.org/licenses/>.
0016 */
0017 
0018 #ifndef CODENAVIGATOR_H
0019 #define CODENAVIGATOR_H
0020 
0021 class QAction;
0022 class QString;
0023 class QUrl;
0024 class QWidget;
0025 
0026 /** Navigate to a given code path in your favorite IDE. */
0027 namespace CodeNavigator
0028 {
0029     /** Returns @c true if we can do code navigation. */
0030     bool isValid();
0031 
0032     /** Open @p filePath, and navigate to line @p line if that's greater or equal to 0. */
0033     void goTo(const QString &filePath, int line = -1);
0034     /** URL-encoded form of the above. */
0035     void goTo(const QUrl &url);
0036 
0037     /** Returns a action for selecting your preferred IDE. */
0038     QAction* configMenu(QWidget *parent = nullptr);
0039 }
0040 
0041 #endif // CODENAVIGATOR_H