geometrize::RecentItems::RecentItemsImpl Class Reference

Public Member Functions
	RecentItemsImpl (const QString &group, unsigned int maxItems)
	~RecentItemsImpl ()=default
RecentItemsImpl &	operator= (const RecentItemsImpl &)=delete
	RecentItemsImpl (const RecentItemsImpl &)=delete
QList< RecentItem >	getItems () const
bool	contains (const QString &value) const
RecentItem	addItem (const QString &itemId, const QString &itemDisplayName)
void	removeItem (const QString &value)
void	clearItems ()
unsigned int	getItemCount () const
unsigned int	getMaxItemCount () const
QString	getOldestItemKey () const

Static Private Member Functions
static QString	getItemGroup ()
static QString	msSinceEpochAsString ()
static long long int	msSinceEpoch ()
static QString	getId ()

Private Attributes
const QString	m_group
	The base path group for storing the recent items in settings e.g. "recent_image_paths" etc. More...
const unsigned int	m_maxItems
	The maximum number of items. More...

Static Private Attributes
static const QString	ID_KEY {"id"}
	Key for the path or URL to the item. More...
static const QString	DISPLAY_NAME_KEY {"displayname"}
	Key for the display name of the item. More...
static const QString	TIME_STAMP_KEY {"timestamp"}
	Key for the timestamp of when the item was added or replaced. More...

Constructor & Destructor Documentation

RecentItemsImpl() [1/2]

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

inline

                                                                 : m_group{group}, m_maxItems{maxItems}
    {
        assert(m_group.length() > 0 && "Base group cannot be empty");
        assert(!m_group.contains('/') && "Base group must not contain forward slashes");
        assert(!m_group.contains('\\') && "Base group must not contain backslashes");
    }

~RecentItemsImpl()

geometrize::RecentItems::RecentItemsImpl::~RecentItemsImpl ( )

default

RecentItemsImpl() [2/2]

geometrize::RecentItems::RecentItemsImpl::RecentItemsImpl ( const RecentItemsImpl &  )

delete

Member Function Documentation

addItem()

RecentItem geometrize::RecentItems::RecentItemsImpl::addItem ( const QString &  itemId, const QString &  itemDisplayName  )

inline

    {
        const RecentItem item(itemId, itemDisplayName, msSinceEpoch());
        const QString group{getItemGroup()};
 
        QSettings settings;
        settings.beginGroup(m_group);
        settings.beginGroup(group);
 
        settings.setValue(ID_KEY, QVariant(item.getKey()));
        settings.setValue(DISPLAY_NAME_KEY, QVariant(item.getDisplayName()));
        settings.setValue(TIME_STAMP_KEY, QVariant(item.getTimeStamp()));
 
        settings.endGroup();
        settings.endGroup();
 
        return item;
    }

Here is the call graph for this function:

clearItems()

void geometrize::RecentItems::RecentItemsImpl::clearItems ( )

inline

    {
        QSettings settings;
        settings.beginGroup(m_group);
        settings.remove("");
        settings.endGroup();
    }

contains()

bool geometrize::RecentItems::RecentItemsImpl::contains ( const QString &  value ) const

inline

    {
        QSettings settings;
        settings.beginGroup(m_group);
        const QStringList childGroups{settings.childGroups()};
        for(const QString& group : childGroups) {
            settings.beginGroup(group);
            if(settings.value(ID_KEY) == value) {
                return true;
            }
            settings.endGroup();
        }
        settings.endGroup();
 
        return false;
    }

getId()

static QString geometrize::RecentItems::RecentItemsImpl::getId ( )

inlinestaticprivate

    {
        static std::atomic<std::size_t> id{0U};
        return QString::number(id++);
    }

Here is the caller graph for this function:

getItemCount()

unsigned int geometrize::RecentItems::RecentItemsImpl::getItemCount ( ) const

inline

    {
        QSettings settings;
        settings.beginGroup(m_group);
        const int count{static_cast<int>(settings.childGroups().length())};
        settings.endGroup();
 
        return count;
    }

getItemGroup()

static QString geometrize::RecentItems::RecentItemsImpl::getItemGroup ( )

inlinestaticprivate

    {
        return msSinceEpochAsString() + "_" + getId();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getItems()

QList<RecentItem> geometrize::RecentItems::RecentItemsImpl::getItems ( ) const

inline

    {
        QSettings settings;
        settings.beginGroup(m_group);
        const QStringList childGroups{settings.childGroups()};
        QList<RecentItem> recentItems;
        for(const QString& group : childGroups) {
            settings.beginGroup(group);
            const RecentItem item(settings.value(ID_KEY, "").toString(), settings.value(DISPLAY_NAME_KEY, "").toString(), settings.value(TIME_STAMP_KEY, 0).toLongLong());
            settings.endGroup();
            recentItems.push_back(item);
        }
        settings.endGroup();
 
        std::sort(recentItems.begin(), recentItems.end(), [](const RecentItem& a, const RecentItem& b) {
            return a.getTimeStamp() < b.getTimeStamp();
        });
        return recentItems;
    }

Here is the caller graph for this function:

getMaxItemCount()

unsigned int geometrize::RecentItems::RecentItemsImpl::getMaxItemCount ( ) const

inline

    {
        return m_maxItems;
    }

getOldestItemKey()

QString geometrize::RecentItems::RecentItemsImpl::getOldestItemKey ( ) const

inline

    {
        QList<RecentItem> items{getItems()};
        if(items.empty()) {
            return "";
        }
        return items.front().getKey();
    }

Here is the call graph for this function:

msSinceEpoch()

static long long int geometrize::RecentItems::RecentItemsImpl::msSinceEpoch ( )

inlinestaticprivate

    {
        return QDateTime::currentMSecsSinceEpoch();
    }

Here is the caller graph for this function:

msSinceEpochAsString()

static QString geometrize::RecentItems::RecentItemsImpl::msSinceEpochAsString ( )

inlinestaticprivate

    {
        return QString::number(msSinceEpoch());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

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

delete

removeItem()

void geometrize::RecentItems::RecentItemsImpl::removeItem ( const QString &  value )

inline

    {
        QSettings settings;
        settings.beginGroup(m_group);
        const QStringList childGroups{settings.childGroups()};
        for(const QString& group : childGroups) {
            settings.beginGroup(group);
            if(settings.value(ID_KEY) == value) {
                settings.remove("");
            }
            settings.endGroup();
        }
        settings.endGroup();
    }

Member Data Documentation

DISPLAY_NAME_KEY

const QString geometrize::RecentItems::RecentItemsImpl::DISPLAY_NAME_KEY {"displayname"}

staticprivate

Key for the display name of the item.

ID_KEY

const QString geometrize::RecentItems::RecentItemsImpl::ID_KEY {"id"}

staticprivate

Key for the path or URL to the item.

m_group

const QString geometrize::RecentItems::RecentItemsImpl::m_group

private

The base path group for storing the recent items in settings e.g. "recent_image_paths" etc.

m_maxItems

const unsigned int geometrize::RecentItems::RecentItemsImpl::m_maxItems

private

The maximum number of items.

TIME_STAMP_KEY

const QString geometrize::RecentItems::RecentItemsImpl::TIME_STAMP_KEY {"timestamp"}

staticprivate

Key for the timestamp of when the item was added or replaced.

---

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

• /home/appveyor/projects/geometrize-docs/geometrize/geometrize/recents/recentitems.cpp