~ubuntu-branches/debian/sid/kdevelop/sid

« back to all changes in this revision

Viewing changes to languages/cpp/cppduchain/navigation/navigationwidget.h

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Lainé
  • Date: 2010-05-05 07:21:55 UTC
  • mfrom: (1.2.3 upstream) (5.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100505072155-h78lx19pu04sbhtn
Tags: 4:4.0.0-2
* Upload to unstable (Closes: #579947, #481832).
* Acknowledge obsolete NMU fixes (Closes: #562410, #546961).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
   Copyright 2007 David Nolden <david.nolden.kdevelop@art-master.de>
 
3
 
 
4
   This library is free software; you can redistribute it and/or
 
5
   modify it under the terms of the GNU Library General Public
 
6
   License version 2 as published by the Free Software Foundation.
 
7
 
 
8
   This library is distributed in the hope that it will be useful,
 
9
   but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
11
   Library General Public License for more details.
 
12
 
 
13
   You should have received a copy of the GNU Library General Public License
 
14
   along with this library; see the file COPYING.LIB.  If not, write to
 
15
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 
16
   Boston, MA 02110-1301, USA.
 
17
*/
 
18
 
 
19
#ifndef CPP_NAVIGATIONWIDGET_H
 
20
#define CPP_NAVIGATIONWIDGET_H
 
21
 
 
22
#include <language/duchain/navigation/abstractnavigationwidget.h>
 
23
#include <language/util/includeitem.h>
 
24
#include "../../parser/rpp/pp-macro.h"
 
25
#include "../cppduchainexport.h"
 
26
 
 
27
namespace Cpp {
 
28
 
 
29
class KDEVCPPDUCHAIN_EXPORT NavigationWidget : public KDevelop::AbstractNavigationWidget
 
30
{
 
31
  Q_OBJECT
 
32
public:
 
33
 
 
34
    /**
 
35
      * @param htmlPrefix and @param htmlSuffix can be used to add own text before/behind the
 
36
      * normal text in the navigation-widget.
 
37
      * The texts may contain links to files, using a simple special Syntax:
 
38
      * KDEV_FILE_LINK{File}. Every occurrence of KDEV_FILE_LINK will be replaced.
 
39
      * */
 
40
    NavigationWidget(KDevelop::DeclarationPointer declaration, KDevelop::TopDUContextPointer topContext, const QString& htmlPrefix = QString(), const QString& htmlSuffix = QString());
 
41
 
 
42
    /**
 
43
      * @param htmlPrefix and @param htmlSuffix can be used to add own text before/behind the
 
44
      * normal text in the navigation-widget.
 
45
      * The texts may contain links to files, see above.
 
46
      * */
 
47
    NavigationWidget(const KDevelop::IncludeItem& includeItem, KDevelop::TopDUContextPointer topContext, const QString& htmlPrefix = QString(), const QString& htmlSuffix = QString());
 
48
 
 
49
    /**
 
50
      * @param htmlPrefix and @param htmlSuffix can be used to add own text before/behind the
 
51
      * normal text in the navigation-widget.
 
52
      * The texts may contain links to files, see above.
 
53
      * */
 
54
    NavigationWidget(const rpp::pp_macro& macro, const QString& preprocessedBody = QString(), const QString& htmlPrefix = QString(), const QString& htmlSuffix = QString());
 
55
 
 
56
    /**
 
57
    * Creates a compact html description-text
 
58
    **/
 
59
    static QString shortDescription(KDevelop::Declaration* declaration);
 
60
    static QString shortDescription(const KDevelop::IncludeItem& includeItem);
 
61
 
 
62
protected:
 
63
    KDevelop::DeclarationPointer m_declaration;
 
64
};
 
65
 
 
66
}
 
67
 
 
68
#endif