Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

AlbumMaximizeComponent QML Type

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

• Import Statement: import org.kde.kirigamiaddons.labs.components
• Inherits: AbstractMaximizeComponent

#Detailed Description

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: [
     AlbumModelItem {
         type: AlbumModelItem.Image
         source: "path/to/source"
         tempSource: "path/to/tempSource"
         caption: "caption text"
     },
     AlbumModelItem {
         type: AlbumModelItem.Video
         source: "path/to/source"
         tempSource: "path/to/tempSource"
         caption: "caption text"
     }
 ]
 initialIndex: 0
 model: model
}

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)).

#Property Documentation

#[default: true] autoPlay : bool

Whether any video media should auto-play.

#currentIndex : int

The current index in the view.

#currentItem : Item

The current Item in the view.

#downloadAction : DownloadAction

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

#[default: false] hideCaption : bool

Whether the caption is hidden by the user.

#[default: -1] initialIndex : int

The index of the initial item that should be visible.

#model : var

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 (note a list of these is the easiest way to create a qml model).

#pauseAction : Kirigami.Action

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.

#playAction : Kirigami.Action

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.

#[default: true] showCaption : bool

Whether the caption should be shown.

#Signal Documentation

#itemRightClicked()

Emitted when the content image is right clicked.

Note: The corresponding handler is onItemRightClicked.

#saveItem()

Emitted when the save item button is pressed.

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

Note: The corresponding handler is onSaveItem.