• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.2 API Reference
  • KDE Home
  • Contact Us
 

KFile

Public Slots | Signals | Public Member Functions | Protected Slots
KNewFileMenu Class Reference

#include <knewfilemenu.h>

Inheritance diagram for KNewFileMenu:
KActionMenu KAction QAction QWidgetAction

List of all members.

Public Slots

void checkUpToDate ()
void createDirectory ()

Signals

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

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 ~KAction ()
virtual ~KActionMenu ()
void addAction (QAction *action)
QAction * addSeparator ()
KAuth::Action * authAction () const
virtual QWidget * createWidget (QWidget *parent)
bool delayed () const
bool event (QEvent *)
void forgetGlobalShortcut ()
const KShortcut & globalShortcut (ShortcutTypes type=ActiveShortcut) const
bool globalShortcutAllowed () const
void insertAction (QAction *before, QAction *action)
QAction * insertSeparator (QAction *before)
bool isGlobalShortcutEnabled () const
bool isShortcutConfigurable () const
 KAction (QObject *parent)
 KAction (const QString &text, QObject *parent)
 KAction (const KIcon &icon, const QString &text, QObject *parent)
KMenu * menu ()
KMenu * popupMenu ()
void remove (KAction *)
void removeAction (QAction *action)
KRockerGesture rockerGesture (ShortcutTypes type=ActiveShortcut) const
void setAuthAction (const QString &actionName)
void setAuthAction (KAuth::Action *action)
void setDelayed (bool delayed)
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 setMenu (KMenu *menu)
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))
void setStickyMenu (bool sticky)
KShapeGesture shapeGesture (ShortcutTypes type=ActiveShortcut) const
KShortcut shortcut (ShortcutTypes types=ActiveShortcut) const
bool stickyMenu () const

Protected Slots

virtual void slotResult (KJob *job)

Additional Inherited Members

- Public Types inherited from KActionMenu
enum  GlobalShortcutLoading
enum  ShortcutType
- Public Types inherited from KAction
- Public Attributes inherited from KActionMenu
 ActiveShortcut
 Autoloading
 DefaultShortcut
 NoAutoloading
- Public Attributes inherited from KAction
- Properties inherited from KActionMenu
bool delayed
KShortcut globalShortcut
bool globalShortcutAllowed
bool globalShortcutEnabled
KShortcut shortcut
bool shortcutConfigurable
bool stickyMenu
- Properties inherited from KAction

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:
collectionthe KActionCollection this KAction should be added to.
nameaction name, when adding the action to the collection
parentthe 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 965 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 982 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 988 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 1018 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 1063 of file knewfilemenu.cpp.

KUrl::List KNewFileMenu::popupFiles ( ) const

Returns the files that the popup is shown for.

Definition at line 1068 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 1073 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 1097 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 1078 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 1102 of file knewfilemenu.cpp.

void KNewFileMenu::setViewShowsHiddenFiles ( bool  b)

Set if the directory view currently shows dot files.

Definition at line 1107 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 1112 of file knewfilemenu.cpp.

QStringList KNewFileMenu::supportedMimeTypes ( ) const

Returns the mimetypes set in supportedMimeTypes()

Definition at line 1142 of file knewfilemenu.cpp.


The documentation for this class was generated from the following files:
  • knewfilemenu.h
  • knewfilemenu.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sun Apr 28 2013 14:32:20 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KFile

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

kdelibs-4.10.2 API Reference

Skip menu "kdelibs-4.10.2 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal