Skip to content

panel_controller

freecad.datamanager_wb.ui.panel_controller

UI-facing controller facade for the DataManager MainPanel.

This module provides a higher-level API used by the GUI layer. It delegates tab-generic logic to TabController instances and owns document recompute and GUI refresh behavior.

PanelController(*, ctx=None)

Facade used by MainPanel to access workbench behavior.

Responsibilities: - Provide a UI-oriented API for both tabs (VarSets and Aliases). - Delegate tab-generic operations to two TabController instances. - Own the document refresh boundary (doc.recompute() + Gui.updateGui()).

Source code in freecad/datamanager_wb/ui/panel_controller.py 
35
36
37
38
39
def __init__(self, *, ctx: FreeCadContext | None = None) -> None:
    self._ctx = ctx or get_runtime_context()
    self._port: FreeCadPort = get_port(self._ctx)
    self._varsets_tab_controller = TabController(VarsetDataSource(ctx=self._ctx))
    self._aliases_tab_controller = TabController(SpreadsheetDataSource(ctx=self._ctx))

can_remove_unused(*, only_unused, selected_items)

Return whether a selection is eligible for remove-unused (VarSets tab).

Source code in freecad/datamanager_wb/ui/panel_controller.py 
78
79
80
81
82
83
84
85
86
87
88
def can_remove_unused(
    self,
    *,
    only_unused: bool,
    selected_items: list[ParentChildRef] | list[str],
) -> bool:
    """Return whether a selection is eligible for remove-unused (VarSets tab)."""
    return self._varsets_tab_controller.can_remove_unused(
        only_unused=only_unused,
        selected_items=selected_items,
    )

get_active_document_name()

Return the active document name, if available.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
49
50
51
52
53
54
55
def get_active_document_name(self) -> str | None:
    """Return the active document name, if available."""
    doc = self._port.get_active_document()
    if doc is None:
        return None
    name = getattr(doc, "Name", None)
    return str(name) if name else None

get_alias_expression_items(selected_aliases)

Return expression items and counts for selected spreadsheet aliases.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
220
221
222
223
224
def get_alias_expression_items(
    self, selected_aliases: list[ParentChildRef] | list[str]
) -> tuple[list[ExpressionItem], dict[str, int]]:
    """Return expression items and counts for selected spreadsheet aliases."""
    return self._aliases_tab_controller.get_expression_items(selected_aliases)

get_alias_post_remove_unused_update(*, selected_spreadsheets, alias_filter_text, only_unused)

Compute the post-mutation UI update for the Aliases tab.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
226
227
228
229
230
231
232
233
234
235
236
237
238
def get_alias_post_remove_unused_update(
    self,
    *,
    selected_spreadsheets: list[str],
    alias_filter_text: str,
    only_unused: bool,
) -> PostRemoveUpdate:
    """Compute the post-mutation UI update for the Aliases tab."""
    return self._aliases_tab_controller.get_post_remove_unused_update(
        selected_parents=selected_spreadsheets,
        child_filter_text=alias_filter_text,
        only_unused=only_unused,
    )

get_expression_items(selected_vars)

Return expression items and counts for selected VarSet variables.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
162
163
164
165
166
def get_expression_items(
    self, selected_vars: list[ParentChildRef] | list[str]
) -> tuple[list[ExpressionItem], dict[str, int]]:
    """Return expression items and counts for selected VarSet variables."""
    return self._varsets_tab_controller.get_expression_items(selected_vars)

get_expression_reference_counts(selected_vars)

Return expression reference counts for selected VarSet variables.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
168
169
170
171
172
def get_expression_reference_counts(
    self, selected_vars: list[ParentChildRef] | list[str]
) -> dict[str, int]:
    """Return expression reference counts for selected VarSet variables."""
    return self._varsets_tab_controller.get_expression_reference_counts(selected_vars)

get_filtered_spreadsheet_alias_items(*, selected_spreadsheets, alias_filter_text, only_unused)

Return filtered spreadsheet alias refs for the UI.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
def get_filtered_spreadsheet_alias_items(
    self,
    *,
    selected_spreadsheets: list[str],
    alias_filter_text: str,
    only_unused: bool,
) -> list[ParentChildRef]:
    """Return filtered spreadsheet alias refs for the UI."""
    return self._aliases_tab_controller.get_filtered_child_items(
        selected_parents=selected_spreadsheets,
        child_filter_text=alias_filter_text,
        only_unused=only_unused,
    )

