Windows API Reference¶
This page provides the API reference for window implementations in qtframelesskit.windows.window.
qtframelesskit.windows.window
¶
Concrete frameless window implementations for base opaque, Acrylic, and Mica backdrops.
Provides dedicated subclass families for standard opaque windows, Windows 10/11 Fluent Acrylic blur-behind material, and Windows 11 native Mica and Mica Alt materials.
AcrylicWindowMixin
¶
Mixin providing native Windows Fluent Acrylic blur-behind material integration.
Source code in src/qtframelesskit/windows/window.py
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 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 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 | |
changeEvent(event)
¶
Handle window state change events, refreshing Acrylic blur when maximized or restored.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
QEvent
|
State change event. |
required |
Source code in src/qtframelesskit/windows/window.py
getGradientColor()
¶
Return the active Acrylic gradient tint color.
Returns:
| Type | Description |
|---|---|
str, int, or None
|
Current tint color representation. |
Source code in src/qtframelesskit/windows/window.py
refreshBackgroundBlurEffect()
¶
Reapply native Acrylic blur effect to prevent visual loss after state transitions.
Source code in src/qtframelesskit/windows/window.py
setGradientColor(color)
¶
Apply a new Acrylic gradient tint color and refresh DWM composition.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
color
|
str, int, or None
|
Gradient tint color representation. |
required |
Source code in src/qtframelesskit/windows/window.py
FramelessAcrylicDialog
¶
Bases: AcrylicWindowMixin, FramelessDialog
Frameless :class:QDialog with native Fluent Acrylic blur-behind material.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hint
|
list of str
|
Control button hints to display on the title bar. |
None
|
flags
|
list
|
Additional Qt window flags to apply. |
None
|
gradientColor
|
str, int, or None
|
Custom gradient tint color for the Acrylic effect. |
None
|
Source code in src/qtframelesskit/windows/window.py
FramelessAcrylicMainWindow
¶
Bases: AcrylicWindowMixin, FramelessMainWindow
Frameless :class:QMainWindow with native Fluent Acrylic blur-behind material.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hint
|
list of str
|
Control button hints to display on the title bar. |
None
|
flags
|
list
|
Additional Qt window flags to apply. |
None
|
gradientColor
|
str, int, or None
|
Custom gradient tint color for the Acrylic effect. |
None
|
Source code in src/qtframelesskit/windows/window.py
FramelessAcrylicWindow
¶
Bases: AcrylicWindowMixin, FramelessWindow
Frameless :class:QWidget with native Fluent Acrylic blur-behind material.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hint
|
list of str
|
Control button hints to display on the title bar. |
None
|
flags
|
list
|
Additional Qt window flags to apply. |
None
|
gradientColor
|
str, int, or None
|
Custom gradient tint color for the Acrylic effect. |
None
|
Source code in src/qtframelesskit/windows/window.py
FramelessDialog
¶
Bases: BaseDialog
Frameless :class:QDialog with an integrated custom title bar.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hint
|
list of str
|
Title-bar button keys to display. Defaults to all buttons when None. |
None
|
flags
|
list
|
Extra Qt window flags to apply. Defaults to an empty list. |
None
|
Source code in src/qtframelesskit/windows/window.py
FramelessMainWindow
¶
Bases: BaseMainWindow
Frameless :class:QMainWindow with an integrated custom title bar.
Wraps the title bar and content inside a central widget so that dock and toolbar mechanisms operate normally.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hint
|
list of str
|
Title-bar button keys to display. Defaults to all buttons when None. |
None
|
flags
|
list
|
Extra Qt window flags to apply. Defaults to an empty list. |
None
|
Source code in src/qtframelesskit/windows/window.py
menuBar()
¶
Return the integrated QMenuBar, creating one on the title bar if not present.
Returns:
| Type | Description |
|---|---|
QMenuBar
|
The active QMenuBar attached to the custom title bar. |
Source code in src/qtframelesskit/windows/window.py
setMenuBar(menuBar)
¶
Set the QMenuBar on the custom title bar.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
menuBar
|
QMenuBar
|
Menu bar instance to attach to the custom title bar. |
required |
Source code in src/qtframelesskit/windows/window.py
FramelessMicaDialog
¶
Bases: MicaWindowMixin, FramelessDialog
Frameless :class:QDialog with native Windows 11 Mica or Mica Alt backdrop.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hint
|
list of str
|
Control button hints to display on the title bar. |
None
|
flags
|
list
|
Additional Qt window flags to apply. |
None
|
isAlt
|
bool
|
True to apply Mica Alt material, False for standard Mica. Defaults to False. |
False
|
Source code in src/qtframelesskit/windows/window.py
FramelessMicaMainWindow
¶
Bases: MicaWindowMixin, FramelessMainWindow
Frameless :class:QMainWindow with native Windows 11 Mica or Mica Alt backdrop.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hint
|
list of str
|
Control button hints to display on the title bar. |
None
|
flags
|
list
|
Additional Qt window flags to apply. |
None
|
isAlt
|
bool
|
True to apply Mica Alt material, False for standard Mica. Defaults to False. |
False
|
Source code in src/qtframelesskit/windows/window.py
FramelessMicaWindow
¶
Bases: MicaWindowMixin, FramelessWindow
Frameless :class:QWidget with native Windows 11 Mica or Mica Alt backdrop.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hint
|
list of str
|
Control button hints to display on the title bar. |
None
|
flags
|
list
|
Additional Qt window flags to apply. |
None
|
isAlt
|
bool
|
True to apply Mica Alt material, False for standard Mica. Defaults to False. |
False
|
Source code in src/qtframelesskit/windows/window.py
FramelessWidget
¶
Bases: BaseWidget
Frameless :class:QWidget with an integrated custom title bar.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hint
|
list of str
|
Title-bar button keys to display (e.g. |
None
|
flags
|
list
|
Extra Qt window flags to apply. Defaults to an empty list. |
None
|
Source code in src/qtframelesskit/windows/window.py
FramelessWindow
¶
Bases: FramelessWidget
Frameless top-level window widget with integrated custom title bar.
Alias and standard widget subclass equivalent to :class:FramelessWidget.
Source code in src/qtframelesskit/windows/window.py
MicaWindowMixin
¶
Mixin providing native Windows 11 Mica and Mica Alt backdrop material integration.
Source code in src/qtframelesskit/windows/window.py
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 | |
isAlt()
¶
Return whether Mica Alt (tabbed window backdrop) is active.
Returns:
| Type | Description |
|---|---|
bool
|
True if Mica Alt is enabled, False for standard Mica. |
setIsAlt(isAlt)
¶
Configure Mica backdrop variant and reapply DWM attributes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
isAlt
|
bool
|
True to apply Mica Alt, False for standard Mica. |
required |