Menu action which provides most recent used items support. More...

#include <QtxMRUAction.h>

Inheritance diagram for QtxMRUAction:

Public Types
enum	InsertionMode { MoveFirst , MoveLast , AddFirst , AddLast }
	Items insertion policy. More...

enum	LinkType { LinkAuto , LinkShort , LinkFull }

Public Slots
void	clear ()
	Remove all MRU items. More...

Signals
void	activated (const QString &)
	Emitted when user selects any MRU item in the menu. More...

Public Member Functions
	QtxMRUAction (QObject *=0)
	Constructor. More...

	QtxMRUAction (const QString &, const QString &, QObject *=0)
	Constructor. More...

	QtxMRUAction (const QString &, const QIcon &, const QString &, QObject *=0)
	Constructor. More...

virtual	~QtxMRUAction ()
	Destructor. More...

int	insertMode () const
	Get items insertion policy. More...

void	setInsertMode (const int)
	Set items insertion policy. More...

int	linkType () const
	Get the type of link menu name. More...

void	setLinkType (const int)
	Set the type of link menu name. More...

int	count () const
	Get number of MRU items. More...

bool	isEmpty () const
	Check if the MRU items list is empty. More...

int	visibleCount () const
	Get number of visible MRU items. More...

void	setVisibleCount (const int)
	Set number of visible MRU items. More...

bool	isClearPossible () const
	Return visible status of the menu item which clear all MRU items. More...

void	setClearPossible (const bool)
	Set visible the menu item which clear all MRU items. More...

int	historyCount () const
	Get number of totally stored MRU items. More...

void	setHistoryCount (const int)
	Set number of totally stored MRU items. More...

void	remove (const int)
	Remove MRU item. More...

void	remove (const QString &)
	Remove MRU item. More...

void	insert (const QString &)
	Insert MRU item. More...

QString	item (const int) const
	Get MRU item. More...

int	find (const QString &) const
	Get MRU item index. More...

bool	contains (const QString &) const
	Check if MRU item is in the list. More...

virtual void	loadLinks (QtxResourceMgr *, const QString &, const bool=true)
	Load the MRU items from specified resources section. More...

virtual void	saveLinks (QtxResourceMgr *, const QString &, const bool=true) const
	Save the MRU items to specified resources section. More...

Public Member Functions inherited from QtxAction
	QtxAction (QObject *=0, bool=false, const QString &=QString())
	Constructor. More...

	QtxAction (QObject *, bool, const QString &, const QString &, const QString &=QString(), const QIcon &=QIcon())
	Constructor. More...

	QtxAction (const QString &, const QString &, int, QObject *, bool=false, const QString &=QString())
	Constructor. More...

	QtxAction (const QString &, const QString &, const QKeySequence &, QObject *, bool=false, const QString &=QString())
	Constructor. More...

	QtxAction (const QString &, const QIcon &, const QString &, int, QObject *, bool=false, const QString &=QString())
	Constructor. More...

	QtxAction (const QString &, const QIcon &, const QString &, const QKeySequence &, QObject *, bool=false, const QString &=QString())
	Constructor. More...

virtual	~QtxAction ()
	Destructor. More...

virtual bool	eventFilter (QObject , QEvent )
	Customize action events. More...

QString	shortcutActionName () const

void	setShortcutActionName (const QString &)

const QString &	ID () const
	Unique for the entire application ID. More...

void	setID (const QString &theID)

Private Slots
void	onActivated ()
	Called when any MRU item is selected by the user. More...

void	onAboutToShow ()
	Prepare MRU items popup menu. More...

void	onCleared (bool)

Private Member Functions
void	updateMenu ()
	Update MRU items popup menu. More...

Private Attributes
QStringList	myLinks
	most recent used items More...

QAction *	myClear
	clear item More...

int	myVisCount
	number of visible MRU items More...

int	myHistoryCount
	number of stored MRU items More...

int	myLinkType
	type of link names in menu More...

int	myInsertMode
	items insertion policy More...

Additional Inherited Members
Protected Member Functions inherited from QtxAction
virtual void	addedTo (QWidget *)
	Called when the action is added to the widget. More...

virtual void	removedFrom (QWidget *)
	Called when the action is removed from the widget. More...

virtual void	customEvent (QEvent *)
	Process notification events. More...

Detailed Description

Menu action which provides most recent used items support.

Member Enumeration Documentation

◆ InsertionMode

enum QtxMRUAction::InsertionMode

Items insertion policy.

