Recently opened menu. More...

#include <RabbitRecentMenu.h>

Inheritance diagram for RabbitCommon::CRecentMenu:

Classes
class	_Content

Public Slots
void	addRecentFile (const QString &fileName, const QString &title=QString())

void	clearMenu ()
	Removes all the menu's actions.

void	setMaxCount (int)
	Sets the maximum number of entries int he menu.

Signals
void	recentFileTriggered (const QString &filename)
	This signal is emitted when a recent file in this menu is triggered.

void	sigSaveState ()

Public Member Functions
	CRecentMenu (QWidget *parent=0)
	Constructs a menu with parent parent.

	CRecentMenu (const QString &title, QWidget *parent=0)
	Constructs a menu with a title and a parent.

	CRecentMenu (const QString &title, const QIcon &icon, QWidget *parent=0)
	Constructs a menu with a title, icon and a parent.

int	maxCount () const
	Returns the maximum number of entries in the menu.

void	setFormat (const QString &format)
	This property holds the string used to generate the item text.

const QString &	format () const
	Returns the current format. /sa setFormat.

bool	disableSaveState (bool disable)
	Default enable save state.

QByteArray	saveState () const
	Saves the state of the recent entries.

bool	restoreState (const QByteArray &state)
	Restores the recent entries to the state specified.

Properties
int	maxCount

QString	format

Private Slots
void	menuTriggered (QAction *)

void	updateRecentFileActions ()

void	slotSaveState ()

Private Attributes
int	m_maxCount

QString	m_format

QList< _Content >	m_OpenContent

bool	m_DisableSaveState

bool	m_bUpdate

Friends
QDataStream &	operator<< (QDataStream &d, const _Content &image)

QDataStream &	operator>> (QDataStream &d, _Content &image)

Detailed Description

Recently opened menu.

Definition at line 26 of file RabbitRecentMenu.h.

Constructor & Destructor Documentation

◆ CRecentMenu() [1/3]

RabbitCommon::CRecentMenu::CRecentMenu ( QWidget * parent = 0 )

Constructs a menu with parent parent.

Definition at line 15 of file RabbitRecentMenu.cpp.

◆ CRecentMenu() [2/3]

RabbitCommon::CRecentMenu::CRecentMenu	(	const QString &	title,
		QWidget *	parent = `0`
	)

Constructs a menu with a title and a parent.

Definition at line 41 of file RabbitRecentMenu.cpp.

◆ CRecentMenu() [3/3]

RabbitCommon::CRecentMenu::CRecentMenu	(	const QString &	title,
		const QIcon &	icon,
		QWidget *	parent = `0`
	)

Constructs a menu with a title, icon and a parent.

Definition at line 47 of file RabbitRecentMenu.cpp.

Member Function Documentation

◆ addRecentFile

void RabbitCommon::CRecentMenu::addRecentFile	(	const QString &	fileName,
		const QString &	title = `QString()`
	)

slot

Definition at line 53 of file RabbitRecentMenu.cpp.

◆ clearMenu

void RabbitCommon::CRecentMenu::clearMenu ( )

slot

Removes all the menu's actions.

Definition at line 68 of file RabbitRecentMenu.cpp.

◆ disableSaveState()

bool RabbitCommon::CRecentMenu::disableSaveState ( bool disable )

Default enable save state.

Definition at line 101 of file RabbitRecentMenu.cpp.

◆ format()

const QString & RabbitCommon::CRecentMenu::format ( ) const

Returns the current format. /sa setFormat.

Definition at line 96 of file RabbitRecentMenu.cpp.

◆ maxCount()

int RabbitCommon::CRecentMenu::maxCount ( ) const

Returns the maximum number of entries in the menu.

Definition at line 83 of file RabbitRecentMenu.cpp.

◆ menuTriggered

void RabbitCommon::CRecentMenu::menuTriggered ( QAction * action )

privateslot

Definition at line 148 of file RabbitRecentMenu.cpp.

◆ restoreState()

bool RabbitCommon::CRecentMenu::restoreState ( const QByteArray & state )

