A datastore of images for display by a screen. More...

#include <mythfrontend/galleryviews.h>

Inheritance diagram for FlatView:

Collaboration diagram for FlatView:

Public Member Functions
	FlatView (SlideOrderType order)

virtual	~FlatView ()

int	GetParentId () const

ImageListK	GetAllNodes () const
	Get all images/dirs in view. More...

ImagePtrK	GetSelected () const
	Get current selection. More...

ImagePtrK	HasNext (int inc) const
	Peeks at next image in view but does not advance iterator. More...

ImagePtrK	HasPrev (int inc) const
	Peeks at previous image in view but does not decrement iterator. More...

ImagePtrK	Next (int inc)
	Advance iterator and return next image, wrapping if necessary. Regenerates unordered views on wrap. More...

ImagePtrK	Prev (int inc)
	Decrements iterator and returns previous image. Wraps at start. More...

QString	GetPosition () const
	Get positional status. More...

bool	Select (int id, int fallback=0)
	Selects first occurrence of an image. More...

virtual bool	LoadFromDb (int parentId)
	Populate view with database images from a directory. More...

QStringList	ClearImage (int id, bool remove=false)
	Clear file from UI cache and optionally from view. More...

void	ClearCache ()
	Clears UI cache. More...

bool	Update (int id)
	Updates view with images that have been updated. More...

void	Rotate (int id)
	Rotate view so that starting image is at front. More...

void	Clear (bool resetParent=true)
	Reset view. More...

QString	GetCachedThumbUrl (int id) const

Protected Member Functions
void	Populate (ImageList &files)
	Fills view with Db images, re-ordering them as required. More...

void	Cache (int id, int parent, const QString &url, const QString &thumb)
	Cache image properties to optimize UI. More...

Static Protected Member Functions
static WeightList	CalculateSeasonalWeights (ImageList &files)
	This method calculates a weight for the item based on how closely it was taken to the current time of year. This means that New Year's pictures will be displayed very frequently on every New Year's, and that anniversary pictures will be favored again every anniversary. The weights are chosen using a beta distribution with a tunable shape parameter. More...

Protected Attributes
int	m_parentId {-1}

SlideOrderType	m_order {kOrdered}

ImageManagerFe &	m_mgr

QHash< int, ImagePtrK >	m_images
	Image objects currently displayed. More...

ImageIdList	m_sequence
	The sequence in which to display images. More...

int	m_active {0}
	Sequence index of current selected image. More...

QHash< int, FileCacheEntry >	m_fileCache
	Caches displayed image files. More...

Detailed Description

A datastore of images for display by a screen.

A flat view provides a list of ordered images (no dirs) from a single directory (as required by a slideshow of a directory).

Definition at line 101 of file galleryviews.h.

Constructor & Destructor Documentation

◆ FlatView()

FlatView::FlatView ( SlideOrderType order )

inlineexplicit

Definition at line 104 of file galleryviews.h.

◆ ~FlatView()

virtual FlatView::~FlatView ( )

inlinevirtual

Definition at line 106 of file galleryviews.h.

Member Function Documentation

◆ GetParentId()

int FlatView::GetParentId ( ) const

inline

Definition at line 108 of file galleryviews.h.

Referenced by GalleryThumbView::customEvent(), GalleryThumbView::DoShowHidden(), GalleryThumbView::DoShowType(), and GalleryThumbView::ShowSettings().

◆ GetAllNodes()

ImageListK FlatView::GetAllNodes ( ) const

Get all images/dirs in view.

Returns: ImageList List of images/dirs

Definition at line 54 of file galleryviews.cpp.

Referenced by GalleryThumbView::BuildImageList().

◆ GetSelected()

ImagePtrK FlatView::GetSelected ( ) const

Get current selection.

Returns: ImagePtr An image or nullptr

Definition at line 67 of file galleryviews.cpp.

Referenced by GalleryThumbView::BuildImageList(), GallerySlideView::Close(), GalleryThumbView::customEvent(), GallerySlideView::customEvent(), GalleryThumbView::DirSelectDown(), GalleryThumbView::DoMarkItem(), DirectoryView::GetMenuSubjects(), GalleryThumbView::keyPressEvent(), DirectoryView::LoadFromDb(), GalleryThumbView::ShowDetails(), GallerySlideView::ShowSlide(), GalleryThumbView::StartSlideshow(), GallerySlideView::Transform(), GalleryThumbView::TransformItem(), and Update().

