Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KRecentFilesAction Class Reference

Recent files action. More...

#include <kaction.h>

Inheritance diagram for KRecentFilesAction:

KListAction KSelectAction KAction List of all members.

Public Slots

void setMaxItems (uint maxItems)
void loadEntries (KConfig *config, QString groupname=QString::null)
void saveEntries (KConfig *config, QString groupname=QString::null)
void addURL (const KURL &url)
void removeURL (const KURL &url)
void clearURLList ()

Signals

void urlSelected (const KURL &url)

Public Methods

 KRecentFilesAction (const QString &text, const KShortcut &cut, QObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (const QString &text, const KShortcut &cut, const QObject *receiver, const char *slot, QObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (const QString &text, const QIconSet &pix, const KShortcut &cut, QObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (const QString &text, const QString &pix, const KShortcut &cut, QObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (const QString &text, const QIconSet &pix, const KShortcut &cut, const QObject *receiver, const char *slot, QObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (const QString &text, const QString &pix, const KShortcut &cut, const QObject *receiver, const char *slot, QObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (QObject *parent=0, const char *name=0, uint maxItems=10)
virtual ~KRecentFilesAction ()
uint maxItems () const

Protected Methods

virtual void virtual_hook (int id, void *data)

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 1188 of file kaction.h.

Constructor & Destructor Documentation

KRecentFilesAction::KRecentFilesAction (  const QString &    text,
const KShortcut &    cut,
QObject *    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

KRecentFilesAction::KRecentFilesAction (  const QString &    text,
const KShortcut &    cut,
const QObject *    receiver,
const char *    slot,
QObject *    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

KRecentFilesAction::KRecentFilesAction (  const QString &    text,
const QIconSet &    pix,
const KShortcut &    cut,
QObject *    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

KRecentFilesAction::KRecentFilesAction (  const QString &    text,
const QString &    pix,
const KShortcut &    cut,
QObject *    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

KRecentFilesAction::KRecentFilesAction (  const QString &    text,
const QIconSet &    pix,
const KShortcut &    cut,
const QObject *    receiver,
const char *    slot,
QObject *    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

KRecentFilesAction::KRecentFilesAction (  const QString &    text,
const QString &    pix,
const KShortcut &    cut,
const QObject *    receiver,
const char *    slot,
QObject *    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

KRecentFilesAction::KRecentFilesAction (  QObject *    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

virtual KRecentFilesAction::~KRecentFilesAction (    )  [virtual]
 

Destructor.

Member Function Documentation

void KRecentFilesAction::addURL (  const KURL &    url )  [slot]
 

Add URL to recent files list.

Parameters:
url  The URL of the file

void KRecentFilesAction::clearURLList (    )  [slot]
 

Removes all entries from the recent files list.

void KRecentFilesAction::loadEntries (  KConfig *    config,
QString    groupname = QString::null
)  [slot]
 

Loads the recent files entries from a given KConfig 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 KConfig.

uint KRecentFilesAction::maxItems (    ) 
 

Returns the maximum of items in the recent files list.

void KRecentFilesAction::removeURL (  const KURL &    url )  [slot]
 

Remove an URL from the recent files list.

Parameters:
url  The URL of the file

void KRecentFilesAction::saveEntries (  KConfig *    config,
QString    groupname = QString::null
)  [slot]
 

Saves the current recent files entries to a given KConfig 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 KConfig.

void KRecentFilesAction::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.

void KRecentFilesAction::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 file:
Generated on Wed Aug 13 23:30:22 2003 for kdelibs by doxygen1.2.18