File: dockindockmanager.py

package info (click to toggle)
qt-advanced-docking-system 3.8.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 13,600 kB
  • sloc: cpp: 11,678; python: 2,623; makefile: 12
file content (214 lines) | stat: -rw-r--r-- 8,282 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
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
from PyQt5.QtWidgets import QAction, QMenu, QInputDialog, QLineEdit
from PyQt5.QtCore import QSettings

from PyQtAds import QtAds

CHILD_PREFIX = "Child-"

class DockInDockManager(QtAds.CDockManager):
    def __init__(self, parent: 'DockInDockWidget'):
        super().__init__()
        self.__parent = parent

    def parent(self) -> 'DockInDockWidget':
        return self.__parent
    
    def fillViewMenu(self, menu: QMenu, move_to: 'dict[DockInDockManager]') -> None:
        from dockindock import DockInDockWidget # Prevent cyclic import
        
        widgets_map = self.dockWidgetsMap()
        for key, value in widgets_map.items():
            widget = value.widget()
            action = value.toggleViewAction()
            
            if isinstance(widget, DockInDockWidget):
                sub_menu = menu.addMenu(key)
                
                sub_menu.addAction(action)
                sub_menu.addSeparator()
                
                widget.setupMenu(sub_menu, move_to)
            else:
                menu.addAction(action)
                
        if self.parent().canCreateNewGroups():
            # see how this works, to create it in the right place, 
            # and also to have load perspective work when some groups are missing
            menu.addSeparator()
            menu.addAction(CreateChildDockAction(self.__parent, menu))

            if self.parent().getTopLevelDockWidget().getManager() != self:
                menu.addAction(DestroyGroupAction( self.parent, menu))
                
    def fillMoveMenu(self, menu: QMenu, move_to: 'list[DockInDockManager]') -> None:
        widgets_map = self.dockWidgetsMap()
        for key, value in widgets_map.items():
            sub_menu = menu.addMenu(key)
            
            for mgr in move_to:
                # iterate over all possible target managers
                if mgr == self:
                    pass # if dock is already in mgr, no reason to move it there
                elif mgr == DockInDockManager.dockInAManager(value):
                    pass # if target is the group itself, can't move it there, would make no sense
                else:
                    sub_menu.addAction(MoveDockWidgetAction(value, mgr, sub_menu))
    
    def addPerspectiveRec(self, name: str) -> None:
        managers = self.allManagers(True, True)
        
        for child in managers:
            child.addPerspective(name)
            
    def openPerspectiveRec(self, name: str) -> None:
        managers = self.allManagers(True, True)
        
        for child in managers:
            child.openPerspective(name)
            
    def getGroupName(self) -> str:
        return self.parent().objectName()
        
    def getPersistGroupName(self) -> str:
        group = "Top"
        if self.getGroupName():
            group = CHILD_PREFIX + self.getGroupName()
        return group
        
    def getGroupNameFromPersistGroupName(self, persist_group_name) -> str:
        if persist_group_name.startswith(CHILD_PREFIX):
            persist_group_name = persist_group_name[len(CHILD_PREFIX):]
        else:
            assert False
        return persist_group_name
        
    def loadPerspectivesRec(self, settings: QSettings) -> None:
        children = self.allManagers(True, True)
        
        for mgr in children:
            settings.beginGroup(mgr.getPersistGroupName())
            mgr.loadPerspectives(settings)
            settings.endGroup()
            
    def savePerspectivesRec(self, settings: QSettings) -> None:
        children = self.allManagers(True, True)
        
        for mgr in children:
            settings.beginGroup(mgr.getPersistGroupName())
            mgr.savePerspectives(settings)
            settings.endGroup()
            
    def removePerspectivesRec(self, settings: QSettings) -> None:
        children = self.allManagers(True, True)
        
        for mgr in children:
            child.removePerspectives(child.perspectiveNames())
            
    @staticmethod
    def dockInAManager(widget) -> 'DockInDockManager':
        from dockindock import DockInDockWidget # Prevent cyclic import
        
        dock_widget =  widget.widget() if widget else None
        return dock_widget.getManager() if isinstance(dock_widget, DockInDockWidget) else None
        
    def childManagers(self, managers: 'list[DockInDockManager]', rec: bool) -> None:
        widgets = self.getWidgetsInGUIOrder()
        for widget in widgets:
            as_mgr = DockInDockManager.dockInAManager(widget)
            if as_mgr:
                managers.append(as_mgr)
                if rec:
                    as_mgr.childManagers(managers, rec)
                    
    def allManagers(self, include_self: bool, rec: bool) -> 'list[DockInDockManager]':
        managers = []
        if include_self:
            managers.append(self)
        self.childManagers(managers, rec)
        return managers
        
    def allDockWidgets(self, include_self: bool, rec: bool) -> 'list[tuple[DockInDockManager, QtAds.CDockWidget]]':
        widgets = []
        for mgr in self.allManagers(include_self, rec):
            for widget in mgr.getWidgetsInGUIOrder():
                widgets.append((mgr, widget))
        return widgets
        
    def getGroupContents(self) -> 'dict[str, list[str]]':
        result = {}
        managers = self.allManagers(True, True)
        for mgr in managers:
            result[mgr.getPersistGroupName()] = mgr.dockWidgetsMap().keys()
        return result
        
    def getInsertDefaultPos(self) -> QtAds.CDockAreaWidget:
        default_pos = None
        if self.dockAreaCount() != 0:
            default_pos = self.dockArea(self.dockAreaCount()-1)
        return default_pos
        
    def getWidgetsInGUIOrder(self) -> 'list[QtAds.CDockWidget]':
        result = []
        for i in range(self.dockAreaCount()):
            for widget in self.dockArea(i).dockWidgets():
                result.append(widget)
        return result
        
    