◆ HasNext()

ImagePtrK FlatView::HasNext ( int inc ) const

Peeks at next image in view but does not advance iterator.

Returns: ImageItem The next image or nullptr

Definition at line 155 of file galleryviews.cpp.

Referenced by GallerySlideView::ShowNextSlide(), and GallerySlideView::TransitionComplete().

◆ HasPrev()

ImagePtrK FlatView::HasPrev ( int inc ) const

Peeks at previous image in view but does not decrement iterator.

Returns: ImageItem The previous image or nullptr

Definition at line 189 of file galleryviews.cpp.

Referenced by GallerySlideView::ShowPrevSlide().

◆ Next()

ImagePtrK FlatView::Next ( int inc )

Advance iterator and return next image, wrapping if necessary. Regenerates unordered views on wrap.

Returns: ImageItem Next image or nullptr if empty

Definition at line 167 of file galleryviews.cpp.

Referenced by GallerySlideView::ShowNextSlide().

◆ Prev()

ImagePtrK FlatView::Prev ( int inc )

Decrements iterator and returns previous image. Wraps at start.

Returns: ImageItem Previous image or nullptr if empty

Definition at line 200 of file galleryviews.cpp.

Referenced by GallerySlideView::ShowPrevSlide().

◆ GetPosition()

QString FlatView::GetPosition ( ) const

Get positional status.

Returns: QString "m/n" where m is selected index, n is total count in view

Definition at line 78 of file galleryviews.cpp.

Referenced by GallerySlideView::SlideAvailable().

◆ Select()

bool FlatView::Select	(	int	id,
		int	fallback = `0`
	)

Selects first occurrence of an image.

Parameters

id	Image id
fallback	View index to select if image is not in view. Defaults to first image. If negative then current selection is not changed if the image is not found

Returns: bool True if the image was found

Definition at line 120 of file galleryviews.cpp.

Referenced by GalleryThumbView::DirSelectUp(), DirectoryView::LoadFromDb(), GalleryThumbView::SelectImage(), GalleryThumbView::SetUiSelection(), and GallerySlideView::Start().

◆ LoadFromDb()

bool FlatView::LoadFromDb ( int parentId )

virtual

Populate view with database images from a directory.

Parameters

parentId The dir id, if positive. Otherwise the view is refreshed using the existing parent dir

Returns: bool True if resulting view is not empty

Reimplemented in TreeView, and DirectoryView.

Definition at line 371 of file galleryviews.cpp.

Referenced by Next(), and GallerySlideView::Start().

◆ ClearImage()

QStringList FlatView::ClearImage	(	int	id,
		bool	remove = `false`
	)

Clear file from UI cache and optionally from view.

Parameters

id
remove	If true, file is also deleted from view

Returns: QStringList Url of image & thumbnail to remove from image cache

Definition at line 403 of file galleryviews.cpp.

Referenced by DirectoryView::RemoveImage().

◆ ClearCache()

void FlatView::ClearCache ( )

Clears UI cache.

Definition at line 390 of file galleryviews.cpp.

Referenced by DirectoryView::ClearCache().

◆ Update()

bool FlatView::Update ( int id )

Updates view with images that have been updated.

Parameters

id	Image id to update

Returns: bool True if the current selection has been updated

Definition at line 89 of file galleryviews.cpp.

Referenced by GallerySlideView::customEvent().

◆ Rotate()

void FlatView::Rotate ( int id )

Rotate view so that starting image is at front.

Parameters

id	The image to be positioned

Definition at line 430 of file galleryviews.cpp.

Referenced by GallerySlideView::Start().

◆ Clear()

void FlatView::Clear ( bool resetParent = true )

Reset view.

Parameters

resetParent parent id is only reset to root when this is set

Definition at line 141 of file galleryviews.cpp.

Referenced by DirectoryView::Clear(), Populate(), and ~FlatView().

◆ GetCachedThumbUrl()

QString FlatView::GetCachedThumbUrl ( int id ) const

inline

Definition at line 124 of file galleryviews.h.

Referenced by GalleryThumbView::customEvent().

◆ CalculateSeasonalWeights()

WeightList FlatView::CalculateSeasonalWeights ( ImageList & files )

