org.kde.koala
Class KAccel

java.lang.Object
  extended by org.kde.qt.Qt
      extended by org.kde.qt.QObject
          extended by org.kde.qt.QAccel
              extended by org.kde.koala.KAccel
All Implemented Interfaces:
org.kde.qt.QtSupport

public class KAccel
extends org.kde.qt.QAccel

Handle shortcuts. Allow a user to configure shortcuts through application configuration files or through the KKeyChooser GUI. A KAccel contains a list of accelerator actions. For example, CTRL+Key_P could be a shortcut for printing a document. The key codes are listed in qnamespace.h. "Print" could be the action name for printing. The action name identifies the shortcut in configuration files and the KKeyChooser GUI. A KAccel object handles key events sent to its parent widget and to all children of this parent widget. The most recently created KAccel object has precedence over any KAccel objects created before it. When a shortcut pressed, KAccel calls the slot to which it has been connected. If you want to set global accelerators, independent of the window which has the focus, use KGlobalAccel. Reconfiguration of a given shortcut can be prevented by specifying that an accelerator item is not configurable when it is inserted. A special group of non-configurable key bindings are known as the standard accelerators. The standard accelerators appear repeatedly in applications for standard document actions such as printing and saving. A convenience method is available to insert and connect these accelerators which are configurable on a desktop-wide basis. It is possible for a user to choose to have no key associated with an action. The translated first argument for insertItem() is used only in the configuration dialog.

 KAccel pAccel = new KAccel( this );
 // Insert an action "Scroll Up" which is associated with the "Up" key:
 pAccel.insert( "Scroll Up", i18n("Scroll up"),
                       i18n("Scroll up the current document by one line."),
                       Qt.Key_Up, this, SLOT("slotScrollUp()") );
 // Insert an standard acclerator action.
 pAccel.insert( KStdAccel.Print, this, SLOT("slotPrint()") );
 // Update the shortcuts by read any user-defined settings from the
 // application's config file.
 pAccel.readSettings();
 
See KAccelSignals for signals emitted by KAccel

See Also:
KGlobalAccel, KAccelShortcutList, KKeyChooser, KKeyDialog

Field Summary
 
Fields inherited from class org.kde.qt.Qt
AlignAuto, AlignBottom, AlignCenter, AlignHCenter, AlignHorizontal_Mask, AlignJustify, AlignLeft, AlignRight, AlignTop, AlignVCenter, AlignVertical_Mask, AlphaDither_Mask, ALT, AltButton, AnchorHref, AnchorName, AndNotROP, AndROP, ArrowCursor, Ascending, ASCII_ACCEL, AutoColor, AutoDither, AutoText, AvoidDither, BDiagPattern, BeginsWith, BevelJoin, BitmapCursor, BlankCursor, Bottom, BottomLeft, BottomRight, BreakAnywhere, BusyCursor, CaseSensitive, ClearROP, ColorMode_Mask, ColorOnly, Contains, ControlButton, CopyROP, CrossCursor, CrossPattern, CTRL, CustomPattern, DashDotDotLine, DashDotLine, DashLine, Dense1Pattern, Dense2Pattern, Dense3Pattern, Dense4Pattern, Dense5Pattern, Dense6Pattern, Dense7Pattern, Descending, DiagCrossPattern, DiffuseAlphaDither, DiffuseDither, Dither_Mask, DitherMode_Mask, DockBottom, DockLeft, DockMinimized, DockRight, DockTop, DockTornOff, DockUnmanaged, DontClip, DontPrint, DotLine, DownArrow, EndsWith, EraseROP, ExactMatch, ExpandTabs, FDiagPattern, FixedColor, FixedPixmap, FlatCap, ForbiddenCursor, HiEnglishUnit, HiMetricUnit, Horizontal, HorPattern, IbeamCursor, Identical, IncludeTrailingSpaces, ISODate, Key_0, Key_1, Key_2, Key_3, Key_4, Key_5, Key_6, Key_7, Key_8, Key_9, Key_A, Key_aacute, Key_Aacute, Key_acircumflex, Key_Acircumflex, Key_acute, Key_adiaeresis, Key_Adiaeresis, Key_ae, Key_AE, Key_agrave, Key_Agrave, Key_Alt, Key_Ampersand, Key_Any, Key_Apostrophe, Key_aring, Key_Aring, Key_AsciiCircum, Key_AsciiTilde, Key_Asterisk, Key_At, Key_atilde, Key_Atilde, Key_B, Key_Back, Key_Backslash, Key_Backspace, Key_BackSpace, Key_Backtab, Key_BackTab, Key_Bar, Key_BassBoost, Key_BassDown, Key_BassUp, Key_BraceLeft, Key_BraceRight, Key_BracketLeft, Key_BracketRight, Key_brokenbar, Key_C, Key_CapsLock, Key_ccedilla, Key_Ccedilla, Key_cedilla, Key_cent, Key_Clear, Key_Colon, Key_Comma, Key_Control, Key_copyright, Key_currency, Key_D, Key_degree, Key_Delete, Key_diaeresis, Key_Direction_L, Key_Direction_R, Key_division, Key_Dollar, Key_Down, Key_E, Key_eacute, Key_Eacute, Key_ecircumflex, Key_Ecircumflex, Key_ediaeresis, Key_Ediaeresis, Key_egrave, Key_Egrave, Key_End, Key_Enter, Key_Equal, Key_Escape, Key_eth, Key_ETH, Key_Exclam, Key_exclamdown, Key_F, Key_F1, Key_F10, Key_F11, Key_F12, Key_F13, Key_F14, Key_F15, Key_F16, Key_F17, Key_F18, Key_F19, Key_F2, Key_F20, Key_F21, Key_F22, Key_F23, Key_F24, Key_F25, Key_F26, Key_F27, Key_F28, Key_F29, Key_F3, Key_F30, Key_F31, Key_F32, Key_F33, Key_F34, Key_F35, Key_F4, Key_F5, Key_F6, Key_F7, Key_F8, Key_F9, Key_Favorites, Key_Forward, Key_G, Key_Greater, Key_guillemotleft, Key_guillemotright, Key_H, Key_Help, Key_Home, Key_HomePage, Key_Hyper_L, Key_Hyper_R, Key_hyphen, Key_I, Key_iacute, Key_Iacute, Key_icircumflex, Key_Icircumflex, Key_idiaeresis, Key_Idiaeresis, Key_igrave, Key_Igrave, Key_Insert, Key_J, Key_K, Key_L, Key_Launch0, Key_Launch1, Key_Launch2, Key_Launch3, Key_Launch4, Key_Launch5, Key_Launch6, Key_Launch7, Key_Launch8, Key_Launch9, Key_LaunchA, Key_LaunchB, Key_LaunchC, Key_LaunchD, Key_LaunchE, Key_LaunchF, Key_LaunchMail, Key_LaunchMedia, Key_Left, Key_Less, Key_M, Key_macron, Key_masculine, Key_MediaLast, Key_MediaNext, Key_MediaPlay, Key_MediaPrev, Key_MediaRecord, Key_MediaStop, Key_Menu, Key_Meta, Key_Minus, Key_mu, Key_multiply, Key_N, Key_Next, Key_nobreakspace, Key_notsign, Key_ntilde, Key_Ntilde, Key_NumberSign, Key_NumLock, Key_O, Key_oacute, Key_Oacute, Key_ocircumflex, Key_Ocircumflex, Key_odiaeresis, Key_Odiaeresis, Key_ograve, Key_Ograve, Key_onehalf, Key_onequarter, Key_onesuperior, Key_Ooblique, Key_OpenUrl, Key_ordfeminine, Key_oslash, Key_otilde, Key_Otilde, Key_P, Key_PageDown, Key_PageUp, Key_paragraph, Key_ParenLeft, Key_ParenRight, Key_Pause, Key_Percent, Key_Period, Key_periodcentered, Key_Plus, Key_plusminus, Key_Print, Key_Prior, Key_Q, Key_Question, Key_questiondown, Key_QuoteDbl, Key_QuoteLeft, Key_R, Key_Refresh, Key_registered, Key_Return, Key_Right, Key_S, Key_ScrollLock, Key_Search, Key_section, Key_Semicolon, Key_Shift, Key_Slash, Key_Space, Key_ssharp, Key_Standby, Key_sterling, Key_Stop, Key_Super_L, Key_Super_R, Key_SysReq, Key_T, Key_Tab, Key_thorn, Key_THORN, Key_threequarters, Key_threesuperior, Key_TrebleDown, Key_TrebleUp, Key_twosuperior, Key_U, Key_uacute, Key_Uacute, Key_ucircumflex, Key_Ucircumflex, Key_udiaeresis, Key_Udiaeresis, Key_ugrave, Key_Ugrave, Key_Underscore, Key_unknown, Key_Up, Key_V, Key_VolumeDown, Key_VolumeMute, Key_VolumeUp, Key_W, Key_X, Key_Y, Key_yacute, Key_Yacute, Key_ydiaeresis, Key_yen, Key_Z, KeyButtonMask, Keypad, LastCursor, LastROP, Left, LeftArrow, LeftButton, LocalDate, LocalTime, LoEnglishUnit, LogText, LoMetricUnit, MacStyle, META, MetaButton, MidButton, Minimized, MiterJoin, MODIFIER_MASK, MonoOnly, MotifStyle, MouseButtonMask, MPenCapStyle, MPenJoinStyle, MPenStyle, MV_10_DOT_0, MV_10_DOT_1, MV_10_DOT_2, MV_10_DOT_3, MV_10_DOT_4, MV_9, MV_CHEETAH, MV_JAGUAR, MV_PANTHER, MV_PUMA, MV_TIGER, MV_Unknown, NandROP, NoAccel, NoAlpha, NoBackground, NoBrush, NoButton, NoMatch, NoPen, NopROP, NorROP, NotAndROP, NotCopyROP, NotEraseROP, NotOrROP, NotROP, NotXorROP, OpaqueMode, OrderedAlphaDither, OrderedDither, OrNotROP, OrROP, Overline, PaletteBackground, PaletteBase, PaletteBrightText, PaletteButton, PaletteButtonText, PaletteDark, PaletteForeground, PaletteHighlight, PaletteHighlightedText, PaletteLight, PaletteLink, PaletteLinkVisited, PaletteMid, PaletteMidlight, PaletteShadow, PaletteText, PartialMatch, PixelUnit, PlainText, PMStyle, PointingHandCursor, PreferDither, RichText, Right, RightArrow, RightButton, RoundCap, RoundJoin, SetROP, SHIFT, ShiftButton, ShowPrefix, SingleLine, SizeAllCursor, SizeBDiagCursor, SizeFDiagCursor, SizeHorCursor, SizeVerCursor, SolidLine, SolidPattern, SplitHCursor, SplitVCursor, SquareCap, StrikeOut, TextDate, ThresholdAlphaDither, ThresholdDither, Top, TopLeft, TopRight, TornOff, TransparentMode, TwipsUnit, UI_AnimateCombo, UI_AnimateMenu, UI_AnimateToolBox, UI_AnimateTooltip, UI_FadeMenu, UI_FadeTooltip, UI_General, Underline, UNICODE_ACCEL, Unmanaged, UpArrow, UpArrowCursor, UTC, VerPattern, Vertical, WaitCursor, WDestructiveClose, WGroupLeader, WhatsThisCursor, Win3Style, WindowActive, WindowFullScreen, WindowMaximized, WindowMinimized, WindowNoState, WindowsStyle, WMacDrawer, WMacNoSheet, WMouseNoMask, WNoAutoErase, WNoMousePropagation, WNorthWestGravity, WordBreak, WPaintClever, WPaintDesktop, WPaintUnclipped, WRepaintNoErase, WResizeNoErase, WShowModal, WState_AutoMask, WState_BlockUpdates, WState_CompressKeys, WState_ConfigPending, WState_Created, WState_CreatedHidden, WState_Disabled, WState_DND, WState_Exposed, WState_ForceDisabled, WState_ForceHide, WState_FullScreen, WState_HasMouse, WState_InPaintEvent, WState_Maximized, WState_Minimized, WState_MouseTracking, WState_OwnCursor, WState_OwnSizePolicy, WState_Polished, WState_Reparented, WState_Reserved0, WState_Resized, WState_Visible, WStaticContents, WStyle_ContextHelp, WStyle_Customize, WStyle_Dialog, WStyle_DialogBorder, WStyle_Mask, WStyle_Maximize, WStyle_Minimize, WStyle_MinMax, WStyle_NoBorder, WStyle_NoBorderEx, WStyle_NormalBorder, WStyle_Reserved, WStyle_Splash, WStyle_StaysOnTop, WStyle_SysMenu, WStyle_Title, WStyle_Tool, WSubWindow, WType_Desktop, WType_Dialog, WType_Mask, WType_Modal, WType_Popup, WType_TopLevel, WV_2000, WV_2003, WV_32s, WV_95, WV_98, WV_CE, WV_CE_based, WV_CENET, WV_DOS_based, WV_Me, WV_NT, WV_NT_based, WV_XP, WWinOwnDC, WX11BypassWM, X11ParentRelative, XorROP
 
