AlbumMaximizeComponent

Search for usage in LXR

AlbumMaximizeComponent Class Reference
Inheritance diagram for AlbumMaximizeComponent:

Properties

bool autoLoad
 
bool autoPlay
 
alias currentItem
 
DownloadAction downloadAction
 
bool hideCaption
 
int initialIndex
 
var model
 
KirigamiAction pauseAction
 
KirigamiAction playAction
 
bool showCaption
 
- Properties inherited from AbstractMaximizeComponent
alias actions
 
Item content
 
Item footer
 
Item leading
 
alias subtitle
 
alias title
 

Signals

void itemRightClicked ()
 
void saveItem ()
 

Detailed Description

A popup that covers the entire window to show an album of 1 or more media items.

The component supports a model with one or more media components (images or videos) which can be scrolled through.

Example:

Components.AlbumMaximizeComponent {
id: root
property list<AlbumModelItem> model: [
type: AlbumModelItem.Image
source: "path/to/source"
tempSource: "path/to/tempSource"
caption: "caption text"
},
type: AlbumModelItem.Video
source: "path/to/source"
tempSource: "path/to/tempSource"
caption: "caption text"
}
]
}
int initialIndex
The index of the initial item that should be visible.
var model
Model containing the media item to be shown.
An object container for defining content items to show in a AlbumMaximizeComponent.
Note
The model doesn't have to be create using AlbumModelItem, it just requires the same roles (i.e. type, source, tempSource (optional) and caption (optional)).

Definition at line 44 of file AlbumMaximizeComponent.qml.

Property Documentation

◆ autoLoad

bool AlbumMaximizeComponent::autoLoad
read

Whether any video media should auto-load.

Deprecated
due to changes in the Video API this will be removed in KF6. It currently does nothing but is kept to avoid breakage. The loss of this API has been worked around in a way that doesn't break KF5.

Definition at line 73 of file AlbumMaximizeComponent.qml.

◆ autoPlay

bool AlbumMaximizeComponent::autoPlay
read

Whether any video media should auto-play.

Definition at line 77 of file AlbumMaximizeComponent.qml.

◆ currentItem

alias AlbumMaximizeComponent::currentItem
read

The current item in the view.

Definition at line 107 of file AlbumMaximizeComponent.qml.

◆ downloadAction

DownloadAction AlbumMaximizeComponent::downloadAction
read

The default action triggered when the video download button is pressed.

The download button is only available when the video source is empty (i.e. QUrl() or "")

This exists as a property so that the default action can be overridden. The most common use case for this is where a custom URI scheme is used for example.

See also
DownloadAction

Definition at line 89 of file AlbumMaximizeComponent.qml.

◆ hideCaption

bool AlbumMaximizeComponent::hideCaption
read

Whether the caption is hidden by the user.

Definition at line 65 of file AlbumMaximizeComponent.qml.

◆ initialIndex

int AlbumMaximizeComponent::initialIndex
read

The index of the initial item that should be visible.

Definition at line 57 of file AlbumMaximizeComponent.qml.

◆ model

var AlbumMaximizeComponent::model
read

Model containing the media item to be shown.

The model can be either a qml or a c++ model but each item needs to have the values defined in AlbumModelItem.qml (note a list of these is the easiest way to create a qml model).

Definition at line 53 of file AlbumMaximizeComponent.qml.

◆ pauseAction

KirigamiAction AlbumMaximizeComponent::pauseAction
read

The default action triggered when the pause button is pressed.

This exists as a property so that the action can be overridden. For example if you want to be able to interface with a media manager.

Definition at line 103 of file AlbumMaximizeComponent.qml.

◆ playAction

KirigamiAction AlbumMaximizeComponent::playAction
read

The default action triggered when the play button is pressed.

This exists as a property so that the action can be overridden. For example if you want to be able to interface with a media manager.

Definition at line 96 of file AlbumMaximizeComponent.qml.

◆ showCaption

bool AlbumMaximizeComponent::showCaption
read

Whether the caption should be shown.

Definition at line 61 of file AlbumMaximizeComponent.qml.

Member Function Documentation

◆ itemRightClicked

void AlbumMaximizeComponent::itemRightClicked ( )
signal

Emitted when the content image is right clicked.

◆ saveItem

void AlbumMaximizeComponent::saveItem ( )
signal

Emitted when the save item button is pressed.

The application needs use this signal to trigger the process to save the file.


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.