Restores the recent entries to the state specified.

Typically this is used in conjunction with QSettings to restore entries from a past session. Returns false if there are errors. Here is an example: QSettings settings; recentFilesMenu->restoreState(settings.value("recentFiles").toByteArray());

Definition at line 123 of file RabbitRecentMenu.cpp.

◆ saveState()

QByteArray RabbitCommon::CRecentMenu::saveState ( ) const

Saves the state of the recent entries.

Typically this is used in conjunction with QSettings to remember entries for a future session. A version number is stored as part of the data. Here is an example: QSettings settings; settings.setValue("recentFiles", recentFilesMenu->saveState());

Definition at line 107 of file RabbitRecentMenu.cpp.

◆ setFormat()

void RabbitCommon::CRecentMenu::setFormat ( const QString & format )

This property holds the string used to generate the item text.

d is replaced by the item number s is replaced by the item text The default value is "%d %s".

Definition at line 88 of file RabbitRecentMenu.cpp.

◆ setMaxCount

void RabbitCommon::CRecentMenu::setMaxCount ( int count )

slot

Sets the maximum number of entries int he menu.

Definition at line 75 of file RabbitRecentMenu.cpp.

◆ slotSaveState

void RabbitCommon::CRecentMenu::slotSaveState ( )

privateslot

Definition at line 191 of file RabbitRecentMenu.cpp.

◆ updateRecentFileActions

void RabbitCommon::CRecentMenu::updateRecentFileActions ( )

privateslot

Definition at line 154 of file RabbitRecentMenu.cpp.

Friends And Related Symbol Documentation

◆ operator<<

QDataStream & operator<<	(	QDataStream &	d,
		const _Content &	image
	)

friend

Definition at line 202 of file RabbitRecentMenu.cpp.

◆ operator>>

QDataStream & operator>>	(	QDataStream &	d,
		CRecentMenu::_Content &	c
	)

friend

Definition at line 208 of file RabbitRecentMenu.cpp.

Member Data Documentation

◆ m_bUpdate

bool RabbitCommon::CRecentMenu::m_bUpdate

private

Definition at line 129 of file RabbitRecentMenu.h.

◆ m_DisableSaveState

bool RabbitCommon::CRecentMenu::m_DisableSaveState

private

Definition at line 128 of file RabbitRecentMenu.h.

◆ m_format

QString RabbitCommon::CRecentMenu::m_format

private

Definition at line 98 of file RabbitRecentMenu.h.

◆ m_maxCount

int RabbitCommon::CRecentMenu::m_maxCount

private

Definition at line 97 of file RabbitRecentMenu.h.

◆ m_OpenContent

QList<_Content> RabbitCommon::CRecentMenu::m_OpenContent

private

Definition at line 126 of file RabbitRecentMenu.h.

Property Documentation

◆ format

QString RabbitCommon::CRecentMenu::format

readwrite

Definition at line 30 of file RabbitRecentMenu.h.

◆ maxCount

int RabbitCommon::CRecentMenu::maxCount

readwrite

Definition at line 29 of file RabbitRecentMenu.h.

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

/home/runner/work/RabbitCommon/RabbitCommon/Src/RabbitRecentMenu.h
/home/runner/work/RabbitCommon/RabbitCommon/Src/RabbitRecentMenu.cpp

Classes

Public Slots

Signals

Public Member Functions

Properties

Private Slots

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CRecentMenu() [1/3]

◆ CRecentMenu() [2/3]

◆ CRecentMenu() [3/3]

Member Function Documentation

◆ addRecentFile

◆ clearMenu

◆ disableSaveState()

◆ format()

◆ maxCount()

◆ menuTriggered

◆ restoreState()

◆ saveState()

◆ setFormat()

◆ setMaxCount

◆ slotSaveState

◆ updateRecentFileActions

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ m_bUpdate

◆ m_DisableSaveState

◆ m_format

◆ m_maxCount

◆ m_OpenContent

Property Documentation

◆ format

◆ maxCount