org.kde.koala
Class KEditToolbarWidget

java.lang.Object
  org.kde.qt.Qt
      org.kde.qt.QObject
          org.kde.qt.QWidget
              org.kde.koala.KEditToolbarWidget

All Implemented Interfaces:

KXMLGUIClientInterface, org.kde.qt.QPaintDeviceInterface, org.kde.qt.QtSupport

public class KEditToolbarWidget
extends org.kde.qt.QWidget
implements KXMLGUIClientInterface

This is the widget that does all of the work for the KEditToolbar dialog. In most cases, you will want to use the dialog instead of this widget directly. Typically, you would use this widget only if you wanted to embed the toolbar editing directly into your existing configure or preferences dialog. This widget only works if your application uses the XML UI framework for creating menus and toolbars. It depends on the XML files to describe the toolbar layouts and it requires the actions to determine which buttons are active. See KEditToolbarWidgetSignals for signals emitted by KEditToolbarWidget

Version:

$Id: KEditToolbarWidget.java 473384 2005-10-23 14:17:09Z rdale $

Author:

Kurt Granroth

Field Summary

Fields inherited from class org.kde.qt.QWidget

AncestorOrigin, ClickFocus, NoFocus, ParentOrigin, StrongFocus, TabFocus, WheelFocus, WidgetOrigin, WindowOrigin

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	KEditToolbarWidget(java.lang.Class dummy)
	KEditToolbarWidget(KActionCollection collection)
	KEditToolbarWidget(KActionCollection collection, java.lang.String xmlfile)
	KEditToolbarWidget(KActionCollection collection, java.lang.String xmlfile, boolean global)
	KEditToolbarWidget(KActionCollection collection, java.lang.String xmlfile, boolean global, org.kde.qt.QWidget parent) Constructor.
	KEditToolbarWidget(KXMLGUIFactory factory)
	KEditToolbarWidget(KXMLGUIFactory factory, org.kde.qt.QWidget parent) Constructor for KParts based apps.
	KEditToolbarWidget(java.lang.String defaultToolbar, KActionCollection collection)
	KEditToolbarWidget(java.lang.String defaultToolbar, KActionCollection collection, java.lang.String file)
	KEditToolbarWidget(java.lang.String defaultToolbar, KActionCollection collection, java.lang.String file, boolean global)
	KEditToolbarWidget(java.lang.String defaultToolbar, KActionCollection collection, java.lang.String file, boolean global, org.kde.qt.QWidget parent)
	KEditToolbarWidget(java.lang.String defaultToolbar, KXMLGUIFactory factory)
	KEditToolbarWidget(java.lang.String defaultToolbar, KXMLGUIFactory factory, org.kde.qt.QWidget parent)

Method Summary

KAction	action(org.kde.qt.QDomElement element) Retrieves an action for a given QDomElement.
KAction	action(java.lang.String name) Retrieves an action of the client by name.
KActionCollection	actionCollection()
void	addStateActionDisabled(java.lang.String state, java.lang.String action)
void	addStateActionEnabled(java.lang.String state, java.lang.String action)
void	beginXMLPlug(org.kde.qt.QWidget arg1)
java.lang.String	className()
KXMLGUIBuilderInterface	clientBuilder() Retrieves the client's GUI builder or null if no client specific builder has been assigned via setClientBuilder()
protected void	conserveMemory() This function will attempt to give up some memory after the GUI is built.
void	dispose() Delete the wrapped C++ instance ahead of finalize()
org.kde.qt.QDomDocument	domDocument()
void	endXMLPlug()
KXMLGUIFactory	factory() Retrieves a pointer to the KXMLGUIFactory this client is associated with (will return null if the client's GUI has not been built by a KXMLGUIFactory.
protected void	finalize() Deletes the wrapped C++ instance
static java.lang.String	findMostRecentXMLFile(java.lang.String[] files, java.lang.StringBuffer doc)
protected void	initKPart(KXMLGUIFactory factory)
protected void	initNonKPart(KActionCollection collection, java.lang.String file, boolean global)
void	insertChildClient(KXMLGUIClientInterface child) Use this method to make a client a child client of another client.
KInstanceInterface	instance()
boolean	isDisposed() Has the wrapped C++ instance been deleted?
protected void	loadActionList(org.kde.qt.QDomElement elem)
protected void	loadToolbarCombo()
protected void	loadToolbarCombo(java.lang.String defaultToolbar)
java.lang.String	localXMLFile()
org.kde.qt.QMetaObject	metaObject()
KXMLGUIClientInterface	parentClient() KXMLGUIClients can form a simple child/parent object tree.
void	prepareXMLUnplug(org.kde.qt.QWidget arg1)
void	rebuildKXMLGUIClients() Remove and readd all KMXLGUIClients to update the GUI
void	reloadXML() Forces this client to re-read its XML resource file.
void	removeChildClient(KXMLGUIClientInterface child) Removes the given child from the client's children list.
boolean	save() Save any changes the user made.
void	setClientBuilder(KXMLGUIBuilderInterface builder) A client can have an own KXMLGUIBuilder.
protected void	setDOMDocument(org.kde.qt.QDomDocument document)
protected void	setDOMDocument(org.kde.qt.QDomDocument document, boolean merge) Sets the Document for the part, describing the layout of the GUI.
void	setFactory(KXMLGUIFactory factory) This method is called by the KXMLGUIFactory as soon as the client is added to the KXMLGUIFactory's GUI.
protected void	setInstance(KInstanceInterface instance) Sets the instance ( KInstance) for this part.
protected void	setLocalXMLFile(java.lang.String file)
protected void	setupLayout()
protected void	setXML(java.lang.String document)
protected void	setXML(java.lang.String document, boolean merge) Sets the XML for the part.
protected void	setXMLFile(java.lang.String file)
protected void	setXMLFile(java.lang.String file, boolean merge)
protected void	setXMLFile(java.lang.String file, boolean merge, boolean setXMLDoc) Sets the name of the rc file containing the XML for the part.
void	setXMLGUIBuildDocument(org.kde.qt.QDomDocument doc)
protected void	slotActiveSelected(org.kde.qt.QListViewItem item)
protected void	slotChangeIcon()
protected void	slotDownButton()
protected void	slotDropped(KListView list, org.kde.qt.QDropEvent e, org.kde.qt.QListViewItem after)
protected void	slotInactiveSelected(org.kde.qt.QListViewItem item)
protected void	slotInsertButton()
protected void	slotRemoveButton()
protected void	slotToolbarSelected(java.lang.String text)
protected void	slotUpButton()
protected void	stateChanged(java.lang.String newstate)
protected void	stateChanged(java.lang.String newstate, int reverse) Actions can collectively be assigned a "State".
void	unplugActionList(java.lang.String name) The complement of plugActionList() ...
protected void	updateLocal(org.kde.qt.QDomElement elem)
java.lang.String	xmlFile() This will return the name of the XML file as set by setXMLFile().
org.kde.qt.QDomDocument	xmlguiBuildDocument()

Methods inherited from class org.kde.qt.QWidget

acceptDrops, adjustSize, autoMask, backgroundBrush, backgroundColor, backgroundMode, backgroundOffset, backgroundOrigin, backgroundPixmap, baseSize, caption, childAt, childAt, childAt, childAt, childrenRect, childrenRegion, clearFocus, clearMask, clearWFlags, clearWState, clipRegion, close, close, closeEvent, colorGroup, constPolish, contextMenuEvent, create, create, create, create, cursor, customWhatsThis, destroy, destroy, destroy, devType, dragEnterEvent, dragLeaveEvent, dragMoveEvent, drawText, drawText, dropEvent, enabledChange, enterEvent, erase, erase, erase, erase, eraseColor, erasePixmap, event, find, focusData, focusInEvent, focusNextPrevChild, focusOutEvent, focusPolicy, focusProxy, focusWidget, font, fontChange, fontInf, fontInfo, fontMet, fontMet, fontMet, fontMetrics, foregroundColor, frameGeometry, frameSize, geometry, getWFlags, getWState, grabKeyboard, grabMouse, grabMouse, hasFocus, hasMouse, hasMouseTracking, height, heightForWidth, hide, hideEvent, icon, iconify, iconText, imComposeEvent, imEndEvent, imStartEvent, isActiveWindow, isDesktop, isDialog, isEnabled, isEnabledTo, isEnabledToTLW, isExtDev, isFocusEnabled, isFullScreen, isHidden, isInputMethodEnabled, isMaximized, isMinimized, isModal, isPopup, isShown, isTopLevel, isUpdatesEnabled, isVisible, isVisibleTo, isVisibleToTLW, keyboardGrabber, keyPressEvent, keyReleaseEvent, layout, leaveEvent, lower, mapFrom, mapFromGlobal, mapFromParent, mapTo, mapToGlobal, mapToParent, maximumHeight, maximumSize, maximumWidth, metric, microFocusHint, minimumHeight, minimumSize, minimumSizeHint, minimumWidth, mouseDoubleClickEvent, mouseGrabber, mouseMoveEvent, mousePressEvent, mouseReleaseEvent, move, move, moveEvent, ownCursor, ownFont, ownPalette, paintDevice, paintEvent, paintingActive, palette, paletteBackgroundColor, paletteBackgroundPixmap, paletteChange, paletteForegroundColor, parentWidget, parentWidget, polish, pos, raise, recreate, recreate, rect, releaseKeyboard, releaseMouse, repaint, repaint, repaint, repaint, repaint, repaint, repaint, repaint, reparent, reparent, reparent, reparent, resetInputContext, resize, resize, resizeEvent, resolution, scroll, scroll, setAcceptDrops, setActiveWindow, setAutoMask, setBackgroundColor, setBackgroundMode, setBackgroundMode, setBackgroundOrigin, setBackgroundPixmap, setBaseSize, setBaseSize, setCaption, setCursor, setDisabled, setEnabled, setEraseColor, setErasePixmap, setFixedHeight, setFixedSize, setFixedSize, setFixedWidth, setFocus, setFocusPolicy, setFocusProxy, setFont, setFont, setGeometry, setGeometry, setHidden, setIcon, setIconText, setInputMethodEnabled, setKeyCompression, setMask, setMask, setMaximumHeight, setMaximumSize, setMaximumSize, setMaximumWidth, setMicroFocusHint, setMicroFocusHint, setMicroFocusHint, setMinimumHeight, setMinimumSize, setMinimumSize, setMinimumWidth, setMouseTracking, setName, setPalette, setPalette, setPaletteBackgroundColor, setPaletteBackgroundPixmap, setPaletteForegroundColor, setResolution, setShown, setSizeIncrement, setSizeIncrement, setSizePolicy, setSizePolicy, setSizePolicy, setStyle, setStyle, setTabOrder, setUpdatesEnabled, setWFlags, setWindowOpacity, setWindowState, setWState, show, showEvent, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeHint, sizeIncrement, sizePolicy, stackUnder, style, styleChange, tabletEvent, testWFlags, testWState, topLevelWidget, tr, tr, unsetCursor, unsetFont, unsetPalette, update, update, update, updateGeometry, updateMask, visibleRect, wheelEvent, width, windowActivationChange, windowOpacity, windowState, winId, x, y

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, 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, 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

KEditToolbarWidget

protected KEditToolbarWidget(java.lang.Class dummy)

KEditToolbarWidget

public KEditToolbarWidget(KActionCollection collection,
                          java.lang.String xmlfile,
                          boolean global,
                          org.kde.qt.QWidget parent)

Constructor. This is the only entry point to this class. You must pass along your collection of actions (some of which appear in your toolbars). The other three parameters are optional. The second parameter, xmlfile, is the name (absolute or relative) of your application's UI resource file. If it is left blank, then the resource file: share/apps/appname/appnameui.rc is used. This is the same resource file that is used by the default createGUI function in KMainWindow so you're usually pretty safe in leaving it blank. The third parameter, global, controls whether or not the global resource file is used. If this is true, then you may edit all of the actions in your toolbars -- global ones and local one. If it is false, then you may edit only your application's entries. The only time you should set this to false is if your application does not use the global resource file at all (very rare) The last parameter, parent, is the standard parent stuff.

Parameters:

collection - The collection of actions to work on

xmlfile - The application's local resource file

global - If true, then the global resource file will also be parsed

parent - This widget's parent

KEditToolbarWidget

public KEditToolbarWidget(KActionCollection collection,
                          java.lang.String xmlfile,
                          boolean global)

KEditToolbarWidget

public KEditToolbarWidget(KActionCollection collection,
                          java.lang.String xmlfile)

KEditToolbarWidget

public KEditToolbarWidget(KActionCollection collection)

KEditToolbarWidget

public KEditToolbarWidget(java.lang.String defaultToolbar,
                          KActionCollection collection,
                          java.lang.String file,
                          boolean global,
                          org.kde.qt.QWidget parent)

KEditToolbarWidget

public KEditToolbarWidget(java.lang.String defaultToolbar,
                          KActionCollection collection,
                          java.lang.String file,
                          boolean global)

KEditToolbarWidget

public KEditToolbarWidget(java.lang.String defaultToolbar,
                          KActionCollection collection,
                          java.lang.String file)

KEditToolbarWidget

public KEditToolbarWidget(java.lang.String defaultToolbar,
                          KActionCollection collection)

KEditToolbarWidget

public KEditToolbarWidget(KXMLGUIFactory factory,
                          org.kde.qt.QWidget parent)

Constructor for KParts based apps. The first parameter, factory, is a pointer to the XML GUI factory object for your application. It contains a list of all of the GUI clients (along with the action collections and xml files) and the toolbar editor uses that. The second parameter, parent, is the standard parent Use this like so:

                 KEditToolbar edit(factory());
                 if ( edit.exec() )
                 ...
                 

Parameters:

factory - Your application's factory object

parent - This widget's parent

KEditToolbarWidget

public KEditToolbarWidget(KXMLGUIFactory factory)

KEditToolbarWidget

public KEditToolbarWidget(java.lang.String defaultToolbar,
                          KXMLGUIFactory factory,
                          org.kde.qt.QWidget parent)

KEditToolbarWidget

public KEditToolbarWidget(java.lang.String defaultToolbar,
                          KXMLGUIFactory factory)

Method Detail

metaObject

public org.kde.qt.QMetaObject metaObject()

Overrides:

metaObject in class org.kde.qt.QWidget

className

public java.lang.String className()

Overrides:

className in class org.kde.qt.QWidget

actionCollection

public KActionCollection actionCollection()

Specified by:

actionCollection in interface KXMLGUIClientInterface

save

public boolean save()

Save any changes the user made. The file will be in the user's local directory (usually $HOME/.kde/share/apps/\). The filename will be the one specified in the constructor.. or the made up one if the filename was NULL.

Returns:

The status of whether or not the save succeeded.

rebuildKXMLGUIClients

public void rebuildKXMLGUIClients()

Remove and readd all KMXLGUIClients to update the GUI

setupLayout

protected void setupLayout()

initNonKPart

protected void initNonKPart(KActionCollection collection,
                            java.lang.String file,
                            boolean global)

initKPart

protected void initKPart(KXMLGUIFactory factory)

loadToolbarCombo

protected void loadToolbarCombo(java.lang.String defaultToolbar)

loadToolbarCombo

protected void loadToolbarCombo()

loadActionList

protected void loadActionList(org.kde.qt.QDomElement elem)

updateLocal

protected void updateLocal(org.kde.qt.QDomElement elem)

slotToolbarSelected

protected void slotToolbarSelected(java.lang.String text)

slotInactiveSelected

protected void slotInactiveSelected(org.kde.qt.QListViewItem item)

slotActiveSelected

protected void slotActiveSelected(org.kde.qt.QListViewItem item)

slotDropped

protected void slotDropped(KListView list,
                           org.kde.qt.QDropEvent e,
                           org.kde.qt.QListViewItem after)

slotInsertButton

protected void slotInsertButton()

slotRemoveButton

protected void slotRemoveButton()

slotUpButton

protected void slotUpButton()

slotDownButton

protected void slotDownButton()

slotChangeIcon

protected void slotChangeIcon()

finalize

protected void finalize()
                 throws java.lang.InternalError

Deletes the wrapped C++ instance

Overrides:

finalize in class org.kde.qt.QWidget

Throws:

java.lang.InternalError

dispose

public void dispose()

Delete the wrapped C++ instance ahead of finalize()

Overrides:

dispose in class org.kde.qt.QWidget

isDisposed

public boolean isDisposed()

Has the wrapped C++ instance been deleted?

Overrides:

isDisposed in class org.kde.qt.QWidget

action

public KAction action(java.lang.String name)

Retrieves an action of the client by name. If not found, it looks in its child clients. This method is provided for convenience, as it uses actionCollection() to get the action object.

Specified by:

action in interface KXMLGUIClientInterface

action

public KAction action(org.kde.qt.QDomElement element)

Retrieves an action for a given QDomElement. The default implementation uses the "name" attribute to query the action object via the other action() method.

Specified by:

action in interface KXMLGUIClientInterface

instance

public KInstanceInterface instance()

Specified by:

instance in interface KXMLGUIClientInterface

Returns:

The instance ( KInstance ) for this GUI client.

domDocument

public org.kde.qt.QDomDocument domDocument()

Specified by:

domDocument in interface KXMLGUIClientInterface

Returns:

The parsed XML in a QDomDocument, set by setXMLFile() or setXML(). This document describes the layout of the GUI.

xmlFile

public java.lang.String xmlFile()

This will return the name of the XML file as set by setXMLFile(). If setXML() is used directly, then this will return NULL. The filename that this returns is obvious for components as each component has exactly one XML file. In non-components, however, there are usually two: the global file and the local file. This function doesn't really care about that, though. It will always return the last XML file set. This, in almost all cases, will be the local XML file.

Specified by:

xmlFile in interface KXMLGUIClientInterface

Returns:

The name of the XML file or null

localXMLFile

public java.lang.String localXMLFile()

Specified by:

localXMLFile in interface KXMLGUIClientInterface

setXMLGUIBuildDocument

public void setXMLGUIBuildDocument(org.kde.qt.QDomDocument doc)

Specified by:

setXMLGUIBuildDocument in interface KXMLGUIClientInterface

xmlguiBuildDocument

public org.kde.qt.QDomDocument xmlguiBuildDocument()

Specified by:

xmlguiBuildDocument in interface KXMLGUIClientInterface

setFactory

public void setFactory(KXMLGUIFactory factory)

This method is called by the KXMLGUIFactory as soon as the client is added to the KXMLGUIFactory's GUI.

Specified by:

setFactory in interface KXMLGUIClientInterface

factory

public KXMLGUIFactory factory()

Retrieves a pointer to the KXMLGUIFactory this client is associated with (will return null if the client's GUI has not been built by a KXMLGUIFactory.

Specified by:

factory in interface KXMLGUIClientInterface

parentClient

public KXMLGUIClientInterface parentClient()

KXMLGUIClients can form a simple child/parent object tree. This method returns a pointer to the parent client or null if it has no parent client assigned.

Specified by:

parentClient in interface KXMLGUIClientInterface

insertChildClient

public void insertChildClient(KXMLGUIClientInterface child)

Use this method to make a client a child client of another client. Usually you don't need to call this method, as it is called automatically when using the second constructor, which takes a parent argument.

Specified by:

insertChildClient in interface KXMLGUIClientInterface

removeChildClient

public void removeChildClient(KXMLGUIClientInterface child)

Removes the given child from the client's children list.

Specified by:

removeChildClient in interface KXMLGUIClientInterface

setClientBuilder

public void setClientBuilder(KXMLGUIBuilderInterface builder)

A client can have an own KXMLGUIBuilder. Use this method to assign your builder instance to the client (so that the KXMLGUIFactory can use it when building the client's GUI) Client specific guibuilders are useful if you want to create custom container widgets for your GUI.

Specified by:

setClientBuilder in interface KXMLGUIClientInterface

clientBuilder

public KXMLGUIBuilderInterface clientBuilder()

Retrieves the client's GUI builder or null if no client specific builder has been assigned via setClientBuilder()

Specified by:

clientBuilder in interface KXMLGUIClientInterface

reloadXML

public void reloadXML()

Forces this client to re-read its XML resource file. This is intended to be used when you know that the resource file has changed and you will soon be rebuilding the GUI. It has no useful effect with non-KParts GUIs, so don't bother using it unless your app is component based.

Specified by:

reloadXML in interface KXMLGUIClientInterface

unplugActionList

public void unplugActionList(java.lang.String name)

The complement of plugActionList() ...

Specified by:

unplugActionList in interface KXMLGUIClientInterface

addStateActionEnabled

public void addStateActionEnabled(java.lang.String state,
                                  java.lang.String action)

Specified by:

addStateActionEnabled in interface KXMLGUIClientInterface

addStateActionDisabled

public void addStateActionDisabled(java.lang.String state,
                                   java.lang.String action)

Specified by:

addStateActionDisabled in interface KXMLGUIClientInterface

beginXMLPlug

public void beginXMLPlug(org.kde.qt.QWidget arg1)

Specified by:

beginXMLPlug in interface KXMLGUIClientInterface

endXMLPlug

public void endXMLPlug()

Specified by:

endXMLPlug in interface KXMLGUIClientInterface

prepareXMLUnplug

public void prepareXMLUnplug(org.kde.qt.QWidget arg1)

Specified by:

prepareXMLUnplug in interface KXMLGUIClientInterface

findMostRecentXMLFile

public static java.lang.String findMostRecentXMLFile(java.lang.String[] files,
                                                     java.lang.StringBuffer doc)

setInstance

protected void setInstance(KInstanceInterface instance)

Sets the instance ( KInstance) for this part. Call this first in the inherited class constructor. (At least before setXMLFile().)

setXMLFile

protected void setXMLFile(java.lang.String file,
                          boolean merge,
                          boolean setXMLDoc)

Sets the name of the rc file containing the XML for the part. Call this in the Part-inherited class constructor.

Parameters:

file - Either an absolute path for the file, or simply the filename, which will then be assumed to be installed in the "data" resource, under a directory named like the instance.

merge - Whether to merge with the global document.

setXMLDoc - Specify whether to call setXML. Default is true. and the DOM document at once.

setXMLFile

protected void setXMLFile(java.lang.String file,
                          boolean merge)

setXMLFile

protected void setXMLFile(java.lang.String file)

setLocalXMLFile

protected void setLocalXMLFile(java.lang.String file)

setXML

protected void setXML(java.lang.String document,
                      boolean merge)

Sets the XML for the part. Call this in the Part-inherited class constructor if you don't call setXMLFile().

setXML

protected void setXML(java.lang.String document)

setDOMDocument

protected void setDOMDocument(org.kde.qt.QDomDocument document,
                              boolean merge)

Sets the Document for the part, describing the layout of the GUI. Call this in the Part-inherited class constructor if you don't call setXMLFile or setXML .

setDOMDocument

protected void setDOMDocument(org.kde.qt.QDomDocument document)

conserveMemory

protected void conserveMemory()

This function will attempt to give up some memory after the GUI is built. It should never be used in apps where the GUI may be rebuilt at some later time (components, for instance).

stateChanged

protected void stateChanged(java.lang.String newstate,
                            int reverse)

Actions can collectively be assigned a "State". To accomplish this the respective actions are tagged as \ or \ in a \ \ group of the XMLfile. During program execution the programmer can call stateChanged() to set actions to a defined state.

Parameters:

newstate - Name of a State in the XMLfile.

reverse - If the flag reverse is set to StateReverse, the State is reversed. (actions to be enabled will be disabled and action to be disabled will be enabled) Default is reverse=false.

stateChanged

protected void stateChanged(java.lang.String newstate)