Constructor Summary
protected KAccel(java.lang.Class dummy)
           
  KAccel(org.kde.qt.QWidget pParent)
           
  KAccel(org.kde.qt.QWidget watch, org.kde.qt.QObject parent)
           
  KAccel(org.kde.qt.QWidget watch, org.kde.qt.QObject parent, java.lang.String psName)
          Creates a new KAccel that watches watch.
  KAccel(org.kde.qt.QWidget pParent, java.lang.String psName)
          Creates a new KAccel that watches pParent, which is also the QObject's parent.
 
Method Summary
 KAccelActions actions()
          Returns the KAccel's KAccelActions, a list of KAccelAction.
 java.lang.String className()
           
 java.lang.String configGroup()
          Returns the configuration group of the settings.
 void dispose()
          Delete the wrapped C++ instance ahead of finalize()
 void emitKeycodeChanged()
          Emits the keycodeChanged() signal.
protected  void finalize()
          Deletes the wrapped C++ instance
 KAccelAction insert(int id, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot)
           
 KAccelAction insert(int id, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot, boolean bConfigurable)
           
 KAccelAction insert(int id, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot, boolean bConfigurable, boolean bEnabled)
          Similar to the first insert() method, but with the action name, short description, help text, and default shortcuts all set according to one of the standard accelerators.
 KAccelAction insert(java.lang.String psAction, KShortcut cutDef, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot)
           
 KAccelAction insert(java.lang.String psAction, KShortcut cutDef, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot, boolean bConfigurable)
           
 KAccelAction insert(java.lang.String psAction, KShortcut cutDef, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot, boolean bConfigurable, boolean bEnabled)
          This is an overloaded function provided for convenience.
 KAccelAction insert(java.lang.String sAction, java.lang.String sLabel, java.lang.String sWhatsThis, KShortcut cutDef3, KShortcut cutDef4, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot)
           
 KAccelAction insert(java.lang.String sAction, java.lang.String sLabel, java.lang.String sWhatsThis, KShortcut cutDef3, KShortcut cutDef4, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot, boolean bConfigurable)
           
 KAccelAction insert(java.lang.String sAction, java.lang.String sLabel, java.lang.String sWhatsThis, KShortcut cutDef3, KShortcut cutDef4, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot, boolean bConfigurable, boolean bEnabled)
          Same as first insert(), but with separate shortcuts defined for 3- and 4- modifier defaults.
 KAccelAction insert(java.lang.String sAction, java.lang.String sLabel, java.lang.String sWhatsThis, KShortcut cutDef, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot)
           
 KAccelAction insert(java.lang.String sAction, java.lang.String sLabel, java.lang.String sWhatsThis, KShortcut cutDef, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot, boolean bConfigurable)
           
 KAccelAction insert(java.lang.String sAction, java.lang.String sLabel, java.lang.String sWhatsThis, KShortcut cutDef, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot, boolean bConfigurable, boolean bEnabled)
          Create an accelerator action.
 boolean isDisposed()
          Has the wrapped C++ instance been deleted?
 boolean isEnabled()
          Checks whether the KAccel is active.
 org.kde.qt.QMetaObject metaObject()
           
 boolean readSettings()
           
 boolean readSettings(KConfigBase pConfig)
          Read all shortcuts from pConfig, or (if pConfig is zero) from the application's configuration file KGlobal.config().
 boolean remove(java.lang.String sAction)
          Removes the accelerator action identified by the name.
 boolean setAutoUpdate(boolean bAuto)
          Enable auto-update of connections.
 void setConfigGroup(java.lang.String name)
          Returns the configuration group of the settings.
 void setEnabled(boolean bEnabled)
          Enables or disables the KAccel.
 boolean setEnabled(java.lang.String sAction, boolean bEnabled)
          Enable or disable the action named by sAction.
 boolean setShortcut(java.lang.String sAction, KShortcut shortcut)
          Set the shortcut to be associated with the action named by sAction.
 boolean setSlot(java.lang.String sAction, org.kde.qt.QObject pObjSlot, java.lang.String psMethodSlot)
          Set the slot to be called when the shortcut of the action named by sAction is pressed.
 KShortcut shortcut(java.lang.String sAction)
          Return the shortcut associated with the action named by sAction.
 boolean updateConnections()
          Updates the connections of the accelerations after changing them.
 boolean writeSettings()
           
 boolean writeSettings(KConfigBase pConfig)
          Write the current shortcuts to pConfig, or (if pConfig is zero) to the application's configuration file.
 
Methods inherited from class org.kde.qt.QAccel
clear, connectItem, count, disconnectItem, eventFilter, findKey, ignoreWhatsThis, insertItem, insertItem, isItemEnabled, key, keyToString, removeItem, repairEventFilter, setIgnoreWhatsThis, setItemEnabled, setWhatsThis, shortcutKey, stringToKey, tr, tr, whatsThis
 
Methods inherited from class org.kde.qt.QObject
activate_filters, activate_signal_bool, activate_signal, activate_signal, activate_signal, activate_signal, blockSignals, checkConnectArgs, child, child, child, childEvent, children, connect, connect, connectInternal, connectNotify, customEvent, deleteLater, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnectInternal, disconnectNotify, dumpObjectInfo, dumpObjectTree, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, event, highPriority, i18n, inherits, insertChild, installEventFilter, isA, isWidgetType, killTimer, killTimers, name, name, normalizeSignalSlot, objectTrees, parent, property, queryList, queryList, queryList, queryList, queryList, registerUserData, removeChild, removeEventFilter, sender, setName, setProperty, signalsBlocked, startTimer, timerEvent
 
Methods inherited from class org.kde.qt.Qt
arrowCursor, bin, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, black, blankCursor, blue, color0, color1, copyBlt, copyBlt, copyBlt, copyBlt, copyBlt, crossCursor, cyan, darkBlue, darkCyan, darkGray, darkGreen, darkMagenta, darkRed, darkYellow, dec, dynamicCast, endl, flush, forbiddenCursor, fromUtf8, gray, green, hex, ibeamCursor, lightGray, magenta, oct, op_div, op_div, op_div, op_div, op_equals, op_equals, op_equals, op_equals, op_minus, op_minus, op_minus, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_not_equals, op_not_equals, op_not_equals, op_not_equals, op_plus, op_plus, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, pointingHandCursor, qAlpha, qApp, qAppName, qBlue, qCompress, qCompress, qDebug, qDebug, qDrawArrow, qDrawItem, qDrawItem, qDrawItem, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qFatal, qFatal, qGLVersion, qGray, qGray, qGreen, qInitNetworkProtocols, qInstallPath, qInstallPathBins, qInstallPathData, qInstallPathDocs, qInstallPathHeaders, qInstallPathLibs, qInstallPathPlugins, qInstallPathSysconf, qInstallPathTranslations, qItemRect, qItemRect, qObsolete, qObsolete, qObsolete, qRed, qRgb, qRgba, qRound, qSharedBuild, qSuppressObsoleteWarnings, qSuppressObsoleteWarnings, qSysInfo, qSystemWarning, qSystemWarning, qUncompress, qUncompress, qVersion, qWarning, qWarning, red, reset, SIGNAL, sizeAllCursor, sizeBDiagCursor, sizeFDiagCursor, sizeHorCursor, sizeVerCursor, SLOT, splitHCursor, splitVCursor, upArrowCursor, waitCursor, whatsThisCursor, white, ws, yellow
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KAccel

protected KAccel(java.lang.Class dummy)

KAccel

public KAccel(org.kde.qt.QWidget pParent,
              java.lang.String psName)
Creates a new KAccel that watches pParent, which is also the QObject's parent.

Parameters:
pParent - the parent and widget to watch for key strokes
psName - the name of the QObject

KAccel

public KAccel(org.kde.qt.QWidget pParent)

KAccel

public KAccel(org.kde.qt.QWidget watch,
              org.kde.qt.QObject parent,
              java.lang.String psName)
Creates a new KAccel that watches watch.

Parameters:
watch - the widget to watch for key strokes
parent - the parent of the QObject
psName - the name of the QObject

KAccel

public KAccel(org.kde.qt.QWidget watch,
              org.kde.qt.QObject parent)
Method Detail

metaObject

public org.kde.qt.QMetaObject metaObject()
Overrides:
metaObject in class org.kde.qt.QAccel

className

public java.lang.String className()
Overrides:
className in class org.kde.qt.QAccel

actions

public KAccelActions actions()
Returns the KAccel's KAccelActions, a list of KAccelAction.

Returns:
the KAccelActions of the KAccel

isEnabled

public boolean isEnabled()
Checks whether the KAccel is active.

Overrides:
isEnabled in class org.kde.qt.QAccel
Returns:
true if the QAccel is enabled