staticprotected

This method calculates a weight for the item based on how closely it was taken to the current time of year. This means that New Year's pictures will be displayed very frequently on every New Year's, and that anniversary pictures will be favored again every anniversary. The weights are chosen using a beta distribution with a tunable shape parameter.

Parameters

files List of database images

Returns: WeightList Corresponding list of weightings

Definition at line 312 of file galleryviews.cpp.

Referenced by Populate().

◆ Populate()

void FlatView::Populate ( ImageList & files )

protected

Fills view with Db images, re-ordering them as required.

Parameters

files List of images from database

Definition at line 218 of file galleryviews.cpp.

Referenced by LoadFromDb(), DirectoryView::LoadFromDb(), and TreeView::LoadFromDb().

◆ Cache()

void FlatView::Cache	(	int	id,
		int	parent,
		const QString &	url,
		const QString &	thumb
	)

protected

Cache image properties to optimize UI.

Parameters

id	Image id
parent	Its dir
url	Image url
thumb	Thumbnail url

Definition at line 451 of file galleryviews.cpp.

Referenced by DirectoryView::Cache(), and Populate().

Member Data Documentation

◆ m_parentId

int FlatView::m_parentId {-1}

protected

Definition at line 133 of file galleryviews.h.

Referenced by Clear(), GetParentId(), LoadFromDb(), DirectoryView::LoadFromDb(), TreeView::LoadFromDb(), and Next().

◆ m_order

SlideOrderType FlatView::m_order {kOrdered}

protected

Definition at line 134 of file galleryviews.h.

Referenced by Next(), and Populate().

◆ m_mgr

ImageManagerFe& FlatView::m_mgr

protected

Definition at line 135 of file galleryviews.h.

Referenced by DirectoryView::LoadDirThumbs(), LoadFromDb(), DirectoryView::LoadFromDb(), TreeView::LoadFromDb(), and Update().

◆ m_images

QHash<int, ImagePtrK> FlatView::m_images

protected

Image objects currently displayed.

Definition at line 136 of file galleryviews.h.

Referenced by Clear(), ClearImage(), GetAllNodes(), DirectoryView::GetMenuSubjects(), DirectoryView::GetParent(), GetSelected(), HasNext(), HasPrev(), Next(), Populate(), Prev(), and Update().

◆ m_sequence

ImageIdList FlatView::m_sequence

protected

The sequence in which to display images.

Definition at line 137 of file galleryviews.h.

Referenced by Clear(), ClearImage(), GetAllNodes(), DirectoryView::GetChildren(), DirectoryView::GetMenuSubjects(), DirectoryView::GetParent(), GetPosition(), DirectoryView::GetPosition(), GetSelected(), HasNext(), HasPrev(), Next(), Populate(), Prev(), Rotate(), and Select().

◆ m_active

int FlatView::m_active {0}

protected

Sequence index of current selected image.

Definition at line 138 of file galleryviews.h.

Referenced by Clear(), GetPosition(), DirectoryView::GetPosition(), GetSelected(), HasNext(), HasPrev(), Next(), Prev(), and Select().

◆ m_fileCache

QHash<int, FileCacheEntry> FlatView::m_fileCache

protected

Caches displayed image files.

Definition at line 141 of file galleryviews.h.

Referenced by Cache(), DirectoryView::Cache(), ClearCache(), ClearImage(), GetCachedThumbUrl(), and DirectoryView::RemoveImage().

The documentation for this class was generated from the following files:

mythtv/programs/mythfrontend/galleryviews.h
mythtv/programs/mythfrontend/galleryviews.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FlatView()

◆ ~FlatView()

Member Function Documentation

◆ GetParentId()

◆ GetAllNodes()

◆ GetSelected()

◆ HasNext()

◆ HasPrev()

◆ Next()

◆ Prev()

◆ GetPosition()

◆ Select()

◆ LoadFromDb()

◆ ClearImage()

◆ ClearCache()

◆ Update()

◆ Rotate()

◆ Clear()

◆ GetCachedThumbUrl()

◆ CalculateSeasonalWeights()

◆ Populate()

◆ Cache()

Member Data Documentation

◆ m_parentId

◆ m_order

◆ m_mgr

◆ m_images

◆ m_sequence

◆ m_active

◆ m_fileCache