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
124
125
126
127
128
129
130
|
/* $Id: UIRichTextString.h $ */
/** @file
* VBox Qt GUI - UIRichTextString class declaration.
*/
/*
* Copyright (C) 2015-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.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, in version 3 of the
* License.
*
* 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, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef FEQT_INCLUDED_SRC_objects_UIRichTextString_h
#define FEQT_INCLUDED_SRC_objects_UIRichTextString_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/* Qt includes: */
#include <QTextLayout>
/* GUI includes: */
#include "UILibraryDefs.h"
/** Rich text string implementation which parses the passed QString
* and holds it as the tree of the formatted rich text blocks. */
class SHARED_LIBRARY_STUFF UIRichTextString
{
public:
/** Rich text block types. */
enum Type
{
Type_None,
Type_Anchor,
Type_Bold,
Type_Italic,
};
/** Constructs empty rich text string.
* @param enmType Brings the type of <i>this</i> rich text block. */
UIRichTextString(Type enmType = Type_None);
/** Constructs rich text string.
* @param strString Brings the string being parsed and held as the tree of rich text blocks.
* @param enmType Brings the type of <i>this</i> rich text block.
* @param strStringMeta Brings the string containing meta data describing <i>this</i> rich text block. */
UIRichTextString(const QString &strString, Type enmType = Type_None, const QString &strStringMeta = QString());
/** Destructor rich text string. */
virtual ~UIRichTextString();
/** Returns the QString representation. */
QString toString() const;
/** Returns the list of existing format ranges appropriate for QTextLayout.
* @param iShift Brings the shift of <i>this</i> rich text block accordig to it's root. */
QVector<QTextLayout::FormatRange> formatRanges(int iShift = 0) const;
/** Defines the anchor to highlight in <i>this</i> rich text block and in it's children. */
void setHoveredAnchor(const QString &strHoveredAnchor);
private:
/** Parses the string. */
void parse();
/** Used to populate const static map of known patterns.
* @note Keep it sync with the method below - #populatePatternHasMeta(). */
static QMap<Type, QString> populatePatterns();
/** Used to populate const static map of meta flags for the known patterns.
* @note Keep it sync with the method above - #populatePatterns(). */
static QMap<Type, bool> populatePatternHasMeta();
/** Recursively searching for the maximum level of the passed pattern.
* @param strString Brings the string to check for the current (recursively advanced) pattern in,
* @param strPattern Brings the etalon pattern to recursively advance the current pattern with,
* @param strCurrentPattern Brings the current (recursively advanced) pattern to check for the presence of,
* @param iCurrentLevel Brings the current level of the recursively advanced pattern. */
static int searchForMaxLevel(const QString &strString, const QString &strPattern,
const QString &strCurrentPattern, int iCurrentLevel = 0);
/** Recursively composing the pattern of the maximum level.
* @param strPattern Brings the etalon pattern to recursively update the current pattern with,
* @param strCurrentPattern Brings the current (recursively advanced) pattern,
* @param iCurrentLevel Brings the amount of the levels left to recursively advance current pattern. */
static QString composeFullPattern(const QString &strPattern,
const QString &strCurrentPattern, int iCurrentLevel);
/** Composes the QTextCharFormat correpoding to passed @a enmType. */
static QTextCharFormat textCharFormat(Type enmType);
/** Holds the type of <i>this</i> rich text block. */
Type m_enmType;
/** Holds the string of <i>this</i> rich text block. */
QString m_strString;
/** Holds the string meta data of <i>this</i> rich text block. */
QString m_strStringMeta;
/** Holds the children of <i>this</i> rich text block. */
QMap<int, UIRichTextString*> m_strings;
/** Holds the anchor of <i>this</i> rich text block. */
QString m_strAnchor;
/** Holds the anchor to highlight in <i>this</i> rich text block and in it's children. */
QString m_strHoveredAnchor;
/** Holds the <i>any</i> string pattern. */
static const QString s_strAny;
/** Holds the map of known patterns. */
static const QMap<Type, QString> s_patterns;
/** Holds the map of meta flags for the known patterns. */
static const QMap<Type, bool> s_doPatternHasMeta;
};
#endif /* !FEQT_INCLUDED_SRC_objects_UIRichTextString_h */
|
