• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdeui
 

kdeui

Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Properties
KRecentFilesAction Class Reference

#include <kactionclasses.h>

Inheritance diagram for KRecentFilesAction:
KListAction KSelectAction KAction

List of all members.

Public Slots

void setMaxItems (uint maxItems)
void loadEntries (KConfig *config, TQString groupname=TQString::null)
void saveEntries (KConfig *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 ()

Signals

void urlSelected (const KURL &url)

Public Member Functions

 KRecentFilesAction (const TQString &text, const KShortcut &cut, TQObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (const TQString &text, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut, TQObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (const TQString &text, const TQString &pix, const KShortcut &cut, TQObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (const TQString &text, const TQString &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0, uint maxItems=10)
 KRecentFilesAction (TQObject *parent=0, const char *name=0, uint maxItems=10)
virtual ~KRecentFilesAction ()
virtual int plug (TQWidget *widget, int index=-1)
uint maxItems () const
virtual TQStringList items () const
TQStringList completeItems () const

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 Member Functions

virtual void virtual_hook (int id, void *data)

Properties

uint maxItems

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 kactionclasses.h.


Constructor & Destructor Documentation

KRecentFilesAction::KRecentFilesAction ( const TQString &  text,
const KShortcut &  cut,
TQObject *  parent,
const char *  name = 0,
uint  maxItems = 10 
)
Parameters:
textThe text that will be displayed.
cutThe corresponding keyboard accelerator (shortcut).
parentThis action's parent.
nameAn internal name for this action.
maxItemsThe maximum number of files to display

Definition at line 947 of file kactionclasses.cpp.

KRecentFilesAction::KRecentFilesAction ( const TQString &  text,
const KShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
TQObject *  parent,
const char *  name = 0,
uint  maxItems = 10 
)
Parameters:
textThe text that will be displayed.
cutThe corresponding keyboard accelerator (shortcut).
receiverThe SLOT's parent.
slotThe TQT_SLOT to invoke when a URL is selected. Its signature is of the form slotURLSelected( const KURL & ).
parentThis action's parent.
nameAn internal name for this action.
maxItemsThe maximum number of files to display

Definition at line 959 of file kactionclasses.cpp.

KRecentFilesAction::KRecentFilesAction ( const TQString &  text,
const TQIconSet &  pix,
const KShortcut &  cut,
TQObject *  parent,
const char *  name = 0,
uint  maxItems = 10 
)
Parameters:
textThe text that will be displayed.
pixThe icons that go with this action.
cutThe corresponding keyboard accelerator (shortcut).
parentThis action's parent.
nameAn internal name for this action.
maxItemsThe maximum number of files to display

Definition at line 977 of file kactionclasses.cpp.

KRecentFilesAction::KRecentFilesAction ( const TQString &  text,
const TQString &  pix,
const KShortcut &  cut,
TQObject *  parent,
const char *  name = 0,
uint  maxItems = 10 
)
Parameters:
textThe text that will be displayed.
pixThe dynamically loaded icon that goes with this action.
cutThe corresponding keyboard accelerator (shortcut).
parentThis action's parent.
nameAn internal name for this action.
maxItemsThe maximum number of files to display

Definition at line 990 of file kactionclasses.cpp.

KRecentFilesAction::KRecentFilesAction ( const TQString &  text,
const TQIconSet &  pix,
const KShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
TQObject *  parent,
const char *  name = 0,
uint  maxItems = 10 
)
Parameters:
textThe text that will be displayed.
pixThe icons that go with this action.
cutThe corresponding keyboard accelerator (shortcut).
receiverThe SLOT's parent.
slotThe TQT_SLOT to invoke when a URL is selected. Its signature is of the form slotURLSelected( const KURL & ).
parentThis action's parent.
nameAn internal name for this action.
maxItemsThe maximum number of files to display

Definition at line 1003 of file kactionclasses.cpp.

KRecentFilesAction::KRecentFilesAction ( const TQString &  text,
const TQString &  pix,
const KShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
TQObject *  parent,
const char *  name = 0,
uint  maxItems = 10 
)
Parameters:
textThe text that will be displayed.
pixThe dynamically loaded icon that goes with this action.
cutThe corresponding keyboard accelerator (shortcut).
receiverThe SLOT's parent.
slotThe TQT_SLOT to invoke when a URL is selected. Its signature is of the form slotURLSelected( const KURL & ).
parentThis action's parent.
nameAn internal name for this action.
maxItemsThe maximum number of files to display

Definition at line 1022 of file kactionclasses.cpp.

KRecentFilesAction::KRecentFilesAction ( TQObject *  parent = 0,
const char *  name = 0,
uint  maxItems = 10 
)
Parameters:
parentThis action's parent.
nameAn internal name for this action.
maxItemsThe maximum number of files to display

Definition at line 1041 of file kactionclasses.cpp.

KRecentFilesAction::~KRecentFilesAction ( ) [virtual]

Destructor.

Definition at line 1063 of file kactionclasses.cpp.


Member Function Documentation

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

Add URL to recent files list.

Parameters:
urlThe URL of the file

Definition at line 1097 of file kactionclasses.cpp.

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

Add URL to recent files list.

Parameters:
urlThe URL of the file
nameThe user visible pretty name that appears before the URL
Since:
3.5

Definition at line 1102 of file kactionclasses.cpp.

void KRecentFilesAction::clearURLList ( ) [slot]

Removes all entries from the recent files list.

Definition at line 1160 of file kactionclasses.cpp.

TQStringList KRecentFilesAction::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 kactionclasses.cpp.

TQStringList KRecentFilesAction::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 KSelectAction.

Definition at line 1330 of file kactionclasses.cpp.

void KRecentFilesAction::loadEntries ( KConfig *  config,
TQString  groupname = TQString::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.

Definition at line 1167 of file kactionclasses.cpp.

uint KRecentFilesAction::maxItems ( ) const

Returns the maximum of items in the recent files list.

int KRecentFilesAction::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 KSelectAction object.

Parameters:
widgetThe GUI element to display this action.
indexThe index of the item.

Reimplemented from KSelectAction.

Definition at line 1269 of file kactionclasses.cpp.

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

Remove an URL from the recent files list.

Parameters:
urlThe URL of the file

Definition at line 1140 of file kactionclasses.cpp.

void KRecentFilesAction::saveEntries ( KConfig *  config,
TQString  groupname = TQString::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.

Definition at line 1212 of file kactionclasses.cpp.

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.

Definition at line 1074 of file kactionclasses.cpp.

void KRecentFilesAction::urlSelected ( const KURL &  url) [signal]

This signal gets emited when the user selects an URL.

Parameters:
urlThe URL thats the user selected.

The documentation for this class was generated from the following files:
  • kactionclasses.h
  • kactionclasses.cpp

kdeui

Skip menu "kdeui"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdeui

Skip menu "kdeui"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdeui by doxygen 1.7.6.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |