File: PluginsHelp.h

package info (click to toggle)
tulip 3.7.0dfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 39,428 kB
  • sloc: cpp: 231,403; php: 11,023; python: 1,128; sh: 671; yacc: 522; makefile: 315; xml: 63; lex: 55
file content (48 lines) | stat: -rwxr-xr-x 1,528 bytes parent folder | download
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
/**
 *
 * This file is part of Tulip (www.tulip-software.org)
 *
 * Authors: David Auber and the Tulip development Team
 * from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
 *
 * Tulip is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tulip 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.
 *
 */

#ifndef _Tulip_PLUGINSHELP_H_
#define _Tulip_PLUGINSHELP_H_

#include <QtCore/QString>

#include <tulip/tulipconf.h>

namespace tlp {

class PluginsHelp {

public :

  static QString minimumHtmlFile(const QString &title);
  static void appendFiles(const QString &baseDirectory,const QString &pluginType,const QStringList &filesList,QByteArray &outArray);
  static QString getPluginType(const QByteArray &inArray);
  static bool partFiles(const QByteArray &inArray,const QString &baseDirectory);
  static void addInFile(const QString &fileName,const QString &textToAdd, const QString &textAfter);
  static void removeInFile(const QString &fileName,const QString &textToRemove);
  static void checkViewHelp();

  static void installHelpDoc(const QString &fileName);
  static void removeHelpDoc(const QString &fileName);

};

}

#endif