setEnabled

public void setEnabled(boolean bEnabled)
Enables or disables the KAccel.

Overrides:
setEnabled in class org.kde.qt.QAccel
Parameters:
bEnabled - true to enable, false to disable

setAutoUpdate

public boolean setAutoUpdate(boolean bAuto)
Enable auto-update of connections. This means that the signals are automatically disconnected when you disable an action, and re-enabled when you enable it. By default auto update is turned on. If you disable auto-update, you need to call updateConnections() after changing actions.

Parameters:
bAuto - true to enable, false to disable
Returns:
the value of the flag before this call

insert

public KAccelAction insert(java.lang.String sAction,
                           java.lang.String sLabel,
                           java.lang.String sWhatsThis,
                           KShortcut cutDef,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot,
                           boolean bConfigurable,
                           boolean bEnabled)
Create an accelerator action. Usage:
                 insert( "Do Something", i18n("Do Something"),
                   i18n("This action allows you to do something really great with this program to "
                        "the currently open document."),
                   ALT+Key_D, this, SLOT("slotDoSomething()") );
                

Parameters:
sAction - The internal name of the action.
sLabel - An i18n'ized short description of the action displayed when using KKeyChooser to reconfigure the shortcuts.
sWhatsThis - An extended description of the action.
cutDef - The default shortcut.
pObjSlot - Pointer to the slot object.
psMethodSlot - Pointer to the slot method.
bConfigurable - Allow the user to change this shortcut if set to 'true'.
bEnabled - The action will be activated by the shortcut if set to 'true'.

insert

public KAccelAction insert(java.lang.String sAction,
                           java.lang.String sLabel,
                           java.lang.String sWhatsThis,
                           KShortcut cutDef,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot,
                           boolean bConfigurable)

insert

public KAccelAction insert(java.lang.String sAction,
                           java.lang.String sLabel,
                           java.lang.String sWhatsThis,
                           KShortcut cutDef,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot)

insert

public KAccelAction insert(java.lang.String sAction,
                           java.lang.String sLabel,
                           java.lang.String sWhatsThis,
                           KShortcut cutDef3,
                           KShortcut cutDef4,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot,
                           boolean bConfigurable,
                           boolean bEnabled)
Same as first insert(), but with separate shortcuts defined for 3- and 4- modifier defaults.


insert

public KAccelAction insert(java.lang.String sAction,
                           java.lang.String sLabel,
                           java.lang.String sWhatsThis,
                           KShortcut cutDef3,
                           KShortcut cutDef4,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot,
                           boolean bConfigurable)

insert

public KAccelAction insert(java.lang.String sAction,
                           java.lang.String sLabel,
                           java.lang.String sWhatsThis,
                           KShortcut cutDef3,
                           KShortcut cutDef4,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot)

insert

public KAccelAction insert(java.lang.String psAction,
                           KShortcut cutDef,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot,
                           boolean bConfigurable,
                           boolean bEnabled)
This is an overloaded function provided for convenience. The advantage of this is when you want to use the same text for the name of the action as for the user-visible label. Usage:
                 insert( i18n("Do Something"), ALT+Key_D, this, SLOT("slotDoSomething()") );
                 

