org.kde.koala
Class KActionCollection

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

public class KActionCollection
extends org.kde.qt.QObject

A managed set of KAction objects. If you set the tooltips on KActions and want the tooltip to show in statusbar (recommended) then you will need to connect a couple of the actionclass signals to the toolbar. The easiest way of doing this is in your KMainWindow subclass, where you create a statusbar, do:

 actionCollection().setHighlightingEnabled(true);  
 connect(actionCollection(), SIGNAL("actionStatusText( String )"),
           statusBar(), SLOT("message( String )") );
 connect(actionCollection(), SIGNAL("clearStatusText()"),
           statusBar(), SLOT("clear()") );
 
See KActionCollectionSignals for signals emitted by KActionCollection


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 KActionCollection(java.lang.Class dummy)
           
  KActionCollection(KActionCollection copy)
           
  KActionCollection(org.kde.qt.QObject parent)
           
  KActionCollection(org.kde.qt.QObject parent, java.lang.String name)
           
  KActionCollection(org.kde.qt.QObject parent, java.lang.String name, KInstanceInterface instance)
           
  KActionCollection(org.kde.qt.QWidget parent)
           
  KActionCollection(org.kde.qt.QWidget watch, org.kde.qt.QObject parent)
           
  KActionCollection(org.kde.qt.QWidget watch, org.kde.qt.QObject parent, java.lang.String name)
           
  KActionCollection(org.kde.qt.QWidget watch, org.kde.qt.QObject parent, java.lang.String name, KInstanceInterface instance)
          Use this constructor if you want the collection's actions to restrict their accelerator keys to watch rather than the parent. If you don't require shortcuts, you can pass a null to the watch parameter.
  KActionCollection(org.kde.qt.QWidget parent, java.lang.String name)
           
  KActionCollection(org.kde.qt.QWidget parent, java.lang.String name, KInstanceInterface instance)
           
 
Method Summary
 KAction action(int index)
          Return the KAction at position "index" in the action collection.
 KAction action(java.lang.String name)
           
 KAction action(java.lang.String name, java.lang.String classname)
          Find an action (optionally, of a given subclass of KAction) in the action collection.
 boolean addDocCollection(KActionCollection pDoc)
          Doc/View model.
 KAccel builderKAccel()
           
 java.lang.String className()
           
 void clear()
          Clears the entire actionCollection, deleting all actions.
 void connectHighlight(org.kde.qt.QWidget container, KAction action)
          Call this function if you want to receive a signal whenever a KAction is highlighted in a menu or a toolbar.
 int count()
          Returns the number of actions in the collection @short Returns the number of actions in the collection
 void disconnectHighlight(org.kde.qt.QWidget container, KAction action)
          Disconnect highlight notifications for a particular pair of contianer and action.
 void dispose()
          Delete the wrapped C++ instance ahead of finalize()
protected  void finalize()
          Deletes the wrapped C++ instance
 java.util.ArrayList groups()
          Returns a list of all the groups of all the KActions in this action collection.
 boolean highlightingEnabled()
          Return whether highlighting notifications are enabled.
 void insert(KAction action)
          Add an action to the collection.
 KInstanceInterface instance()
          The instance with which this class is associated.
 boolean isAutoConnectShortcuts()
          This indicates whether new actions which are created in this collection have their keyboard shortcuts automatically connected on construction.
 boolean isDisposed()
          Has the wrapped C++ instance been deleted?
 boolean isEmpty()
           
 KAccel kaccel()
          Returns the KAccel object of the most recently set widget.
 org.kde.qt.QMetaObject metaObject()
           
 KActionCollection op_plus_assign(KActionCollection arg1)
           
 KActionCollection op_plus(KActionCollection arg1)
           
 KXMLGUIClientInterface parentGUIClient()
          The parent KXMLGUIClient, return null if not available.
 boolean readShortcutSettings()
           
 boolean readShortcutSettings(java.lang.String sConfigGroup)
           
 boolean readShortcutSettings(java.lang.String sConfigGroup, KConfigBase pConfig)
          Used for reading shortcut configuration from a non-XML rc file.
 void remove(KAction action)
          Removes an action from the collection and deletes it.
 void setAutoConnectShortcuts(boolean arg1)
          This indicates whether new actions which are created in this collection should have their keyboard shortcuts automatically connected on construction.
 void setHighlightingEnabled(boolean enable)
          Enable highlighting notification for specific KActions.
 void setInstance(KInstanceInterface instance)
           
 void setWidget(org.kde.qt.QWidget widget)
          This sets the widget to which the keyboard shortcuts should be attached.
 KAction take(KAction action)
          Removes an action from the collection.
 boolean writeShortcutSettings()
           
 boolean writeShortcutSettings(java.lang.String sConfigGroup)
           
 boolean writeShortcutSettings(java.lang.String sConfigGroup, KConfigBase pConfig)
          Used for writing shortcut configuration to a non-XML rc file.
 
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, eventFilter, 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, tr, tr
 
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

