TDERecentFilesAction Class Reference

#include <tdeactionclasses.h>

Inheritance diagram for TDERecentFilesAction:

Public Slots
void	setMaxItems (uint maxItems)
void	loadEntries (TDEConfig *config, TQString groupname=TQString::null)
void	saveEntries (TDEConfig *config, TQString groupname=TQString::null)
void	addURL (const KURL &url)
void	addURL (const KURL &url, const TQString &name)
void	removeURL (const KURL &url)
void	clearURLList ()
Public Slots inherited from TDEListAction
virtual void	setCurrentItem (int index)
Public Slots inherited from TDESelectAction
virtual void	setCurrentItem (int index)
virtual void	setItems (const TQStringList &lst)
virtual void	clear ()
virtual void	setEditable (bool)
virtual void	setComboWidth (int width)
Public Slots inherited from TDEAction
virtual void	setText (const TQString &text)
virtual bool	setShortcut (const TDEShortcut &)
virtual void	setGroup (const TQString &)
virtual void	setWhatsThis (const TQString &text)
virtual void	setToolTip (const TQString &)
virtual void	setIconSet (const TQIconSet &iconSet)
virtual void	setIcon (const TQString &icon)
virtual void	setEnabled (bool enable)
void	setDisabled (bool disable)
virtual void	setShortcutConfigurable (bool)
virtual void	activate ()

Signals
void	urlSelected (const KURL &url)
Signals inherited from TDESelectAction
void	activated (int index)
void	activated (const TQString &text)
Signals inherited from TDEAction
void	activated ()
void	activated (TDEAction::ActivationReason reason, TQt::ButtonState state)
void	enabled (bool)

Public Member Functions
	TDERecentFilesAction (const TQString &text, const TDEShortcut &cut, TQObject *parent, const char *name=0, uint maxItems=10)
	TDERecentFilesAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0, uint maxItems=10)
	TDERecentFilesAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, TQObject *parent, const char *name=0, uint maxItems=10)
	TDERecentFilesAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, TQObject *parent, const char *name=0, uint maxItems=10)
	TDERecentFilesAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0, uint maxItems=10)
	TDERecentFilesAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0, uint maxItems=10)
	TDERecentFilesAction (TQObject *parent=0, const char *name=0, uint maxItems=10)
virtual	~TDERecentFilesAction ()
virtual int	plug (TQWidget *widget, int index=-1)
uint	maxItems () const
virtual TQStringList	items () const
TQStringList	completeItems () const
Public Member Functions inherited from TDEListAction
	TDEListAction (const TQString &text, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEListAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEListAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEListAction (const TQString &text, const TQString &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEListAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEListAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEListAction (TQObject *parent=0, const char *name=0)
virtual	~TDEListAction ()
virtual TQString	currentText () const
virtual int	currentItem () const
Public Member Functions inherited from TDESelectAction
	TDESelectAction (const TQString &text, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDESelectAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDESelectAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDESelectAction (const TQString &text, const TQString &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDESelectAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDESelectAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDESelectAction (TQObject *parent=0, const char *name=0)
virtual	~TDESelectAction ()
virtual bool	isEditable () const
virtual void	changeItem (int index, const TQString &text)
virtual int	comboWidth () const
void	setMaxComboViewCount (int n)
TQPopupMenu *	popupMenu () const
void	setRemoveAmpersandsInCombo (bool b) TDE_DEPRECATED
bool	removeAmpersandsInCombo () const
void	setMenuAccelsEnabled (bool b)
bool	menuAccelsEnabled () const
virtual bool	isShortcutConfigurable () const
Public Member Functions inherited from TDEAction
	TDEAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
	TDEAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
	TDEAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
	TDEAction (const KGuiItem &item, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
	TDEAction (const TQString &text, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEAction (const TQString &text, const TQString &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEAction (TQObject *parent=0, const char *name=0)
virtual	~TDEAction ()
virtual void	plugAccel (TDEAccel *accel, bool configurable=true) TDE_DEPRECATED
virtual void	unplug (TQWidget *w)
virtual void	unplugAccel () TDE_DEPRECATED
virtual bool	isPlugged () const
bool	isPlugged (const TQWidget *container) const
virtual bool	isPlugged (const TQWidget *container, int id) const
virtual bool	isPlugged (const TQWidget *container, const TQWidget *_representative) const
TQWidget *	container (int index) const
int	itemId (int index) const
TQWidget *	representative (int index) const
int	containerCount () const
uint	tdeaccelCount () const
virtual bool	hasIcon () const
bool	hasIconSet () const
virtual TQString	plainText () const
virtual TQString	text () const
virtual const TDEShortcut &	shortcut () const
virtual const TDEShortcut &	shortcutDefault () const
TQString	shortcutText () const
void	setShortcutText (const TQString &)
virtual bool	isEnabled () const
virtual TQString	group () const
virtual TQString	whatsThis () const
virtual TQString	toolTip () const
virtual TQIconSet	iconSet (TDEIcon::Group group, int size=0) const
TQIconSet	iconSet () const
virtual TQString	icon () const
TDEActionCollection *	parentCollection () const
void	unplugAll ()
int	accel () const TDE_DEPRECATED
TQString	statusText () const
void	setAccel (int key) TDE_DEPRECATED
void	setStatusText (const TQString &text)
int	menuId (int i)

Protected Slots
void	itemSelected (const TQString &string)
void	menuAboutToShow ()
void	menuItemActivated (int id)
void	slotClicked ()
virtual void	slotActivated (int)
virtual void	slotActivated (const TQString &)
virtual void	slotActivated ()
Protected Slots inherited from TDESelectAction
virtual void	slotActivated (int id)
virtual void	slotActivated (const TQString &text)
virtual void	slotActivated ()
Protected Slots inherited from TDEAction
virtual void	slotDestroyed ()
virtual void	slotKeycodeChanged ()
virtual void	slotActivated ()
void	slotPopupActivated ()
void	slotButtonClicked (int, TQt::ButtonState state)

Protected Member Functions
virtual void	virtual_hook (int id, void *data)
Protected Member Functions inherited from TDESelectAction
virtual void	changeItem (int id, int index, const TQString &text)
TQStringList	comboItems () const
virtual void	updateCurrentItem (int id)
virtual void	updateComboWidth (int id)
virtual void	updateItems (int id)
virtual void	updateClear (int id)
Protected Member Functions inherited from TDEAction
TDEToolBar *	toolBar (int index) const
TQPopupMenu *	popupMenu (int index) const
void	removeContainer (int index)
int	findContainer (const TQWidget *widget) const
int	findContainer (int id) const
void	plugMainWindowAccel (TQWidget *w)
void	addContainer (TQWidget *parent, int id)
void	addContainer (TQWidget *parent, TQWidget *representative)
virtual void	updateShortcut (int i)
virtual void	updateShortcut (TQPopupMenu *menu, int id)
virtual void	updateGroup (int id)
virtual void	updateText (int i)
virtual void	updateEnabled (int i)
virtual void	updateIconSet (int i)
virtual void	updateIcon (int i)
virtual void	updateToolTip (int id)
virtual void	updateWhatsThis (int i)
TQString	whatsThisWithIcon () const
const KGuiItem &	guiItem () const

Additional Inherited Members
Public Types inherited from TDEAction
enum	ActivationReason {   UnknownActivation , EmulatedActivation , AccelActivation , PopupMenuActivation ,   ToolBarActivation }
Static Public Member Functions inherited from TDEAction
static int	getToolButtonID ()
Protected Attributes inherited from TDEAction
TDEActionCollection *	m_parentCollection

Detailed Description

Recent files action.

This class is an action to handle a recent files submenu. The best way to create the action is to use KStdAction::openRecent. Then you simply need to call loadEntries on startup, saveEntries on shutdown, addURL when your application loads/saves a file.

Author

Michael Koch

Definition at line 700 of file tdeactionclasses.h.

Constructor & Destructor Documentation

TDERecentFilesAction() [1/7]

TDERecentFilesAction::TDERecentFilesAction	(	const TQString &	text,
		const TDEShortcut &	cut,
		TQObject *	parent,
		const char *	name = 0,
		uint	maxItems = 10
	)

Parameters

text	The text that will be displayed.
cut	The corresponding keyboard accelerator (shortcut).
parent	This action's parent.
name	An internal name for this action.
maxItems	The maximum number of files to display

Definition at line 947 of file tdeactionclasses.cpp.

TDERecentFilesAction() [2/7]

TDERecentFilesAction::TDERecentFilesAction	(	const TQString &	text,
		const TDEShortcut &	cut,
		const TQObject *	receiver,
		const char *	slot,
		TQObject *	parent,
		const char *	name = 0,
		uint	maxItems = 10
	)

Parameters

text	The text that will be displayed.
cut	The corresponding keyboard accelerator (shortcut).
receiver	The slot's parent.
slot	The slot to invoke when a URL is selected. Its signature is of the form slotURLSelected( const KURL & ).
parent	This action's parent.
name	An internal name for this action.
maxItems	The maximum number of files to display

Definition at line 959 of file tdeactionclasses.cpp.

TDERecentFilesAction() [3/7]

TDERecentFilesAction::TDERecentFilesAction	(	const TQString &	text,
		const TQIconSet &	pix,
		const TDEShortcut &	cut,
		TQObject *	parent,
		const char *	name = 0,
		uint	maxItems = 10
	)

Parameters

text	The text that will be displayed.
pix	The icons that go with this action.
cut	The corresponding keyboard accelerator (shortcut).
parent	This action's parent.
name	An internal name for this action.
maxItems	The maximum number of files to display

Definition at line 977 of file tdeactionclasses.cpp.

TDERecentFilesAction() [4/7]

TDERecentFilesAction::TDERecentFilesAction	(	const TQString &	text,
		const TQString &	pix,
		const TDEShortcut &	cut,
		TQObject *	parent,
		const char *	name = 0,
		uint	maxItems = 10
	)

Parameters

text	The text that will be displayed.
pix	The dynamically loaded icon that goes with this action.
cut	The corresponding keyboard accelerator (shortcut).
parent	This action's parent.
name	An internal name for this action.
maxItems	The maximum number of files to display

Definition at line 990 of file tdeactionclasses.cpp.

TDERecentFilesAction() [5/7]

TDERecentFilesAction::TDERecentFilesAction	(	const TQString &	text,
		const TQIconSet &	pix,
		const TDEShortcut &	cut,
		const TQObject *	receiver,
		const char *	slot,
		TQObject *	parent,
		const char *	name = 0,
		uint	maxItems = 10
	)

Parameters

text	The text that will be displayed.
pix	The icons that go with this action.
cut	The corresponding keyboard accelerator (shortcut).
receiver	The slot's parent.
slot	The slot to invoke when a URL is selected. Its signature is of the form slotURLSelected( const KURL & ).
parent	This action's parent.
name	An internal name for this action.
maxItems	The maximum number of files to display

Definition at line 1003 of file tdeactionclasses.cpp.

TDERecentFilesAction() [6/7]

TDERecentFilesAction::TDERecentFilesAction	(	const TQString &	text,
		const TQString &	pix,
		const TDEShortcut &	cut,
		const TQObject *	receiver,
		const char *	slot,
		TQObject *	parent,
		const char *	name = 0,
		uint	maxItems = 10
	)

Parameters

text	The text that will be displayed.
pix	The dynamically loaded icon that goes with this action.
cut	The corresponding keyboard accelerator (shortcut).
receiver	The slot's parent.
slot	The slot to invoke when a URL is selected. Its signature is of the form slotURLSelected( const KURL & ).
parent	This action's parent.
name	An internal name for this action.
maxItems	The maximum number of files to display

Definition at line 1022 of file tdeactionclasses.cpp.

TDERecentFilesAction() [7/7]

TDERecentFilesAction::TDERecentFilesAction	(	TQObject *	parent = 0,
		const char *	name = 0,
		uint	maxItems = 10
	)

Parameters

parent	This action's parent.
name	An internal name for this action.
maxItems	The maximum number of files to display

Definition at line 1041 of file tdeactionclasses.cpp.

~TDERecentFilesAction()

TDERecentFilesAction::~TDERecentFilesAction ( )

virtual

Destructor.

Definition at line 1063 of file tdeactionclasses.cpp.

Member Function Documentation

addURL [1/2]

void TDERecentFilesAction::addURL ( const KURL &  url )

slot

Add URL to recent files list.

Parameters

url	The URL of the file

Definition at line 1097 of file tdeactionclasses.cpp.

addURL [2/2]

void TDERecentFilesAction::addURL ( const KURL &  url, const TQString &  name  )

slot

Add URL to recent files list.

Parameters

url	The URL of the file
name	The user visible pretty name that appears before the URL

Since

3.5

Definition at line 1102 of file tdeactionclasses.cpp.

clearURLList

void TDERecentFilesAction::clearURLList ( )

slot

Removes all entries from the recent files list.

Definition at line 1160 of file tdeactionclasses.cpp.

completeItems()

TQStringList TDERecentFilesAction::completeItems

(

)

const

Returns

the items that can be selected with this action. The returned items contain the pretty name that can be set by addURL.

Since

3.5

Definition at line 1344 of file tdeactionclasses.cpp.

items()

TQStringList TDERecentFilesAction::items ( ) const

virtual

Returns

the items that can be selected with this action. The returned items do not contain the pretty name that can be set by addURL, matching the pre-3.5 behavior.

Reimplemented from TDESelectAction.

Definition at line 1330 of file tdeactionclasses.cpp.

loadEntries

void TDERecentFilesAction::loadEntries ( TDEConfig *  config, TQString  groupname = TQString::null  )

slot

Loads the recent files entries from a given TDEConfig object.

You can provide the name of the group used to load the entries. If the groupname is empty, entries are load from a group called 'RecentFiles'

This method does not effect the active group of TDEConfig.

Definition at line 1167 of file tdeactionclasses.cpp.

maxItems()

uint TDERecentFilesAction::maxItems

(

)

const

Returns the maximum of items in the recent files list.

Definition at line 1069 of file tdeactionclasses.cpp.

plug()

int TDERecentFilesAction::plug ( TQWidget *  widget, int  index = -1  )

virtual

"Plug" or insert this action into a given widget.

This will typically be a menu or a toolbar. From this point on, you will never need to directly manipulate the item in the menu or toolbar. You do all enabling/disabling/manipulation directly with your TDESelectAction object.

Parameters

widget	The GUI element to display this action.
index	The index of the item.

Reimplemented from TDESelectAction.

Definition at line 1269 of file tdeactionclasses.cpp.

removeURL

void TDERecentFilesAction::removeURL ( const KURL &  url )

slot

Remove an URL from the recent files list.

Parameters

url	The URL of the file

Definition at line 1140 of file tdeactionclasses.cpp.

saveEntries

void TDERecentFilesAction::saveEntries ( TDEConfig *  config, TQString  groupname = TQString::null  )

slot

Saves the current recent files entries to a given TDEConfig object.

You can provide the name of the group used to load the entries. If the groupname is empty, entries are saved to a group called 'RecentFiles'

This method does not effect the active group of TDEConfig.

Definition at line 1212 of file tdeactionclasses.cpp.

setMaxItems

void TDERecentFilesAction::setMaxItems ( uint  maxItems )

slot

Sets the maximum of items in the recent files list.

The default for this value is 10 set in the constructor.

If this value is lesser than the number of items currently in the recent files list the last items are deleted until the number of items are equal to the new maximum.

Definition at line 1074 of file tdeactionclasses.cpp.

urlSelected

void TDERecentFilesAction::urlSelected ( const KURL &  url )

signal

This signal gets emited when the user selects an URL.

Parameters

url	The URL thats the user selected.

---

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

• tdeactionclasses.h
• tdeactionclasses.cpp