Parameters:
psAction - The name AND label of the action.
cutDef - The default shortcut for this action.
pObjSlot - Pointer to the slot object.
psMethodSlot - Pointer to the slot method.
bConfigurable - Allow the user to change this shortcut if set to 'true'.
bEnabled - The action will be activated by the shortcut if set to 'true'.

insert

public KAccelAction insert(java.lang.String psAction,
                           KShortcut cutDef,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot,
                           boolean bConfigurable)

insert

public KAccelAction insert(java.lang.String psAction,
                           KShortcut cutDef,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot)

insert

public KAccelAction insert(int id,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot,
                           boolean bConfigurable,
                           boolean bEnabled)
Similar to the first insert() method, but with the action name, short description, help text, and default shortcuts all set according to one of the standard accelerators.

See Also:
KStdAccel#

insert

public KAccelAction insert(int id,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot,
                           boolean bConfigurable)

insert

public KAccelAction insert(int id,
                           org.kde.qt.QObject pObjSlot,
                           java.lang.String psMethodSlot)

remove

public boolean remove(java.lang.String sAction)
Removes the accelerator action identified by the name. Remember to also call updateConnections().

Parameters:
sAction - the name of the action to remove
Returns:
true if successful, false otherwise

updateConnections

public boolean updateConnections()
Updates the connections of the accelerations after changing them. This is only necessary if you have disabled auto updates which are on by default.

Returns:
true if successful, false otherwise
See Also:
setAutoUpdate(boolean), #getAutoUpdate

shortcut

public KShortcut shortcut(java.lang.String sAction)
Return the shortcut associated with the action named by sAction.

Parameters:
sAction - the name of the action
Returns:
the action's shortcut, or a null shortcut if not found

setShortcut

public boolean setShortcut(java.lang.String sAction,
                           KShortcut shortcut)
Set the shortcut to be associated with the action named by sAction.

Parameters:
sAction - the name of the action
shortcut - the shortcut to set
Returns:
true if successful, false otherwise

setSlot

public boolean setSlot(java.lang.String sAction,
                       org.kde.qt.QObject pObjSlot,
                       java.lang.String psMethodSlot)
Set the slot to be called when the shortcut of the action named by sAction is pressed.

Parameters:
sAction - the name of the action
pObjSlot - the owner of the slot
psMethodSlot - the name of the slot
Returns:
true if successful, false otherwise

setEnabled

public boolean setEnabled(java.lang.String sAction,
                          boolean bEnabled)
Enable or disable the action named by sAction.

Parameters:
sAction - the action to en-/disable
bEnabled - true to enable, false to disable
Returns:
true if successful, false otherwise

configGroup

public java.lang.String configGroup()
Returns the configuration group of the settings.

Returns:
the configuration group
See Also:
KConfig

setConfigGroup

public void setConfigGroup(java.lang.String name)
Returns the configuration group of the settings.

Parameters:
name - the new configuration group
See Also:
KConfig

readSettings

public boolean readSettings(KConfigBase pConfig)
Read all shortcuts from pConfig, or (if pConfig is zero) from the application's configuration file KGlobal.config(). The group in which the configuration is stored can be set with setConfigGroup().

Parameters:
pConfig - the configuration file, or 0 for the application configuration file
Returns:
true if successful, false otherwise

readSettings

public boolean readSettings()

writeSettings

public boolean writeSettings(KConfigBase pConfig)
Write the current shortcuts to pConfig, or (if pConfig is zero) to the application's configuration file.

Parameters:
pConfig - the configuration file, or 0 for the application configuration file
Returns:
true if successful, false otherwise

writeSettings

public boolean writeSettings()

emitKeycodeChanged

public void emitKeycodeChanged()
Emits the keycodeChanged() signal.


finalize

protected void finalize()
                 throws java.lang.InternalError
Deletes the wrapped C++ instance

Overrides:
finalize in class org.kde.qt.QAccel
Throws:
java.lang.InternalError

dispose

public void dispose()
Delete the wrapped C++ instance ahead of finalize()

Overrides:
dispose in class org.kde.qt.QAccel

isDisposed

public boolean isDisposed()
Has the wrapped C++ instance been deleted?

Overrides:
isDisposed in class org.kde.qt.QAccel