KActionCollection

protected KActionCollection(java.lang.Class dummy)

KActionCollection

public KActionCollection(org.kde.qt.QWidget parent,
                         java.lang.String name,
                         KInstanceInterface instance)

KActionCollection

public KActionCollection(org.kde.qt.QWidget parent,
                         java.lang.String name)

KActionCollection

public KActionCollection(org.kde.qt.QWidget parent)

KActionCollection

public KActionCollection(org.kde.qt.QWidget watch,
                         org.kde.qt.QObject parent,
                         java.lang.String name,
                         KInstanceInterface instance)
Use this constructor if you want the collection's actions to restrict their accelerator keys to watch rather than the parent. If you don't require shortcuts, you can pass a null to the watch parameter.


KActionCollection

public KActionCollection(org.kde.qt.QWidget watch,
                         org.kde.qt.QObject parent,
                         java.lang.String name)

KActionCollection

public KActionCollection(org.kde.qt.QWidget watch,
                         org.kde.qt.QObject parent)

KActionCollection

public KActionCollection(KActionCollection copy)

KActionCollection

public KActionCollection(org.kde.qt.QObject parent,
                         java.lang.String name,
                         KInstanceInterface instance)

KActionCollection

public KActionCollection(org.kde.qt.QObject parent,
                         java.lang.String name)

KActionCollection

public KActionCollection(org.kde.qt.QObject parent)
Method Detail

metaObject

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

className

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

setWidget

public void setWidget(org.kde.qt.QWidget widget)
This sets the widget to which the keyboard shortcuts should be attached. You only need to call this if a null pointer was passed in the constructor.


setAutoConnectShortcuts

public void setAutoConnectShortcuts(boolean arg1)
This indicates whether new actions which are created in this collection should have their keyboard shortcuts automatically connected on construction. Set to 'false' if you will be loading XML-based settings. This is automatically done by KParts. The default is 'true'.

See Also:
isAutoConnectShortcuts()

isAutoConnectShortcuts

public boolean isAutoConnectShortcuts()
This indicates whether new actions which are created in this collection have their keyboard shortcuts automatically connected on construction.

See Also:
setAutoConnectShortcuts(boolean)

addDocCollection

public boolean addDocCollection(KActionCollection pDoc)
Doc/View model. This lets you add the action collection of a document to a view's action collection.


kaccel

public KAccel kaccel()
Returns the KAccel object of the most recently set widget. @short Returns the KAccel object of the most recently set widget.


builderKAccel

public KAccel builderKAccel()

count

public int count()
Returns the number of actions in the collection @short Returns the number of actions in the collection


isEmpty

public boolean isEmpty()

action

public KAction action(int index)
Return the KAction at position "index" in the action collection.

See Also:
count()

action

public KAction action(java.lang.String name,
                      java.lang.String classname)
Find an action (optionally, of a given subclass of KAction) in the action collection.

Parameters:
name - Name of the KAction.
classname - Name of the KAction subclass.
Returns:
A pointer to the first KAction in the collection which matches the parameters or null if nothing matches.

action

public KAction action(java.lang.String name)

groups

public java.util.ArrayList groups()
Returns a list of all the groups of all the KActions in this action collection.

See Also:
KAction.group(), KAction.setGroup(java.lang.String)

readShortcutSettings

public boolean readShortcutSettings(java.lang.String sConfigGroup,
                                    KConfigBase pConfig)
Used for reading shortcut configuration from a non-XML rc file.


readShortcutSettings

public boolean readShortcutSettings(java.lang.String sConfigGroup)

readShortcutSettings

public boolean readShortcutSettings()

writeShortcutSettings

public boolean writeShortcutSettings(java.lang.String sConfigGroup,
                                     KConfigBase pConfig)
Used for writing shortcut configuration to a non-XML rc file.


writeShortcutSettings

public boolean writeShortcutSettings(java.lang.String sConfigGroup)

writeShortcutSettings

public boolean writeShortcutSettings()

setInstance

public void setInstance(KInstanceInterface instance)

instance

public KInstanceInterface instance()
The instance with which this class is associated. @short The instance with which this class is associated.


setHighlightingEnabled

public void setHighlightingEnabled(boolean enable)
Enable highlighting notification for specific KActions. This is false by default, so, by default, the highlighting signals will not be emitted.

See Also:
connectHighlight(org.kde.qt.QWidget, org.kde.koala.KAction), disconnectHighlight(org.kde.qt.QWidget, org.kde.koala.KAction), #actionHighlighted, #actionHighlighted, highlightingEnabled()

highlightingEnabled

public boolean highlightingEnabled()
Return whether highlighting notifications are enabled.

See Also:
connectHighlight(org.kde.qt.QWidget, org.kde.koala.KAction), disconnectHighlight(org.kde.qt.QWidget, org.kde.koala.KAction), #actionHighlighted, setHighlightingEnabled(boolean), #actionHighlighted

connectHighlight

public void connectHighlight(org.kde.qt.QWidget container,
                             KAction action)
Call this function if you want to receive a signal whenever a KAction is highlighted in a menu or a toolbar. This is only needed if you do not add this action to this container. You will generally not need to call this function.

Parameters:
container - A container in which the KAction is plugged (must inherit QPopupMenu or KToolBar)
action - The action you are interested in
See Also:
disconnectHighlight(org.kde.qt.QWidget, org.kde.koala.KAction), #actionHighlighted, setHighlightingEnabled(boolean), highlightingEnabled(), #actionHighlighted

disconnectHighlight

public void disconnectHighlight(org.kde.qt.QWidget container,
                                KAction action)
Disconnect highlight notifications for a particular pair of contianer and action. This is only needed if you do not add this action to this container. You will generally not need to call this function.

Parameters:
container - A container in which the KAction is plugged (must inherit QPopupMenu or KToolBar)
action - The action you are interested in
See Also:
connectHighlight(org.kde.qt.QWidget, org.kde.koala.KAction), #actionHighlighted, setHighlightingEnabled(boolean), highlightingEnabled(), #actionHighlighted

parentGUIClient

public KXMLGUIClientInterface parentGUIClient()
The parent KXMLGUIClient, return null if not available.


insert

public void insert(KAction action)
Add an action to the collection. Generally you don't have to call this. The action inserts itself automatically into its parent collection. This can be useful however for a short-lived collection (e.g. for a popupmenu, where the signals from the collection are needed too). (don't forget that in the simple case, a list of actions should be a simple KActionPtrList). If you manually insert actions into a 2nd collection, don't forget to take them out again before destroying the collection.

Parameters:
action - The KAction to add.

remove

public void remove(KAction action)
Removes an action from the collection and deletes it. Since the KAction destructor removes the action from the collection, you generally don't have to call this.

Parameters:
action - The KAction to remove.

take

public KAction take(KAction action)
Removes an action from the collection. Since the KAction destructor removes the action from the collection, you generally don't have to call this.

Parameters:
action - the KAction to remove.
Returns:
NULL if not found else returns action.

op_plus

public KActionCollection op_plus(KActionCollection arg1)

op_plus_assign

public KActionCollection op_plus_assign(KActionCollection arg1)

clear

public void clear()
Clears the entire actionCollection, deleting all actions.

See Also:
remove(org.kde.koala.KAction)

finalize

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

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

dispose

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

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

isDisposed

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

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