KNewFileMenu Class Reference

#include <knewfilemenu.h>

Inheritance diagram for KNewFileMenu:

Public Slots
void	checkUpToDate ()
void	createDirectory ()

Signals
void	directoryCreated (const KUrl &url)
void	fileCreated (const KUrl &url)
Signals inherited from KAction
void	authorized (KAuth::Action *action)
void	globalShortcutChanged (const QKeySequence &)
void	triggered (Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)

Public Member Functions
	KNewFileMenu (KActionCollection *collection, const QString &name, QObject *parent)
virtual	~KNewFileMenu ()
bool	isModal () const
KUrl::List	popupFiles () const
void	setModal (bool modality)
void	setParentWidget (QWidget *parentWidget)
void	setPopupFiles (const KUrl::List &files)
void	setSupportedMimeTypes (const QStringList &mime)
void	setViewShowsHiddenFiles (bool b)
QStringList	supportedMimeTypes () const
Public Member Functions inherited from KActionMenu
	KActionMenu (QObject *parent)
	KActionMenu (const QString &text, QObject *parent)
	KActionMenu (const KIcon &icon, const QString &text, QObject *parent)
virtual	~KActionMenu ()
void	addAction (QAction *action)
QAction *	addSeparator ()
virtual QWidget *	createWidget (QWidget *parent)
bool	delayed () const
void	insertAction (QAction *before, QAction *action)
QAction *	insertSeparator (QAction *before)
KMenu *	menu ()
KMenu *	popupMenu ()
void	remove (KAction *)
void	removeAction (QAction *action)
void	setDelayed (bool delayed)
void	setMenu (KMenu *menu)
void	setStickyMenu (bool sticky)
bool	stickyMenu () const
Public Member Functions inherited from KAction
	KAction (QObject *parent)
	KAction (const QString &text, QObject *parent)
	KAction (const KIcon &icon, const QString &text, QObject *parent)
