Debian Codegraph @

qt6/src/poppler-optcontent-private.h

raw
1 /* poppler-optcontent-private.h: qt interface to poppler
2 *
3 * Copyright (C) 2007, Brad Hards <[email protected]>
4 * Copyright (C) 2008, Pino Toscano <[email protected]>
5 * Copyright (C) 2016, 2018, 2019, 2021, Albert Astals Cid <[email protected]>
6 * Copyright (C) 2017, Hubert Figuière <[email protected]>
7 * Copyright (C) 2025, g10 Code GmbH, Author: Sune Stolborg Vuorela <[email protected]>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2, or (at your option)
12 * any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
22 */
23
24 #ifndef POPPLER_OPTCONTENT_PRIVATE_H
25 #define POPPLER_OPTCONTENT_PRIVATE_H
26
27 #include <QtCore/QMap>
28 #include <QtCore/QSet>
29 #include <QtCore/QString>
30
31 class Array;
32 class OCGs;
33 class OptionalContentGroup;
34
35 class QModelIndex;
36
37 namespace Poppler {
38 class OptContentItem;
39 class OptContentModel;
40 class OptContentModelPrivate;
41
42 class RadioButtonGroup
43 {
44 public:
45 RadioButtonGroup(OptContentModelPrivate *ocModel, Array *rbarray);
46 ~RadioButtonGroup();
47 QSet<OptContentItem *> setItemOn(OptContentItem *itemToSetOn);
48
49 private:
50 QList<OptContentItem *> itemsInGroup;
51 };
52
53 class OptContentItem
54 {
55 public:
56 enum ItemState
57 {
58 On,
59 Off,
60 HeadingOnly
61 };
62
63 explicit OptContentItem(OptionalContentGroup *group);
64 explicit OptContentItem(const QString &label);
65 OptContentItem();
66 ~OptContentItem();
67
68 QString name() const { return m_name; }
69 ItemState state() const { return m_stateBackup; }
70 void setState(ItemState state, bool obeyRadioGroups, QSet<OptContentItem *> &changedItems);
71
72 QList<OptContentItem *> childList() { return m_children; }
73
74 void setParent(OptContentItem *parent) { m_parent = parent; }
75 OptContentItem *parent() { return m_parent; }
76
77 void addChild(OptContentItem *child);
78
79 void appendRBGroup(RadioButtonGroup *rbgroup);
80
81 bool isEnabled() const { return m_enabled; }
82
83 QSet<OptContentItem *> recurseListChildren(bool includeMe = false) const;
84
85 OptionalContentGroup *group() const { return m_group; }
86
87 private:
88 OptionalContentGroup *m_group;
89 QString m_name;
90 ItemState m_state; // true for ON, false for OFF
91 ItemState m_stateBackup;
92 QList<OptContentItem *> m_children;
93 OptContentItem *m_parent;
94 QList<RadioButtonGroup *> m_rbGroups;
95 bool m_enabled;
96 };
97
98 class OptContentModelPrivate
99 {
100 public:
101 OptContentModelPrivate(OptContentModel *qq, const OCGs *optContent);
102 ~OptContentModelPrivate();
103
104 OptContentModelPrivate(const OptContentModelPrivate &) = delete;
105 OptContentModelPrivate &operator=(const OptContentModelPrivate &) = delete;
106
107 void parseRBGroupsArray(const Array *rBGroupArray);
108 OptContentItem *nodeFromIndex(const QModelIndex &index, bool canBeNull = false) const;
109 QModelIndex indexFromItem(OptContentItem *node, int column) const;
110
111 /**
112 Get the OptContentItem corresponding to a given reference value.
113
114 \param ref the reference number (e.g. from Object.getRefNum()) to look up
115
116 \return the matching optional content item, or null if the reference wasn't found
117 */
118 OptContentItem *itemFromRef(const QString &ref) const;
119 void setRootNode(OptContentItem *node);
120
121 OptContentModel *q;
122
123 QMap<QString, OptContentItem *> m_optContentItems;
124 QList<OptContentItem *> m_headerOptContentItems;
125 QList<RadioButtonGroup *> m_rbgroups;
126 OptContentItem *m_rootNode;
127
128 private:
129 void addChild(OptContentItem *parent, OptContentItem *child);
130 void parseOrderArray(OptContentItem *parentNode, const Array *orderArray);
131 };
132 }
133
134 #endif