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
|
/**
* Nested list helper
*
* SPDX-FileCopyrightText: 2008 Stephen Kelly <steveire@gmail.com>
*
* SPDX-License-Identifier: LGPL-2.1-or-later
*/
#pragma once
class QKeyEvent;
class QTextCursor;
class QTextBlock;
class QTextList;
/**
*
* @short Helper class for automatic handling of nested lists in a text edit
*
*
* @author Stephen Kelly
* @since 4.1
* @internal
*/
class NestedListHelper
{
public:
/**
* Create a helper
*
* @param te The text edit object to handle lists in.
*/
NestedListHelper();
/**
*
* Handles a key press before it is processed by the text edit widget.
*
* Currently this causes a backspace at the beginning of a line or with a
* multi-line selection to decrease the nesting level of the list.
*
* @param event The event to be handled
* @return Whether the event was completely handled by this method.
*/
[[nodiscard]] bool handleBeforeKeyPressEvent(QKeyEvent *event, const QTextCursor &cursor);
/**
*
* Handles a key press after it is processed by the text edit widget.
*
* Currently this causes a Return at the end of the last list item, or
* a Backspace after the last list item to recalculate the spacing
* between the list items.
*
* @param event The event to be handled
* @return Whether the event was completely handled by this method.
*/
bool handleAfterKeyPressEvent(int key, const QTextCursor &cursor);
/**
* Increases the indent (nesting level) on the current list item or selection.
*/
void handleOnIndentMore(const QTextCursor &textCursor);
/**
* Decreases the indent (nesting level) on the current list item or selection.
*/
void handleOnIndentLess(const QTextCursor &textCursor);
/**
* Changes the style of the current list or creates a new list with
* the specified style.
*
* @param styleIndex The QTextListStyle of the list.
*/
void handleOnBulletType(int styleIndex, const QTextCursor &textCursor);
/**
* @brief Check whether the current item in the list may be indented.
*
* An list item must have an item above it on the same or greater level
* if it can be indented.
*
* Also, a block which is currently part of a list can be indented.
*
* @sa canDedent
*
* @return Whether the item can be indented.
*/
[[nodiscard]] bool canIndent(const QTextCursor &textCursor) const;
/**
* \brief Check whether the current item in the list may be dedented.
*
* An item may be dedented if it is part of a list. Otherwise it can't be.
*
* @sa canIndent
*
* @return Whether the item can be dedented.
*/
[[nodiscard]] bool canDedent(const QTextCursor &textCursor) const;
private:
[[nodiscard]] QTextCursor topOfSelection(QTextCursor cursor);
[[nodiscard]] QTextCursor bottomOfSelection(QTextCursor cursor);
void processList(QTextList *list);
void reformatList(QTextBlock block);
int listBottomMargin;
int listTopMargin;
int listNoMargin;
};
//@endcond
|