get_filtered_spreadsheets(*, filter_text, exclude_copy_on_change=False)

Return spreadsheet names filtered by the UI filter text.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
188
189
190
191
192
193
194
195
196
197
198
def get_filtered_spreadsheets(
    self,
    *,
    filter_text: str,
    exclude_copy_on_change: bool = False,
) -> list[str]:
    """Return spreadsheet names filtered by the UI filter text."""
    return self._aliases_tab_controller.get_filtered_parents(
        filter_text=filter_text,
        exclude_copy_on_change=exclude_copy_on_change,
    )

get_filtered_varset_variable_items(*, selected_varsets, variable_filter_text, only_unused)

Return filtered VarSet variable refs for the UI.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
def get_filtered_varset_variable_items(
    self,
    *,
    selected_varsets: list[str],
    variable_filter_text: str,
    only_unused: bool,
) -> list[ParentChildRef]:
    """Return filtered VarSet variable refs for the UI."""
    return self._varsets_tab_controller.get_filtered_child_items(
        selected_parents=selected_varsets,
        child_filter_text=variable_filter_text,
        only_unused=only_unused,
    )

get_filtered_varsets(*, filter_text, exclude_copy_on_change=False)

Return VarSet names filtered by the UI filter text.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
def get_filtered_varsets(
    self,
    *,
    filter_text: str,
    exclude_copy_on_change: bool = False,
) -> list[str]:
    """Return VarSet names filtered by the UI filter text."""
    return self._varsets_tab_controller.get_filtered_parents(
        filter_text=filter_text,
        exclude_copy_on_change=exclude_copy_on_change,
    )

get_object_label(object_name)

Return the label for a named document object, if available.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
def get_object_label(self, object_name: str) -> str | None:
    """Return the label for a named document object, if available."""
    doc = self._port.get_active_document()
    if doc is None:
        return None

    try:
        obj = self._port.get_object(doc, object_name)
        label = obj.Label  # type: ignore[union-attr]
        text = str(label)
    except Exception:  # pylint: disable=broad-exception-caught
        return None
    return text if text else None

get_post_remove_unused_update(*, selected_varsets, variable_filter_text, only_unused)

Compute the post-mutation UI update for the VarSets tab.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
def get_post_remove_unused_update(
    self,
    *,
    selected_varsets: list[str],
    variable_filter_text: str,
    only_unused: bool,
) -> PostRemoveUpdate:
    """Compute the post-mutation UI update for the VarSets tab."""
    return self._varsets_tab_controller.get_post_remove_unused_update(
        selected_parents=selected_varsets,
        child_filter_text=variable_filter_text,
        only_unused=only_unused,
    )

get_sorted_spreadsheets(*, exclude_copy_on_change=False)

Return sorted spreadsheet names.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
182
183
184
185
186
def get_sorted_spreadsheets(self, *, exclude_copy_on_change: bool = False) -> list[str]:
    """Return sorted spreadsheet names."""
    return self._aliases_tab_controller._data_source.get_sorted_parents(  # pylint: disable=protected-access
        exclude_copy_on_change=exclude_copy_on_change
    )

get_sorted_varsets(*, exclude_copy_on_change=False)

Return sorted VarSet names.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
90
91
92
93
94
def get_sorted_varsets(self, *, exclude_copy_on_change: bool = False) -> list[str]:
    """Return sorted VarSet names."""
    return self._varsets_tab_controller._data_source.get_sorted_parents(  # pylint: disable=protected-access
        exclude_copy_on_change=exclude_copy_on_change
    )

get_spreadsheet_alias_refs(selected_spreadsheets)

Return structured alias refs for the selected spreadsheets.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
200
201
202
203
204
def get_spreadsheet_alias_refs(self, selected_spreadsheets: list[str]) -> list[ParentChildRef]:
    """Return structured alias refs for the selected spreadsheets."""
    return self._aliases_tab_controller._data_source.get_child_refs(  # pylint: disable=protected-access
        selected_spreadsheets
    )