virtual	~KAction ()
KAuth::Action *	authAction () const
bool	event (QEvent *)
void	forgetGlobalShortcut ()
const KShortcut &	globalShortcut (ShortcutTypes type=ActiveShortcut) const
bool	globalShortcutAllowed () const
bool	isGlobalShortcutEnabled () const
bool	isShortcutConfigurable () const
KRockerGesture	rockerGesture (ShortcutTypes type=ActiveShortcut) const
void	setAuthAction (KAuth::Action *action)
void	setAuthAction (const QString &actionName)
void	setGlobalShortcut (const KShortcut &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut), GlobalShortcutLoading loading=Autoloading)
void	setGlobalShortcutAllowed (bool allowed, GlobalShortcutLoading loading=Autoloading)
void	setHelpText (const QString &text)
void	setRockerGesture (const KRockerGesture &gest, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
void	setShapeGesture (const KShapeGesture &gest, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
void	setShortcut (const KShortcut &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
void	setShortcut (const QKeySequence &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
void	setShortcutConfigurable (bool configurable)
void	setShortcuts (const QList< QKeySequence > &shortcuts, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
KShapeGesture	shapeGesture (ShortcutTypes type=ActiveShortcut) const
KShortcut	shortcut (ShortcutTypes types=ActiveShortcut) const

Protected Slots
virtual void	slotResult (KJob *job)

Additional Inherited Members
Public Types inherited from KAction
enum	GlobalShortcutLoading
enum	ShortcutType
Properties inherited from KActionMenu
bool	delayed
bool	stickyMenu
Properties inherited from KAction
KShortcut	globalShortcut
bool	globalShortcutAllowed
bool	globalShortcutEnabled
KShortcut	shortcut
bool	shortcutConfigurable

Detailed Description

The 'Create New' submenu, for creating files using templates (e.g.

"new HTML file") and directories.

The same instance can be used by both for the File menu and the RMB popup menu, in a file manager. This is also used in the file dialog's RMB menu.

To use this class, you need to connect aboutToShow() of the File menu with slotCheckUpToDate() and to call slotCheckUpToDate() before showing the RMB popupmenu.

KNewFileMenu automatically updates the list of templates shown if installed templates are added/updated/deleted.

Author

Björn Ruberg bjoer.nosp@m.n@ru.nosp@m.berg-.nosp@m.wege.nosp@m.ner.d.nosp@m.e Made dialogs working asynchronously

David Faure faure.nosp@m.@kde.nosp@m..org Ideas and code for the new template handling mechanism ('link' desktop files) from Christoph Pickart picka.nosp@m.rt@i.nosp@m.am.un.nosp@m.i-bo.nosp@m.nn.de

Since

4.5

Definition at line 54 of file knewfilemenu.h.

Constructor & Destructor Documentation

KNewFileMenu::KNewFileMenu	(	KActionCollection *	collection,
		const QString &	name,
		QObject *	parent
	)

Constructor.

Parameters

collection	the KActionCollection this KAction should be added to.
name	action name, when adding the action to the collection
parent	the parent object, for ownership. If the parent object is a widget, it will also used as parent widget for any dialogs that this class might show. Otherwise, call setParentWidget.

Definition at line 967 of file knewfilemenu.cpp.

KNewFileMenu::~KNewFileMenu ( )

virtual

Destructor.

KNewMenu uses internally a globally shared cache, so that multiple instances of it don't need to parse the installed templates multiple times. Therefore you can safely create and delete KNewMenu instances without a performance issue.

Definition at line 984 of file knewfilemenu.cpp.

Member Function Documentation

void KNewFileMenu::checkUpToDate ( )

slot

Checks if updating the list is necessary IMPORTANT : Call this in the slot for aboutToShow.

And while you're there, you probably want to call setViewShowsHiddenFiles ;)

Definition at line 990 of file knewfilemenu.cpp.

void KNewFileMenu::createDirectory ( )

slot

Call this to create a new directory as if the user had done it using a popupmenu.

This is useful to make sure that creating a directory with a key shortcut (e.g. F10) triggers the exact same code as when using the New menu. Requirements: call setPopupFiles first, and keep this KNewFileMenu instance alive (the mkdir is async).

Definition at line 1020 of file knewfilemenu.cpp.

void KNewFileMenu::directoryCreated ( const KUrl &  url )

signal

Emitted once the directory url has been successfully created.

void KNewFileMenu::fileCreated ( const KUrl &  url )

signal

Emitted once the file (or symlink) url has been successfully created.

bool KNewFileMenu::isModal

(

)

const

Returns the modality of dialogs.

Definition at line 1065 of file knewfilemenu.cpp.

KUrl::List KNewFileMenu::popupFiles

(

)

const

Returns the files that the popup is shown for.

Definition at line 1070 of file knewfilemenu.cpp.

void KNewFileMenu::setModal

(

bool

modality

)

Sets the modality of dialogs created by KNewFile.

Set to false if you do not want to block your application window when entering a new directory name i.e.

Definition at line 1075 of file knewfilemenu.cpp.

void KNewFileMenu::setParentWidget

(

QWidget *

parentWidget

)

Sets a parent widget for the dialogs shown by KNewFileMenu.

This is strongly recommended, for apps with a main window.

Definition at line 1099 of file knewfilemenu.cpp.

void KNewFileMenu::setPopupFiles

(

const KUrl::List &

files

)

Set the files the popup is shown for Call this before showing up the menu.

Definition at line 1080 of file knewfilemenu.cpp.

void KNewFileMenu::setSupportedMimeTypes

(

const QStringList &

mime

)

Only show the files in a given set of mimetypes.

This is useful in specialized applications (while file managers, on the other hand, want to show all mimetypes).

Definition at line 1104 of file knewfilemenu.cpp.

void KNewFileMenu::setViewShowsHiddenFiles

(

bool

b

)

Set if the directory view currently shows dot files.

Definition at line 1109 of file knewfilemenu.cpp.

void KNewFileMenu::slotResult ( KJob *  job )

protectedvirtualslot

Called when the job that copied the template has finished.

This method is virtual so that error handling can be reimplemented. Make sure to call the base class slotResult when !job->error() though.

Definition at line 1114 of file knewfilemenu.cpp.

QStringList KNewFileMenu::supportedMimeTypes

(

)

const

Returns the mimetypes set in supportedMimeTypes()

Definition at line 1144 of file knewfilemenu.cpp.

---

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

• knewfilemenu.h
• knewfilemenu.cpp