AbstractMaximizeComponent

Search for usage in LXR

AbstractMaximizeComponent Class Reference
Inheritance diagram for AbstractMaximizeComponent:

Properties

alias actions
 
Item content
 
Item footer
 
Item leading
 
alias subtitle
 
alias title
 

Detailed Description

A popup that covers the entire window to show a content item.

This component is designed to show a content item at the maximum size the application window will allow. The typical use is for showing a maximized image or other piece of media in an application, but it could be any item if desired.

The popup also has a header bar which has a writable title, an optional leading item to the left, a list of custom actions specified by the actions property and an optional footer item.

Definition at line 21 of file AbstractMaximizeComponent.qml.

Property Documentation

◆ actions

alias AbstractMaximizeComponent::actions
read

List of top row actions.

Each action will be allocated a QQC2.ToolButton on the top row. All actions are right aligned and appear next to the close button which is always present so does not require specifying.

Definition at line 40 of file AbstractMaximizeComponent.qml.

◆ content

Item AbstractMaximizeComponent::content
read

The main content item in the view.

The item will be the sized to fit the available space. If the item is larger than the available space it will be shrunk to fit.

Note
If stretching the item isn't desirable the user needs to manage this, e.g. with a holding item. See ImageMaximizeDelegate.qml for an example.
See also
ImageMaximizeDelegate.qml

Definition at line 52 of file AbstractMaximizeComponent.qml.

◆ footer

Item AbstractMaximizeComponent::footer
read

Item at the bottom under the content.

Definition at line 60 of file AbstractMaximizeComponent.qml.

◆ leading

Item AbstractMaximizeComponent::leading
read

Item to the left of the overlay title.

Definition at line 56 of file AbstractMaximizeComponent.qml.

◆ subtitle

alias AbstractMaximizeComponent::subtitle
read

The subtitle of the overlay window.

The label will be hidden and the title centered if this is not provided.

Definition at line 32 of file AbstractMaximizeComponent.qml.

◆ title

alias AbstractMaximizeComponent::title
read

The title of the overlay window.

Definition at line 26 of file AbstractMaximizeComponent.qml.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:50:50 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.