get_varset_variable_items(selected_varsets)

Return VarSet.Variable strings for the selected VarSets.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
108
109
110
def get_varset_variable_items(self, selected_varsets: list[str]) -> list[str]:
    """Return `VarSet.Variable` strings for the selected VarSets."""
    return [ref.text for ref in self.get_varset_variable_refs(selected_varsets)]

get_varset_variable_refs(selected_varsets)

Return structured variable refs for the selected VarSets.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
112
113
114
def get_varset_variable_refs(self, selected_varsets: list[str]) -> list[ParentChildRef]:
    """Return structured variable refs for the selected VarSets."""
    return self._varsets_tab_controller._data_source.get_child_refs(selected_varsets)  # pylint: disable=protected-access

refresh_document()

Recompute the active document and refresh the FreeCAD GUI.

Any exceptions are swallowed to keep the UI responsive.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
41
42
43
44
45
46
47
def refresh_document(self) -> None:
    """Recompute the active document and refresh the FreeCAD GUI.

    Any exceptions are swallowed to keep the UI responsive.
    """
    self._port.try_recompute_active_document()
    self._port.try_update_gui()

remove_unused_aliases_and_get_update(*, selected_alias_items, selected_spreadsheets, alias_filter_text, only_unused)

Remove unused aliases and return updated UI state (Aliases tab).

Source code in freecad/datamanager_wb/ui/panel_controller.py 
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
def remove_unused_aliases_and_get_update(
    self,
    *,
    selected_alias_items: list[ParentChildRef] | list[str],
    selected_spreadsheets: list[str],
    alias_filter_text: str,
    only_unused: bool,
) -> RemoveUnusedAndUpdateResult:
    """Remove unused aliases and return updated UI state (Aliases tab)."""
    combined = self._aliases_tab_controller.remove_unused_and_get_update(
        selected_child_items=selected_alias_items,
        selected_parents=selected_spreadsheets,
        child_filter_text=alias_filter_text,
        only_unused=only_unused,
    )
    self.refresh_document()
    return combined

remove_unused_and_get_update(*, selected_varset_variable_items, selected_varsets, variable_filter_text, only_unused)

Remove unused variables and return updated UI state (VarSets tab).

Source code in freecad/datamanager_wb/ui/panel_controller.py 
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
def remove_unused_and_get_update(
    self,
    *,
    selected_varset_variable_items: list[ParentChildRef] | list[str],
    selected_varsets: list[str],
    variable_filter_text: str,
    only_unused: bool,
) -> RemoveUnusedAndUpdateResult:
    """Remove unused variables and return updated UI state (VarSets tab)."""
    combined = self._varsets_tab_controller.remove_unused_and_get_update(
        selected_child_items=selected_varset_variable_items,
        selected_parents=selected_varsets,
        child_filter_text=variable_filter_text,
        only_unused=only_unused,
    )
    self.refresh_document()
    return combined

remove_unused_varset_variables(selected_varset_variable_items)

Remove unused variables (VarSets tab) and refresh the document.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
174
175
176
177
178
179
180
def remove_unused_varset_variables(
    self, selected_varset_variable_items: list[ParentChildRef] | list[str]
) -> RemoveUnusedResult:
    """Remove unused variables (VarSets tab) and refresh the document."""
    result = self._varsets_tab_controller.remove_unused_children(selected_varset_variable_items)
    self.refresh_document()
    return result

select_expression_item(expression_item)

Select the FreeCAD object referenced by an expression list entry.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
258
259
260
def select_expression_item(self, expression_item: ExpressionItem | str) -> None:
    """Select the FreeCAD object referenced by an expression list entry."""
    select_object_from_expression_item(expression_item, ctx=self._ctx)

should_enable_remove_unused(*, only_unused, selected_count)

Delegate the enable/disable rule for remove-unused in the VarSets tab.

Source code in freecad/datamanager_wb/ui/panel_controller.py 
71
72
73
74
75
76
def should_enable_remove_unused(self, *, only_unused: bool, selected_count: int) -> bool:
    """Delegate the enable/disable rule for remove-unused in the VarSets tab."""
    return self._varsets_tab_controller.should_enable_remove_unused(
        only_unused=only_unused,
        selected_count=selected_count,
    )