1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/* ****************************************************************************
This file is part of KBabel
Copyright (C) 2002-2005 Stanislav Visnovsky
<visnovsky@kde.org>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
In addition, as a special exception, the copyright holders give
permission to link the code of this program with any edition of
the Qt library by Trolltech AS, Norway (or with modified versions
of Qt that use the same license as Qt), and distribute linked
combinations including the two. You must obey the GNU General
Public License in all respects for all of the code used other than
Qt. If you modify this file, you may extend this exception to
your version of the file, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from
your version.
**************************************************************************** */
#ifndef CONTEXT_H
#define CONTEXT_H
#include <qvaluelist.h>
#include <qwidget.h>
#include <ktexteditor/document.h>
#include <ktexteditor/view.h>
#include <kbproject.h>
class QComboBox;
class QVBoxLayout;
class QLineEdit;
class KListEditor;
class KConfig;
class KURL;
struct ContextInfo
{
QString path;
uint line;
};
/**
* @short Class for displaying source code context
*
* Widget for displaying source code context of for the given GNU gettext comment.
* The searched paths can be configured using variables.
*
* The possible variables are:
* - \@POFILEDIR\@ absolute directory of the PO file (to create paths relatives to the PO file)
* - \@PACKAGE\@ name of the PO file
* - \@PACKAGEDIR\@ relative directory of the PO file (relative to \@CODEROOT\@)
* - \@CODEROOT\@ base directory (especially of the catalog manager)
* - \@COMMENTPATH\@ (relative) path given as source code reference in a comment of the PO file
*
* @note The difference between \@POFILEDIR\@ and a path constructed by
* \@CODEROOT\@\@PACKAGEDIR\@/ is that \@POFILEDIR\@ will also work if the file is external
* to the catalog manager's root
*
* @note It requires a KPart implementing KTextEditor interface with selections.
* @author Stanislav Visnovsky <visnovsky@kde.org>
*/
class KDE_EXPORT SourceContext : public QWidget
{
Q_OBJECT
public:
SourceContext(QWidget* parent, KBabel::Project::Ptr project);
void setProject(KBabel::Project::Ptr project);
public slots:
/**
* Try to find the corresponding file and load it to this widget.
* @param packageDir path of the package, where to find the source file
* @param packageName name of the package, where to find the source file
* @param gettextComment comment string with context as generated by xgettext (can start with #:)
* @param urlPoFile URL of the PO file
* @todo even if @p urlPoFile is an URL SourceContext::resolvePath is not remote-aware yet
*/
void setContext( const QString& packageDir, const QString& packageName, const QString& gettextComment, const KURL& urlPoFile );
private:
/**
* Get a list of paths from the source references in the comment @p gettextComment
* @param packageDir path of the package, where to find the source file
* @param packageName name of the package, where to find the source file
* @param gettextComment comment string with context as generated by xgettext (can start with #:)
* @param urlPoFile URL of the PO file
* @todo even if @p urlPoFile is an URL SourceContext::resolvePath is not remote-aware yet
* @private
*/
QValueList<ContextInfo> resolvePath( const QString& packageDir, const QString& packageName, const QString& gettextComment, const KURL& urlPoFile );
bool loadPart();
/// Parent widget (for KIO::NetAccess member functions)
QWidget* m_parent;
KTextEditor::Document* _part;
KTextEditor::View* _view;
QComboBox *_referenceCombo;
QVBoxLayout *_layout;
QValueList<ContextInfo> _referenceList;
KBabel::Project::Ptr _project;
private slots:
void updateToSelected(int index);
};
#endif // CONTEXT_H
|
