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
|
/***************************************************************************
ctoolclass.h - some methods,that would be normal global, but
I hate global function :-)
-------------------
begin : 20 Jan 1999
copyright : (C) 1999 by Joachim Ansorg
email : Jockel123@gmx.de
***************************************************************************/
/***************************************************************************
* *
* 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. *
* *
***************************************************************************/
//BibleTime includes
//Qt includes
#include <qstring.h>
#include <qpixmap.h>
#include <qtextstream.h>
#ifndef CTOOLCLASS_H
#define CTOOLCLASS_H
class CSwordModuleInfo;
class QLabel;
/**
* Provides some useful functions which would be normally global.
*
* Some methods,that would be normaly global, but I hate global functions :-)
* (the function locateHTML is from Sandy Meier (KDevelop))
*
* @short A class which contains static members to do small things.
* @author Joachim Ansorg <jansorg@gmx.de>
*/
class CToolClass {
public:
/**
* @return The path of the HTML file "filename". This function searches only in $KDEDIR.
* @author Sandy Meier of the KDevelop team.
*/
static QString locatehtml(const QString &filename);
/**
* Converts HTML text to plain text.
* This function converts some HTML tags in text (e.g. <BR> to \n)
* @return The text withput HTML tags and with converted <BR> to \n
* @author Joachim Ansorg
*/
static QString htmlToText(const QString&);
/**
* Converts text to HTML converting some text commands into HTML tags (e.g. \n to <BR>)
* @return The HTML formatted text we got after changing \n to <BR>
* @author Joachim Ansorg
*/
static QString textToHTML(const QString&);
/**
* Creates the file filename and put the text of parameter "text" into the file.
* @return True if saving was sucessful, otherwise false
* @author Joachim Ansorg
*/
static bool savePlainFile( const QString& filename, const QString& text, const bool& forceOverwrite = false, const QTextStream::Encoding& fileEncoding = QTextStream::Locale);
/**
* Returns the icon used for the module given as aparameter.
*/
static QPixmap getIconForModule( CSwordModuleInfo* );
/** Returns a label to explain difficult things of dialogs.
* This function returns a label with heading "heading" and explanation "text". This label should be used to
* explain difficult things of the GUI, e.g. in the optionsdialog.
*/
static QLabel* explanationLabel(QWidget* parent, const QString& heading, const QString& text );
/**
* Returns true if the character at position "pos" of text is inside an HTML tag. Returns false if it's not inside an HTML tag.
*/
static bool inHTMLTag(int pos, QString & text);
};
#endif
|