class CreateChildDockAction(QAction):
    def __init__(self, dock_in_dock: 'DockInDockWidget', menu: QMenu):
        super().__init__("New group...", menu)
        self.__dock_in_dock = dock_in_dock
        self.triggered.connect(self.createGroup)
        
    def createGroup(self) -> None:
        name = ""
        while True:
            name, ok = QInputDialog.getText(None, self.text(), "Enter group name", QLineEdit.Normal, name)
            if ok:
                error = ""
                if self.__dock_in_dock.getTopLevelDockWidget():
                    error = self.__dock_in_dock.getTopLevelDockWidget().getGroupNameError(name)
                else:
                    assert False
                    
                if not error:
                    self.__dock_in_dock.createGroup(name, None)
                    break
                else:
                    QMessageBox.critical(None, "Error", error)
                    continue
            else:
                break
        
class DestroyGroupAction(QAction):
    def __init__(self, widget: 'DockInDockWidget', menu: QMenu):
        super().__init__("Destroy" + widget.getManager().getGroupName(), menu)
        self.__widget = widget
        self.triggered.connect(self.destroyGroup)
        
    def destroyGroup(self) -> None:
        self.__widget.getTopLevelDockWidget().destroyGroup(self.__widget)
        
        
class MoveDockWidgetAction(QAction):
    def __init__(self, widget: 'DockInDockWidget', move_to: DockInDockManager, menu: QMenu):
        super().__init__(menu)
        self.__widget = widget
        self.__move_to = move_to
        
        if move_to.parent().isTopLevel():
            self.setText("To top")
        else:
            self.setText(f"To {move_to.parent().objectName()}")
        self.triggered.connect(self._move)
        
    def _move(self) -> None:
        self.move(self.__widget, self.__move_to)
        
    def move(self, widget: QtAds.CDockWidget, move_to: QtAds.CDockManager) -> None:
        if widget and move_to:
            widget.dockManager().removeDockWidget(widget)
            move_to.addDockWidget(QtAds.CenterDockWidgetArea, widget, move_to.getInsertDefaultPos())
        else:
            assert False