Enumerator
MoveFirst	put the specified item to the beginning
MoveLast	put the specified item to the end
AddFirst	if specified item doesn't exist, add it to the beginning
AddLast	if specified item doesn't exist, add it to the end

◆ LinkType

enum QtxMRUAction::LinkType

Enumerator
LinkAuto	put the full path of link into the menu if link file names of severals link are same
LinkShort	put the only file name of link into the menu
LinkFull	put the full path of link into the menu

Constructor & Destructor Documentation

◆ QtxMRUAction() [1/3]

QtxMRUAction::QtxMRUAction ( QObject * parent = 0 )

Constructor.

Parameters

parent parent object

References myClear, onAboutToShow(), and onCleared().

◆ QtxMRUAction() [2/3]

QtxMRUAction::QtxMRUAction	(	const QString &	text,
		const QString &	menuText,
		QObject *	parent = `0`
	)

Constructor.

Parameters

description	(tooltip) text
menuText	menu text
parent	parent object

References myClear, onAboutToShow(), and onCleared().

◆ QtxMRUAction() [3/3]

QtxMRUAction::QtxMRUAction	(	const QString &	text,
		const QIcon &	icon,
		const QString &	menuText,
		QObject *	parent = `0`
	)

Constructor.

Parameters

description	(tooltip) text
icon	action icon
menuText	menu text
parent	parent object

References myClear, onAboutToShow(), and onCleared().

◆ ~QtxMRUAction()

QtxMRUAction::~QtxMRUAction ( )

virtual

Destructor.

Member Function Documentation

◆ activated

void QtxMRUAction::activated ( const QString & link )

signal

Emitted when user selects any MRU item in the menu.

Parameters

link	selected MRU item

◆ clear

void QtxMRUAction::clear ( )

slot

Remove all MRU items.

References myLinks.

◆ contains()

bool QtxMRUAction::contains ( const QString & link ) const

Check if MRU item is in the list.

Parameters

link MRU item

Returns: true if specified item is already added to the list

References myLinks.

◆ count()

int QtxMRUAction::count ( ) const

Get number of MRU items.

Returns: number of MRU items

References myLinks.

◆ find()

int QtxMRUAction::find ( const QString & link ) const

Get MRU item index.

Parameters

link MRU item

Returns: MRU item index or -1 if item is not found

References myLinks.

◆ historyCount()

int QtxMRUAction::historyCount ( ) const

Get number of totally stored MRU items.

Returns: number of MRU items stored in the preferences

See also: setHistoryCount(), saveLinks(), loadLinks()

References myHistoryCount.

◆ insert()

void QtxMRUAction::insert ( const QString & link )

Insert MRU item.

The item is inserted according to the current insertion policy.

Parameters

link	MRU item to be added

References AddFirst, AddLast, insertMode(), MoveFirst, MoveLast, and myLinks.

◆ insertMode()

int QtxMRUAction::insertMode ( ) const

Get items insertion policy.

Returns: insertion policy (QtxMRUAction::InsertionMode)

References myInsertMode.

◆ isClearPossible()

bool QtxMRUAction::isClearPossible ( ) const

Return visible status of the menu item which clear all MRU items.

References myClear.

◆ isEmpty()

bool QtxMRUAction::isEmpty ( ) const

Check if the MRU items list is empty.

Returns: true if there are no MRU items

References myLinks.

◆ item()

QString QtxMRUAction::item ( const int idx ) const

Get MRU item.

Parameters

idx	MRU item index

Returns: MRU item or null QString if idx is out of range

References myLinks.

◆ linkType()

int QtxMRUAction::linkType ( ) const

Get the type of link menu name.

Returns: link type (QtxMRUAction::LinkType)

References myLinkType.

◆ loadLinks()

void QtxMRUAction::loadLinks	(	QtxResourceMgr *	resMgr,
		const QString &	section,
		const bool	clear = `true`
	)

virtual

Load the MRU items from specified resources section.

Parameters

resMgr	resources manager
section	resources section
clear	if `true`, previous MRU items list is cleared

References clear(), myLinks, QtxResourceMgr::parameters(), and QtxResourceMgr::stringValue().

◆ onAboutToShow

void QtxMRUAction::onAboutToShow ( )

privateslot

Prepare MRU items popup menu.

This method is called when the parent menu is shown. Enables or disables sub menu item according to the number of MRU items.

References updateMenu().

◆ onActivated

void QtxMRUAction::onActivated ( )

privateslot

Called when any MRU item is selected by the user.

Emits signal activated(const QString&) passing selected MRU item as parameter.

