geometrize::RecentItems Class Reference

The RecentItems class encapsulates a list of items that were recently interacted with. The class keeps a record of these items stored in preferences. Useful for keeping track of recently opened files. More...

#include <recentitems.h>

Inheritance diagram for geometrize::RecentItems:

Collaboration diagram for geometrize::RecentItems:

Classes
class	RecentItemsImpl

Signals
void	signal_added (const RecentItem &item)
	signal_added is emitted after an item is added. More...
void	signal_removed (const QString &itemId)
	signal_removed is emitted after an item is removed. More...
void	signal_cleared ()
	signal_cleared is emitted after the recent items are cleared. More...

Public Member Functions
	RecentItems (const QString &group, unsigned int maxItems)
	RecentItems Creates a new RecentItems instance. More...
RecentItems &	operator= (RecentItems &)=delete
	RecentItems (RecentItems &)=delete
	RecentItems (RecentItems &&)=delete
virtual	~RecentItems ()
QList< RecentItem >	getItems () const
	getItems Gets the recent items. More...
void	add (const QString &itemId, const QString &itemDisplayName)
	add Adds an item to the recent items. More...
void	remove (const QString &itemId)
	remove Removes an item from the recent items. More...
void	clear ()
	clear Removes all items from the recent items. More...

Private Attributes
std::unique_ptr< RecentItemsImpl >	d

Friends
void	swap (RecentItems &first, RecentItems &second)

Detailed Description

The RecentItems class encapsulates a list of items that were recently interacted with. The class keeps a record of these items stored in preferences. Useful for keeping track of recently opened files.

Constructor & Destructor Documentation

geometrize::RecentItems::RecentItems	(	const QString &	group,
		unsigned int	maxItems
	)

RecentItems Creates a new RecentItems instance.

Parameters

group	The base path group to use for storing the recent items in settings e.g. "recent_image_paths", "recent_video_names" etc.
maxItems	The maximum number of items to load. The most recent items will be loaded initially, and the oldest items will be replaced when new items are added over the limit.

                                                                          : d{std::make_unique<RecentItemsImpl>(group, maxItems)}
{
}

geometrize::RecentItems::RecentItems ( RecentItems &  )

delete

geometrize::RecentItems::RecentItems ( RecentItems &&  )

delete

geometrize::RecentItems::~RecentItems ( )

virtual

{
}

Member Function Documentation

void geometrize::RecentItems::add	(	const QString &	itemId,
		const QString &	itemDisplayName
	)

add Adds an item to the recent items.

Parameters

itemId	A unique id for the item (e.g. a complete file path).
itemDisplayName	A display name for the item (e.g. a file name).

{
    if(d->getItemCount() > d->getMaxItemCount()) {
        remove(d->getOldestItemKey());
    }

    const bool preexisting{d->contains(itemId)};
    if(!preexisting) {
        const RecentItem item{d->addItem(itemId, itemDisplayName)};
        emit signal_added(item);
    }
}

Here is the caller graph for this function:

void geometrize::RecentItems::clear

(

)

clear Removes all items from the recent items.

{
    d->clearItems();
    emit signal_cleared();
}

Here is the caller graph for this function:

QList< RecentItem > geometrize::RecentItems::getItems

(

)

const

getItems Gets the recent items.

Returns

A list of the recent items, sorted from most recently interacted with to oldest.

{
    return d->getItems();
}

Here is the caller graph for this function:

RecentItems& geometrize::RecentItems::operator= ( RecentItems &  )

delete

void geometrize::RecentItems::remove

(

const QString &

itemId

)

remove Removes an item from the recent items.

Parameters

itemId

The item id to remove.

{
    d->removeItem(itemId);
    emit signal_removed(itemId);
}

Here is the caller graph for this function:

void geometrize::RecentItems::signal_added ( const RecentItem &  item )

signal

signal_added is emitted after an item is added.

Parameters

item	The item that was added.

Here is the caller graph for this function:

void geometrize::RecentItems::signal_cleared ( )

signal

signal_cleared is emitted after the recent items are cleared.

Here is the caller graph for this function:

void geometrize::RecentItems::signal_removed ( const QString &  itemId )

signal

signal_removed is emitted after an item is removed.

Parameters

itemId

The id of the item that was removed.

Here is the caller graph for this function:

Friends And Related Function Documentation

void swap ( RecentItems &  first, RecentItems &  second  )

friend

Member Data Documentation

std::unique_ptr<RecentItemsImpl> geometrize::RecentItems::d

private

---

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

• /home/travis/build/Tw1ddle/geometrize-docs/geometrize/geometrize/recents/recentitems.h
• /home/travis/build/Tw1ddle/geometrize-docs/geometrize/geometrize/recents/recentitems.cpp