• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KShortcutsEditor Class Reference

#include <kshortcutseditor.h>

Inheritance diagram for KShortcutsEditor:

Inheritance graph
[legend]

List of all members.


Detailed Description

Widget for configuration of KAccel and KGlobalAccel.

Configure dictionaries of key/action associations for KActions, including global shortcuts.

The class takes care of all aspects of configuration, including handling key conflicts internally. Connect to the allDefault() slot if you want to set all configurable shortcuts to their default values.

See also:
KShortcutsDialog
Author:
Nicolas Hadacek <hadacek@via.ecp.fr>

Hamish Rodda <rodda@kde.org> (KDE 4 porting)

Michael Jansen <kde@michael-jansen.biz>

Definition at line 59 of file kshortcutseditor.h.


Public Types

enum  ActionType {
  WidgetAction = Qt::WidgetShortcut, WindowAction = Qt::WindowShortcut, ApplicationAction = Qt::ApplicationShortcut, GlobalAction = 4,
  AllActions = 0xffffffff
}
enum  LetterShortcuts { LetterShortcutsDisallowed = 0, LetterShortcutsAllowed }

Public Slots

void allDefault ()
void printShortcuts () const
void resizeColumns ()

Signals

void keyChange ()

Public Member Functions

void addCollection (KActionCollection *, const QString &title=QString())
void clearCollections ()
void exportConfiguration (KConfig *config) const
void importConfiguration (KConfig *config)
bool isModified () const
 KShortcutsEditor (QWidget *parent, ActionTypes actionTypes=AllActions, LetterShortcuts allowLetterShortcuts=LetterShortcutsAllowed)
 KShortcutsEditor (KActionCollection *collection, QWidget *parent, ActionTypes actionTypes=AllActions, LetterShortcuts allowLetterShortcuts=LetterShortcutsAllowed)
void save ()
void undoChanges ()
void writeConfiguration (KConfigGroup *config=0) const
virtual ~KShortcutsEditor ()

Member Enumeration Documentation

enum KShortcutsEditor::ActionType

Enumerator:
WidgetAction  Actions which are triggered by any keypress in a widget which has the action added to it.
WindowAction  Actions which are triggered by any keypress in a window which has the action added to it or its child widget(s).
ApplicationAction  Actions which are triggered by any keypress in the application.
GlobalAction  Actions which are triggered by any keypress in the windowing system.
AllActions  All actions.

Definition at line 64 of file kshortcutseditor.h.

enum KShortcutsEditor::LetterShortcuts

Enumerator:
LetterShortcutsDisallowed  Shortcuts without a modifier are not allowed, so 'A' would not be valid, whereas 'Ctrl+A' would be.

This only applies to printable characters, however. 'F1', 'Insert' etc. could still be used.

LetterShortcutsAllowed  Letter shortcuts are allowed.

Definition at line 78 of file kshortcutseditor.h.


Constructor & Destructor Documentation

KShortcutsEditor::KShortcutsEditor ( KActionCollection *  collection,
QWidget *  parent,
ActionTypes  actionTypes = AllActions,
LetterShortcuts  allowLetterShortcuts = LetterShortcutsAllowed 
)

Constructor.

Parameters:
collection the KActionCollection to configure
parent parent widget
actionTypes types of actions to display in this widget.
allowLetterShortcuts set to LetterShortcutsDisallowed if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.

Definition at line 51 of file kshortcutseditor.cpp.

KShortcutsEditor::KShortcutsEditor ( QWidget *  parent,
ActionTypes  actionTypes = AllActions,
LetterShortcuts  allowLetterShortcuts = LetterShortcutsAllowed 
) [explicit]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Creates a key chooser without a starting action collection.

Parameters:
parent parent widget
actionTypes types of actions to display in this widget.
allowLetterShortcuts set to LetterShortcutsDisallowed if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.

Definition at line 61 of file kshortcutseditor.cpp.

KShortcutsEditor::~KShortcutsEditor (  )  [virtual]

Destructor.

Definition at line 69 of file kshortcutseditor.cpp.


Member Function Documentation

void KShortcutsEditor::addCollection ( KActionCollection *  collection,
const QString &  title = QString() 
)

Insert an action collection, i.e.

add all its actions to the ones already associated with the KShortcutsEditor object.

Parameters:
title subtree title of this collection of shortcut.

Definition at line 96 of file kshortcutseditor.cpp.

void KShortcutsEditor::allDefault (  )  [slot]

Set all shortcuts to their default values (bindings).

Definition at line 227 of file kshortcutseditor.cpp.

void KShortcutsEditor::clearCollections (  ) 

Removes all action collections from the editor.

Definition at line 88 of file kshortcutseditor.cpp.

void KShortcutsEditor::exportConfiguration ( KConfig *  config  )  const

Export the current setting to configuration config.

This initializes the configuration object. This will export the global configuration too.

Parameters:
config Config object

Definition at line 159 of file kshortcutseditor.cpp.

void KShortcutsEditor::importConfiguration ( KConfig *  config  ) 

Import the settings from configuration config.

This will remove all current setting before importing. All shortcuts are set to KShortcut() prior to importing from config!

Parameters:
config Config object

Definition at line 141 of file kshortcutseditor.cpp.

bool KShortcutsEditor::isModified (  )  const

Are the unsaved changes?

Definition at line 75 of file kshortcutseditor.cpp.

void KShortcutsEditor::keyChange (  )  [signal]

Emitted when an action's shortcut has been changed.

void KShortcutsEditor::printShortcuts (  )  const [slot]

Opens a printing dialog to print all the shortcuts.

Definition at line 233 of file kshortcutseditor.cpp.

void KShortcutsEditor::resizeColumns (  )  [slot]

Resize colums to width required.

Definition at line 187 of file kshortcutseditor.cpp.

void KShortcutsEditor::save (  ) 

Save the changes.

Well this function doesn't save actually for global shortcuts. It makes sure the editor doesn't undo all changes when it is deleted.

This saves the actions to disk. Any KActionCollection objects with the xmlFile() value set will be written to an XML file. All other will be written to the application's rc file.

Definition at line 194 of file kshortcutseditor.cpp.

void KShortcutsEditor::undoChanges (  ) 

Undo all change made since the last save().

Definition at line 210 of file kshortcutseditor.cpp.

void KShortcutsEditor::writeConfiguration ( KConfigGroup *  config = 0  )  const

Write the current settings to the config object.

This does not initialize the config object. It adds the configuration.

Note:
this will not save the global configuration! globalaccel holds that part of the configuration.
See also:
writeGlobalConfig()
Parameters:
config Config object to save to or, or null to use the applications config object

Definition at line 178 of file kshortcutseditor.cpp.


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

KDEUI

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal