org.kde.koala
Class KDockMainWindow

java.lang.Object
  extended by org.kde.qt.Qt
      extended by org.kde.qt.QObject
          extended by org.kde.qt.QWidget
              extended by org.kde.qt.QMainWindow
                  extended by org.kde.koala.KMainWindow
                      extended by org.kde.koala.KDockMainWindow
All Implemented Interfaces:
KXMLGUIBuilderInterface, KXMLGUIClientInterface, org.kde.qt.QPaintDeviceInterface, org.kde.qt.QtSupport
Direct Known Subclasses:
DockMainWindow

public class KDockMainWindow
extends KMainWindow

A special kind of KMainWindow that is able to have dockwidget child widgets (and member of the dockwidget class set). The main widget should be a KDockWidget where other KDockWidget can be docked to the left, right, top, bottom or to the middle. Note: dock to the middle means to drop on a dockwidget and to unite them to a new widget, a tab control. Furthermore, the KDockMainWindow has got the KDockManager and some data about the dock states. If you've got some dockwidgets, you can dock them to the dockmainwindow to initialize a start scene: Here an example:

 DockApplication.DockApplication( String name)
 {
   ...
   KDockWidget mainDock;
   mainDock = createDockWidget( "Falk's MainDockWidget", mainPixmap, null, "main_dock_widget");
   AnyContentsWidget cw = new AnyContentsWidget( mainDock);
   mainDock.setWidget( cw);
   // allow others to dock to the 4 sides
   mainDock.setDockSite(KDockWidget.DockCorner);
   // forbit docking abilities of mainDock itself
   mainDock.setEnableDocking(KDockWidget.DockNone);
   setView( mainDock); // central widget in a KDE mainwindow
   setMainDockWidget( mainDock); // master dockwidget
   ...
   KDockWidget dockLeft;
   dockLeft = createDockWidget( "Intially left one", anyOtherPixmap, null, i18n("The left dockwidget"));
   AnotherWidget aw = new AnotherWidget( dockLeft);
   dockLeft.setWidget( aw);
   dockLeft.manualDock( mainDock,              // dock target
                         KDockWidget.DockLeft, // dock site
                         20 );                  // relation target/this (in percent)
   ...
 
Docking is fully dynamic at runtime. That means you can always move dockwidgets via drag and drop. And last but not least you can use the popupmenu for showing or hiding any controlled dockwidget of this class and insert it to your main menu bar or anywhere else. See KDockMainWindowSignals for signals emitted by KDockMainWindow

Author:
Max Judin (documentation: Falk Brettschneider).

Field Summary
 
Fields inherited from class org.kde.koala.KMainWindow
Create, Keys, NoDCOPObject, Save, StatusBar, ToolBar
 
Fields inherited from class org.kde.qt.QMainWindow
AllDockWindows, NoToolBars, OnlyToolBars
 
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
  KDockMainWindow()
           
protected KDockMainWindow(java.lang.Class dummy)
           
  KDockMainWindow(org.kde.qt.QWidget parent)
           
  KDockMainWindow(org.kde.qt.QWidget parent, java.lang.String name)
           
  KDockMainWindow(org.kde.qt.QWidget parent, java.lang.String name, int f)
          Constructs a dockmainwindow.
 
Method Summary
 void activateDock()
          It runs through all dockwidgets which are under control of the dockmanager and calls show() for every encapsulated widget and show() for the dockwidget itself if it is not in tab mode.
 java.lang.String className()
           
 KDockWidget createDockWidget(java.lang.String name, org.kde.qt.QPixmap pixmap)
           
 KDockWidget createDockWidget(java.lang.String name, org.kde.qt.QPixmap pixmap, org.kde.qt.QWidget parent)
           
 KDockWidget createDockWidget(java.lang.String name, org.kde.qt.QPixmap pixmap, org.kde.qt.QWidget parent, java.lang.String strCaption)
           
 KDockWidget createDockWidget(java.lang.String name, org.kde.qt.QPixmap pixmap, org.kde.qt.QWidget parent, java.lang.String strCaption, java.lang.String strTabPageLabel)
          This is one of the most important methods! The KDockMainWindow creates a new dockwidget object here that usually should encapsulate the user's widget.
 void dispose()
          Delete the wrapped C++ instance ahead of finalize()
 org.kde.qt.QPopupMenu dockHideShowMenu()
          Returns a popup menu that contains entries for all controlled dockwidgets making hiding and showing them possible.
protected  void finalize()
          Deletes the wrapped C++ instance
 KDockWidget getMainDockWidget()
          Returns the main dockwidget.
 boolean isDisposed()
          Has the wrapped C++ instance been deleted?
 void makeDockInvisible(KDockWidget dock)
          This method hides the given dockwidget.
 void makeDockVisible(KDockWidget dock)
          This method shows the given dockwidget.
 void makeWidgetDockVisible(org.kde.qt.QWidget widget)
          This is an overloaded member function, provided for convenience.
 KDockManager manager()
          Returns the dockmanager of this.
 org.kde.qt.QMetaObject metaObject()
           
 void readDockConfig()
           
 void readDockConfig(KConfig c)
           
 void readDockConfig(KConfig c, java.lang.String group)
          It reads the current dock state from the given section of KConfig.
 void readDockConfig(org.kde.qt.QDomElement base)
          Reads the current dock window layout from a DOM tree below the given element.
 void setMainDockWidget(KDockWidget dockwidget)
          Sets a new main dockwidget.
 void setView(org.kde.qt.QWidget widget)
          This method calls the base class method.
protected  void slotDockWidgetUndocked()
          Called whenever one of the dockwidgets of this has been undocked.
 void writeDockConfig()
           
 void writeDockConfig(KConfig c)
           
 void writeDockConfig(KConfig c, java.lang.String group)
          It writes the current dock state in the given section of KConfig.
 void writeDockConfig(org.kde.qt.QDomElement base)
          Saves the current dock window layout into a DOM tree below the given element.
 
Methods inherited from class org.kde.koala.KMainWindow
accel, action, action, actionCollection, addStateActionDisabled, addStateActionEnabled, appHelpActivated, applyMainWindowSettings, applyMainWindowSettings, applyMainWindowSettings, autoSaveGroup, autoSaveSettings, beginXMLPlug, builderClient, builderInstance, canBeRestored, childEvent, classNameOfToplevel, clientBuilder, closeEvent, configureToolbars, conserveMemory, containerTags, createContainer, createCustomElement, createGUI, createGUI, createGUI, createStandardStatusBarAction, customHelpMenu, customHelpMenu, customTags, domDocument, endXMLPlug, factory, finalizeGUI, finalizeGUI, findMostRecentXMLFile, guiFactory, hasMenuBar, helpMenu, helpMenu, helpMenu, hide, ignoreInitialGeometry, initialGeometrySet, insertChildClient, instance, isHelpMenuEnabled, isStandardToolBarMenuEnabled, kmenuBar, kstatusBar, localXMLFile, memberList, paintEvent, parentClient, parseGeometry, prepareXMLUnplug, queryClose, queryExit, readGlobalProperties, readProperties, readPropertiesInternal, reloadXML, removeChildClient, removeContainer, removeCustomElement, resetAutoSaveSettings, resizeEvent, restore, restore, RESTORE, restoreWindowSize, saveAutoSaveSettings, saveGlobalProperties, saveMainWindowSettings, saveMainWindowSettings, saveNewToolbarConfig, saveProperties, savePropertiesInternal, saveWindowSize, setAutoSaveSettings, setAutoSaveSettings, setAutoSaveSettings, setBuilderClient, setBuilderInstance, setCaption, setCaption, setClientBuilder, setDOMDocument, setDOMDocument, setFactory, setFrameBorderWidth, setHelpMenuEnabled, setHelpMenuEnabled, setIcon, setInstance, setLocalXMLFile, setPlainCaption, setSettingsDirty, setStandardToolBarMenuEnabled, settingsDirty, settingsGroup, setupGUI, setupGUI, setupGUI, setupGUI, setupGUI, setupGUI, setupToolbarMenuActions, setXML, setXML, setXMLFile, setXMLFile, setXMLFile, setXMLGUIBuildDocument, show, showAboutApplication, slotStateChanged, slotStateChanged, stateChanged, stateChanged, toolBar, toolBar, toolBarMenuAction, unplugActionList, widget, xmlFile, xmlguiBuildDocument
 
Methods inherited from class org.kde.qt.QMainWindow
addDockWindow, addDockWindow, addDockWindow, addDockWindow, addDockWindow, addDockWindow, addToolBar, addToolBar, addToolBar, addToolBar, addToolBar, addToolBar, appropriate, bottomDock, centralWidget, createDockWindowMenu, createDockWindowMenu, customize, dockingArea, dockWindowsMovable, event, eventFilter, getLocation, hasDockWindow, isCustomizable, isDockEnabled, isDockEnabled, isDockEnabled, isDockEnabled, isDockMenuEnabled, leftDock, lineUpDockWindows, lineUpDockWindows, lineUpToolBars, lineUpToolBars, menuAboutToShow, menuBar, minimumSizeHint, moveDockWindow, moveDockWindow, moveDockWindow, moveDockWindow, moveToolBar, moveToolBar, moveToolBar, moveToolBar, opaqueMoving, removeDockWindow, removeToolBar, rightDock, rightJustification, setAppropriate, setCentralWidget, setDockEnabled, setDockEnabled, setDockMenuEnabled, setDockWindowsMovable, setOpaqueMoving, setRightJustification, setToolBarsMovable, setUpLayout, setUsesBigPixmaps, setUsesTextLabel, showDockMenu, sizeHint, statusBar, styleChange, toolBarsMovable, toolTipGroup, topDock, tr, tr, usesBigPixmaps, usesTextLabel, whatsThis
 
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, 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, 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, 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, minimumWidth, mouseDoubleClickEvent, mouseGrabber, mouseMoveEvent, mousePressEvent, mouseReleaseEvent, move, move, moveEvent, ownCursor, ownFont, ownPalette, paintDevice, 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, resolution, scroll, scroll, setAcceptDrops, setActiveWindow, setAutoMask, setBackgroundColor, setBackgroundMode, setBackgroundMode, setBackgroundOrigin, setBackgroundPixmap, setBaseSize, setBaseSize, setCursor, setDisabled, setEnabled, setEraseColor, setErasePixmap, setFixedHeight, setFixedSize, setFixedSize, setFixedWidth, setFocus, setFocusPolicy, setFocusProxy, setFont, setFont, setGeometry, setGeometry, setHidden, 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, showEvent, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeIncrement, sizePolicy, stackUnder, style, tabletEvent, testWFlags, testWState, topLevelWidget, 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, 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, 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

KDockMainWindow

protected KDockMainWindow(java.lang.Class dummy)

KDockMainWindow

public KDockMainWindow(org.kde.qt.QWidget parent,
                       java.lang.String name,
                       int f)
Constructs a dockmainwindow. It calls its base class constructor and does additional things concerning to the dock stuff:
  • information about the dock state of this' children gets initialized
  • a dockmanager is created...
  • ...and gets initialized
  • the main dockwidget is set to 0
  • Parameters:
    parent - Parent widget for the dock main widget
    name - internal object name
    f - Qt.WidgetFlags widget flags

    KDockMainWindow

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

    KDockMainWindow

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

    KDockMainWindow

    public KDockMainWindow()
    Method Detail

    metaObject

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

    className

    public java.lang.String className()
    Overrides:
    className in class KMainWindow

    manager

    public KDockManager manager()
    Returns the dockmanager of this. (see KDockManager)

    Returns:
    pointer to the wanted dockmanager

    setMainDockWidget

    public void setMainDockWidget(KDockWidget dockwidget)
    Sets a new main dockwidget. Additionally, the toolbar is re-initialized.

    Parameters:
    dockwidget - dockwidget that become the new main dockwidget

    getMainDockWidget

    public KDockWidget getMainDockWidget()
    Returns the main dockwidget.

    Returns:
    pointer to the main dockwidget

    createDockWidget

    public KDockWidget createDockWidget(java.lang.String name,
                                        org.kde.qt.QPixmap pixmap,
                                        org.kde.qt.QWidget parent,
                                        java.lang.String strCaption,
                                        java.lang.String strTabPageLabel)
    This is one of the most important methods! The KDockMainWindow creates a new dockwidget object here that usually should encapsulate the user's widget. The new dockwidget is automatically taken under control by the dockmanager of the dockmainwindow.

    Parameters:
    name - QObject name (default dockwidget caption)
    pixmap - window icon (for instance shown when docked as tabwidget entry)
    parent - parent widget for the new dockwidget
    strCaption - window title (shown when toplevel)
    strTabPageLabel - title of the tab page (visible when in tab page mode), if it is "", only the icon will be shown; if it is null, the label is set to strCaption
    Returns:
    a pointer to the new created dockwidget

    createDockWidget

    public KDockWidget createDockWidget(java.lang.String name,
                                        org.kde.qt.QPixmap pixmap,
                                        org.kde.qt.QWidget parent,
                                        java.lang.String strCaption)

    createDockWidget

    public KDockWidget createDockWidget(java.lang.String name,
                                        org.kde.qt.QPixmap pixmap,
                                        org.kde.qt.QWidget parent)

    createDockWidget

    public KDockWidget createDockWidget(java.lang.String name,
                                        org.kde.qt.QPixmap pixmap)

    writeDockConfig

    public void writeDockConfig(org.kde.qt.QDomElement base)
    Saves the current dock window layout into a DOM tree below the given element.


    readDockConfig

    public void readDockConfig(org.kde.qt.QDomElement base)
    Reads the current dock window layout from a DOM tree below the given element.


    writeDockConfig

    public void writeDockConfig(KConfig c,
                                java.lang.String group)
    It writes the current dock state in the given section of KConfig.

    Parameters:
    c - KDE class for saving configurations
    group - name of section to write to

    writeDockConfig

    public void writeDockConfig(KConfig c)

    writeDockConfig

    public void writeDockConfig()

    readDockConfig

    public void readDockConfig(KConfig c,
                               java.lang.String group)
    It reads the current dock state from the given section of KConfig.

    Parameters:
    c - KDE class for saving configurations
    group - name of section to read from

    readDockConfig

    public void readDockConfig(KConfig c)

    readDockConfig

    public void readDockConfig()

    activateDock

    public void activateDock()
    It runs through all dockwidgets which are under control of the dockmanager and calls show() for every encapsulated widget and show() for the dockwidget itself if it is not in tab mode. Additionally, if the main dockwidget is not a QDialog, it will be shown.


    dockHideShowMenu

    public org.kde.qt.QPopupMenu dockHideShowMenu()
    Returns a popup menu that contains entries for all controlled dockwidgets making hiding and showing them possible.

    Returns:
    the wanted popup menu

    makeDockVisible

    public void makeDockVisible(KDockWidget dock)
    This method shows the given dockwidget. The clue is that it also considers the dockwidget could be a tab page and must set to be the activate one.

    Parameters:
    dock - the dockwidget that is to be shown

    makeDockInvisible

    public void makeDockInvisible(KDockWidget dock)
    This method hides the given dockwidget.

    Parameters:
    dock - the dockwidget that is to be shown

    makeWidgetDockVisible

    public void makeWidgetDockVisible(org.kde.qt.QWidget widget)
    This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.


    setView

    public void setView(org.kde.qt.QWidget widget)
    This method calls the base class method. If the given widget inherits KDockWidget, applyToWidget(this) is called.

    Parameters:
    widget - any widget that should become the main view

    slotDockWidgetUndocked

    protected void slotDockWidgetUndocked()
    Called whenever one of the dockwidgets of this has been undocked.


    finalize

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

    Overrides:
    finalize in class KMainWindow
    Throws:
    java.lang.InternalError

    dispose

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

    Overrides:
    dispose in class KMainWindow

    isDisposed

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

    Overrides:
    isDisposed in class KMainWindow