Splitter Widgets¶
Detachable widget functionality and enhanced splitter behavior for QSplitter layouts.
Quick Start¶
from src.custom_widgets.widget_handlers.splitter_widgets.api import (
SplitterDetachableManager,
DetachableWidget,
DelayedCursorSplitter,
)
# Create manager
manager = SplitterDetachableManager()
# Add delayed cursor behavior to splitter (avoids accidental resizing)
manager.add_delayed_cursor(splitter, delay_ms=400)
# Create a detachable widget panel
detachable = manager.create_detachable_widget(
content_widget,
title="Properties",
)
# Add to splitter
splitter.addWidget(detachable)
# Cleanup when done
manager.cleanup()
Components¶
SplitterDetachableManager¶
Central manager for detachable widgets and delayed cursors.
DetachableWidget¶
Widget wrapper that can be detached into a floating dialog.
DetachableTitleBar¶
Custom title bar with detach/attach buttons.
DelayedCursorSplitter¶
Splitter handle that only shows resize cursor after hover delay.
Files¶
| File | Purpose |
|---|---|
api.py |
Public API exports |
manager.py |
SplitterDetachableManager implementation |
detachable_widgets.py |
DetachableWidget, DetachableDialog, DetachableTitleBar |
delayed_cursor.py |
DelayedCursorSplitter implementation |
What Belongs Here¶
Put here: - Splitter-related widgets and utilities - Detachable panel functionality - Splitter behavior enhancements
Do NOT put here:
- General widget utilities (use parent widget_handlers/)
- Non-splitter widgets
API Reference¶
src.custom_widgets.widget_handlers.splitter_widgets.api
¶
Public API for splitter widgets module.
Provides detachable widget functionality and delayed cursor behavior for QSplitter-based layouts.
Example
Basic usage::
from src.custom_widgets.widget_handlers.splitter_widgets.api import (
SplitterDetachableManager,
DetachableWidget,
DelayedCursorSplitter,
)
# Create manager
manager = SplitterDetachableManager()
# Add delayed cursor to splitter
manager.add_delayed_cursor(splitter, delay_ms=400)
# Create detachable widget
detachable = manager.create_detachable_widget(
content_widget,
title="Properties",
)
# Cleanup when done
manager.cleanup()
DelayedCursorSplitter
¶
Bases: QObject
Standalone class for delayed cursor change on QSplitter handles.
Installs event filters on splitter handles to delay the resize cursor appearance. This prevents accidental resizing when users are just moving their mouse across the interface.
The cursor only changes to the resize cursor after the mouse has hovered over the handle for the specified delay period.
Attributes:
| Name | Type | Description |
|---|---|---|
splitter |
The QSplitter being managed. |
|
delay_ms |
Delay in milliseconds before cursor change. |
Example
Using with a splitter::
splitter = QSplitter(Qt.Vertical)
delayed = DelayedCursorSplitter(splitter, delay_ms=400)
# Later, when cleaning up
delayed.cleanup()
Source code in src\custom_widgets\widget_handlers\splitter_widgets\delayed_cursor.py
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 | |
__init__(splitter, delay_ms=300, parent=None)
¶
Initialize delayed cursor handling for a splitter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
splitter
|
QSplitter
|
The QSplitter to manage. |
required |
delay_ms
|
int
|
Delay in milliseconds before showing resize cursor. |
300
|
parent
|
Optional[QObject]
|
Parent QObject for ownership. |
None
|
Source code in src\custom_widgets\widget_handlers\splitter_widgets\delayed_cursor.py
cleanup()
¶
Clean up - remove event filters and restore cursor.
Source code in src\custom_widgets\widget_handlers\splitter_widgets\delayed_cursor.py
eventFilter(obj, event)
¶
Event filter for splitter and handle events.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
obj
|
QObject
|
Object that received the event. |
required |
event
|
QEvent
|
The event. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if event was consumed, False otherwise. |
Source code in src\custom_widgets\widget_handlers\splitter_widgets\delayed_cursor.py
set_delay(delay_ms)
¶
Change the cursor delay.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
delay_ms
|
int
|
New delay in milliseconds. |
required |
update_handles()
¶
Update event filters for all splitter handles.
Source code in src\custom_widgets\widget_handlers\splitter_widgets\delayed_cursor.py
DetachableDialog
¶
Bases: QDialog
Dialog container for detached widgets.
When a DetachableWidget is detached from its splitter, the content is moved into this dialog. Closing the dialog triggers reattachment.
Signals
reattach_requested: Emitted when user closes the dialog. parent_destroyed: Emitted when parent splitter is destroyed.
Example
Internal use by DetachableWidget::
dialog = DetachableDialog("My Widget", parent_window)
dialog.set_content_widget(content)
dialog.show()
Source code in src\custom_widgets\widget_handlers\splitter_widgets\detachable_widgets.py
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 215 216 217 | |
__init__(title, parent=None, dialog_stylesheets=None, dialog_module_folder=None)
¶
Initialize the detachable dialog.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
title
|
str
|
Dialog window title. |
required |
parent
|
Optional[QWidget]
|
Parent widget. |
None
|
dialog_stylesheets
|
Optional[List[str]]
|
Optional list of QSS filenames to apply. |
None
|
dialog_module_folder
|
Optional[str]
|
Module folder for stylesheet lookup. |
None
|
Source code in src\custom_widgets\widget_handlers\splitter_widgets\detachable_widgets.py
closeEvent(event)
¶
ensure_dialog_on_screen()
¶
Ensure the dialog is visible on screen.
Source code in src\custom_widgets\widget_handlers\splitter_widgets\detachable_widgets.py
on_parent_splitter_destroyed()
¶
Handle parent splitter destruction gracefully.
set_content_widget(widget)
¶
Set the content widget for the dialog.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
widget
|
QWidget
|
Widget to display in the dialog. |
required |
showEvent(event)
¶
Handle show event to ensure proper positioning.
DetachableTitleBar
¶
Bases: QWidget
Title bar for detachable widgets.
Displays the widget title and a detach button that allows users to detach the widget into a floating dialog.
Signals
detach_requested: Emitted when user clicks the detach button.
Example
Internal use by DetachableWidget::
title_bar = DetachableTitleBar("My Widget")
title_bar.detach_requested.connect(self.detach)
Source code in src\custom_widgets\widget_handlers\splitter_widgets\detachable_widgets.py
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 | |
__init__(title, parent=None)
¶
Initialize the title bar.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
title
|
str
|
Title text to display. |
required |
parent
|
Optional[QWidget]
|
Parent widget. |
None
|
Source code in src\custom_widgets\widget_handlers\splitter_widgets\detachable_widgets.py
DetachableWidget
¶
Bases: QFrame
Widget container that can be detached from a splitter.
Wraps a content widget with a title bar containing a detach button. When detached, the content moves to a floating dialog. Closing the dialog reattaches the widget to its original position.
Attributes:
| Name | Type | Description |
|---|---|---|
content_widget |
The wrapped content widget. |
|
title |
Widget title displayed in title bar. |
|
dialog |
Optional[DetachableDialog]
|
The detached dialog (None when attached). |
Example
Creating a detachable widget::
editor = QTextEdit()
detachable = DetachableWidget(
editor,
title="Text Editor",
dialog_stylesheets=["editor.qss"],
dialog_module_folder="MyModule/Editors",
)
splitter.addWidget(detachable)
Source code in src\custom_widgets\widget_handlers\splitter_widgets\detachable_widgets.py
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 | |
__init__(content_widget, title='', dialog_stylesheets=None, dialog_module_folder=None, parent=None)
¶
Initialize the detachable widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
content_widget
|
QWidget
|
Widget to wrap. |
required |
title
|
str
|
Title for the title bar and detached dialog. |
''
|
dialog_stylesheets
|
Optional[List[str]]
|
QSS files to apply to detached dialog. |
None
|
dialog_module_folder
|
Optional[str]
|
Module folder for stylesheet lookup. |
None
|
parent
|
Optional[QWidget]
|
Parent widget. |
None
|
Source code in src\custom_widgets\widget_handlers\splitter_widgets\detachable_widgets.py
detach()
¶
Detach the widget and display as a floating dialog.
Source code in src\custom_widgets\widget_handlers\splitter_widgets\detachable_widgets.py
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 | |
reattach()
¶
Reattach the widget to its original splitter position.
Source code in src\custom_widgets\widget_handlers\splitter_widgets\detachable_widgets.py
SplitterDetachableManager
¶
Bases: QObject
Manager for splitters with detachable widgets.
Provides centralized management of: - Delayed cursor functionality for splitter handles - Creation and tracking of detachable widgets
The manager maintains references to all configured splitters and detachable widgets, allowing for centralized cleanup.
Attributes:
| Name | Type | Description |
|---|---|---|
delayed_cursors |
Dict[QSplitter, DelayedCursorSplitter]
|
Map of splitters to their DelayedCursorSplitter. |
detachable_widgets |
List[DetachableWidget]
|
List of created DetachableWidget instances. |
default_cursor_delay |
int
|
Default delay for cursor changes (ms). |
Example
Managing multiple splitters::
manager = SplitterDetachableManager()
# Configure splitters
manager.add_delayed_cursor(horizontal_splitter)
manager.add_delayed_cursor(vertical_splitter, delay_ms=500)
# Create detachable widgets
props = manager.create_detachable_widget(props_widget, "Properties")
log = manager.create_detachable_widget(log_widget, "Log Viewer")
horizontal_splitter.addWidget(props)
vertical_splitter.addWidget(log)
# When view is closed
manager.cleanup()
Source code in src\custom_widgets\widget_handlers\splitter_widgets\manager.py
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 | |
__init__(parent=None)
¶
Initialize the splitter manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
parent
|
Optional[QObject]
|
Parent QObject for ownership. |
None
|
Source code in src\custom_widgets\widget_handlers\splitter_widgets\manager.py
add_delayed_cursor(splitter, delay_ms=None)
¶
Add delayed cursor functionality to a splitter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
splitter
|
QSplitter
|
QSplitter to configure. |
required |
delay_ms
|
Optional[int]
|
Delay in milliseconds before cursor change. Uses default_cursor_delay if not specified. |
None
|
Returns:
| Type | Description |
|---|---|
DelayedCursorSplitter
|
The DelayedCursorSplitter instance managing this splitter. |
Source code in src\custom_widgets\widget_handlers\splitter_widgets\manager.py
cleanup()
¶
Clean up all managed splitters and widgets.
Removes event filters from splitters and releases references. Should be called when the parent view is being destroyed.
Source code in src\custom_widgets\widget_handlers\splitter_widgets\manager.py
create_detachable_widget(content, title='', dialog_stylesheets=None, dialog_module_folder=None)
¶
Create a detachable widget wrapping the given content.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
content
|
QWidget
|
Widget to wrap in detachable container. |
required |
title
|
str
|
Title for title bar and detached dialog. |
''
|
dialog_stylesheets
|
Optional[List[str]]
|
QSS files to apply to detached dialog. |
None
|
dialog_module_folder
|
Optional[str]
|
Module folder for stylesheet lookup. |
None
|
Returns:
| Type | Description |
|---|---|
DetachableWidget
|
DetachableWidget instance wrapping the content. |