References activated(), and myLinks.

◆ onCleared

void QtxMRUAction::onCleared ( bool )

privateslot

References clear().

◆ remove() [1/2]

void QtxMRUAction::remove ( const int idx )

Remove MRU item.

Does nothing if idx is out of range.

Parameters

idx	MRU item index

References myLinks.

◆ remove() [2/2]

void QtxMRUAction::remove ( const QString & link )

Remove MRU item.

Does nothing if there is no speicified item in the list.

Parameters

link	MRU item to be removed

References myLinks.

◆ saveLinks()

void QtxMRUAction::saveLinks	(	QtxResourceMgr *	resMgr,
		const QString &	section,
		const bool	clear = `true`
	)		const

virtual

Save the MRU items to specified resources section.

Parameters

resMgr	resources manager
section	resources section
clear	if `true`, the resources section is first cleared

References clear(), myHistoryCount, myLinks, QtxResourceMgr::parameters(), QtxResourceMgr::remove(), QtxResourceMgr::setValue(), and QtxResourceMgr::stringValue().

◆ setClearPossible()

void QtxMRUAction::setClearPossible ( const bool on )

Set visible the menu item which clear all MRU items.

References myClear.

◆ setHistoryCount()

void QtxMRUAction::setHistoryCount ( const int num )

Set number of totally stored MRU items.

This option allows setting number of MRU items to be stored in the preferences file.

If num < 0, then number of stored MRU items is not limited.

Returns: number of MRU items stored in the preferences

See also: historyCount(), saveLinks(), loadLinks()

References myHistoryCount.

◆ setInsertMode()

void QtxMRUAction::setInsertMode ( const int mode )

Set items insertion policy.

Parameters

mode	insertion policy (QtxMRUAction::InsertionMode)

References myInsertMode.

◆ setLinkType()

void QtxMRUAction::setLinkType ( const int type )

Set the type of link menu name.

Parameters

link	type (QtxMRUAction::LinkType)

References myLinkType.

◆ setVisibleCount()

void QtxMRUAction::setVisibleCount ( const int num )

Set number of visible MRU items.

This method sets the maximum number of MRU items to be displayed in the popup menu (5 by default).

If num < 1, then all MRU items will be displayed.

Parameters

num	visible MRU items number

References myVisCount.

◆ updateMenu()

void QtxMRUAction::updateMenu ( )

private

Update MRU items popup menu.

References AddLast, count(), Qtx::file(), insertMode(), isClearPossible(), LinkAuto, LinkFull, LinkShort, linkType(), MoveLast, myClear, myLinks, onActivated(), and visibleCount().

◆ visibleCount()

int QtxMRUAction::visibleCount ( ) const

Get number of visible MRU items.

Returns: visible MRU items number

See also: setVisibleCount()

References myVisCount.

Member Data Documentation

◆ myClear

QAction* QtxMRUAction::myClear

private

clear item

◆ myHistoryCount

int QtxMRUAction::myHistoryCount

private

number of stored MRU items

◆ myInsertMode

int QtxMRUAction::myInsertMode

private

items insertion policy

◆ myLinks

QStringList QtxMRUAction::myLinks

private

most recent used items

◆ myLinkType

int QtxMRUAction::myLinkType

private

type of link names in menu

◆ myVisCount

int QtxMRUAction::myVisCount

private

number of visible MRU items

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

src/Qtx/QtxMRUAction.h
src/Qtx/QtxMRUAction.cxx

Public Types

Public Slots

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ InsertionMode

◆ LinkType

Constructor & Destructor Documentation

◆ QtxMRUAction() [1/3]

◆ QtxMRUAction() [2/3]

◆ QtxMRUAction() [3/3]

◆ ~QtxMRUAction()

Member Function Documentation

◆ activated

◆ clear

◆ contains()

◆ count()

◆ find()

◆ historyCount()

◆ insert()

◆ insertMode()

◆ isClearPossible()

◆ isEmpty()

◆ item()

◆ linkType()

◆ loadLinks()

◆ onAboutToShow

◆ onActivated

◆ onCleared

◆ remove() [1/2]

◆ remove() [2/2]

◆ saveLinks()

◆ setClearPossible()

◆ setHistoryCount()

◆ setInsertMode()

◆ setLinkType()

◆ setVisibleCount()

◆ updateMenu()

◆ visibleCount()

Member Data Documentation

◆ myClear

◆ myHistoryCount

◆ myInsertMode

◆ myLinks

◆ myLinkType

◆ myVisCount