org.kde.koala
Class KDockWidget

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.koala.KDockWidget
All Implemented Interfaces:
org.kde.qt.QPaintDeviceInterface, org.kde.qt.QtSupport

public class KDockWidget
extends org.kde.qt.QWidget

Floatable widget that can be dragged around with the mouse and encapsulate the actual widgets (and member of the dockwidget class set). You just grip the double-lined panel, tear it off its parent widget, drag it somewhere and let it loose. Depending on the position where you leave it, the dockwidget becomes a toplevel window on the desktop (floating mode) or docks to a new widget (dock mode). Note: A KDockWidget can only be docked to a KDockWidget. If you want to use this kind of widget, your main application window has to be a KDockMainWindow. That is because it has got several additional dock management features, for instance a KDockManager that has an overview over all dockwidgets and and a dockmovemanager (internal class) that handles the dock process. Usually you create an KDockWidget that covers the actual widget in this way:

 ...
 KDockMainWindow mainWidget;
 ...
 KDockWidget dock = null;
 dock = mainWidget.createDockWidget( "Any window caption", nicePixmap, null, i18n("window caption")); // null==no parent
 QWidget actualWidget = new QWidget( dock);
 dock.setWidget( actualWidget); // embed it
 dock.setToolTipString(i18n("That's me")); // available when appearing as tab page
 ...
 
See KDockMainWindow how a dockwidget is docked in. See KDockWidgetSignals for signals emitted by KDockWidget

Author:
Max Judin (documentation: Falk Brettschneider).

Field Summary
static int DockBottom
           
static int DockCenter
           
static int DockCorner
           
static int DockDesktop
           
static int DockFullDocking
           
static int DockFullSite
           
static int DockLeft
           
static int DockNone
          The possible positions where a dockwidget can dock to another dockwidget
static int DockRight
           
static int DockTop
           
static int DockToSpecialSites
           
 
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, DockMinimized, 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 KDockWidget(java.lang.Class dummy)
           
  KDockWidget(KDockManager dockManager, java.lang.String name, org.kde.qt.QPixmap pixmap)
           
  KDockWidget(KDockManager dockManager, java.lang.String name, org.kde.qt.QPixmap pixmap, org.kde.qt.QWidget parent)
           
  KDockWidget(KDockManager dockManager, java.lang.String name, org.kde.qt.QPixmap pixmap, org.kde.qt.QWidget parent, java.lang.String strCaption)
           
  KDockWidget(KDockManager dockManager, java.lang.String name, org.kde.qt.QPixmap pixmap, org.kde.qt.QWidget parent, java.lang.String strCaption, java.lang.String strTabPageLabel)
           
  KDockWidget(KDockManager dockManager, java.lang.String name, org.kde.qt.QPixmap pixmap, org.kde.qt.QWidget parent, java.lang.String strCaption, java.lang.String strTabPageLabel, int f)
          Construct a dockwidget.
 
Method Summary
 void changeHideShowState()
          Toggles the visibility state of the dockwidget if it is able to be shown or to be hidden.
 java.lang.String className()
           
 int currentDockPosition()
           
 void dispose()
          Delete the wrapped C++ instance ahead of finalize()
 void dockBack()
          Docks a dockwidget back to the dockwidget that was the neighbor widget before the current dock position.
 KDockManager dockManager()
           
 int dockSite()
           
 int enableDocking()
           
 boolean event(org.kde.qt.QEvent arg1)
          Catches and processes some QWidget events that are interesting for dockwidgets.
protected  void finalize()
          Deletes the wrapped C++ instance
 KDockWidget findNearestDockWidget(int pos)
          Lookup the nearest dockwidget docked left/right/top/bottom to this one or return 0
 int forcedFixedHeight()
           
 int forcedFixedWidth()
           
 KDockWidgetAbstractHeader getHeader()
           
 org.kde.qt.QWidget getWidget()
          Get the embedded widget.
 boolean isDisposed()
          Has the wrapped C++ instance been deleted?
 boolean isDockBackPossible()
           
protected  org.kde.qt.QWidget latestKDockContainer()
           
protected  void leaveEvent(org.kde.qt.QEvent arg1)
           
protected  void loseFormerBrotherDockWidget()
          Does several things here when it has noticed that the former brother widget (closest neighbor) gets lost.
 void makeDockVisible()
          Normally it simply shows the dockwidget.
 KDockWidget manualDock(KDockWidget target, int dockPos)
           
 KDockWidget manualDock(KDockWidget target, int dockPos, int spliPos)
           
 KDockWidget manualDock(KDockWidget target, int dockPos, int spliPos, org.kde.qt.QPoint pos)
           
 KDockWidget manualDock(KDockWidget target, int dockPos, int spliPos, org.kde.qt.QPoint pos, boolean check)
           
 KDockWidget manualDock(KDockWidget target, int dockPos, int spliPos, org.kde.qt.QPoint pos, boolean check, int tabIndex)
          This is a key method of this class! Use it to dock dockwidgets to another dockwidget at the right position within its KDockMainWindow or a toplevel dockwidget.
 boolean mayBeHide()
          There are reasons that it's impossible: It is a (tab) group.
 boolean mayBeShow()
           It is a (tab) group.
 org.kde.qt.QMetaObject metaObject()
           
protected  void mouseMoveEvent(org.kde.qt.QMouseEvent arg1)
           
protected  void mousePressEvent(org.kde.qt.QMouseEvent arg1)
           
protected  void mouseReleaseEvent(org.kde.qt.QMouseEvent arg1)
           
protected  void paintEvent(org.kde.qt.QPaintEvent arg1)
           
 org.kde.qt.QWidget parentDockContainer()
           
 KDockTabGroup parentDockTabGroup()
           
 org.kde.qt.QPixmap pixmap()
          Returns the dockwidget's associated caption/dock tab pixmap
 void restoreFromForcedFixedSize()
           
 void setDockSite(int pos)
          Specify where it is either possible or impossible for another dockwidget to dock to this.
 void setDockWindowTransient(org.kde.qt.QWidget parent, boolean transientEnabled)
           
 void setDockWindowType(int windowType)
          Sets the type of the dock window
 void setEnableDocking(int pos)
          Specify where it is either possible or impossible for this to dock to another dockwidget.
 void setForcedFixedHeight(int arg1)
          subject to changes.
 void setForcedFixedWidth(int arg1)
          subject to changes.
protected  void setFormerBrotherDockWidget(KDockWidget arg1)
           
 void setHeader(KDockWidgetAbstractHeader ah)
          Sets the header of this dockwidget.
protected  void setLatestKDockContainer(org.kde.qt.QWidget arg1)
           
 void setPixmap()
           
 void setPixmap(org.kde.qt.QPixmap pixmap)
          Allows changing the pixmap which is used for the caption or dock tabs
 void setTabPageLabel(java.lang.String label)
          Sets a string that is used for the label of the tab page when in tab page mode
 void setToolTipString(java.lang.String ttStr)
          Stores a string for a tooltip.
 void setWidget(org.kde.qt.QWidget w)
          Sets the embedded widget.
 void show()
          Add dockwidget management actions to QWidget.show.
 java.lang.String tabPageLabel()
           
 void toDesktop()
          Docks the widget to the desktop (as a toplevel widget)
 java.lang.String toolTipString()
           
 org.kde.qt.QWidget transientTo()
          Returns the widget this dockwidget is set transient to, otherwise 0
 void undock()
          Undocks this.
protected  void updateHeader()
          Checks some conditions and shows or hides the dockwidget header (drag panel).
 
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, 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, lower, mapFrom, mapFromGlobal, mapFromParent, mapTo, mapToGlobal, mapToParent, maximumHeight, maximumSize, maximumWidth, metric, microFocusHint, minimumHeight, minimumSize, minimumSizeHint, minimumWidth, mouseDoubleClickEvent, mouseGrabber, 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, 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, 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
 

Field Detail

DockNone

public static final int DockNone
The possible positions where a dockwidget can dock to another dockwidget

See Also:
Constant Field Values

DockTop

public static final int DockTop
See Also:
Constant Field Values

DockLeft

public static final int DockLeft
See Also:
Constant Field Values

DockRight

public static final int DockRight
See Also:
Constant Field Values

DockBottom

public static final int DockBottom
See Also:
Constant Field Values

DockCenter

public static final int DockCenter
See Also:
Constant Field Values

DockDesktop

public static final int DockDesktop
See Also:
Constant Field Values

DockToSpecialSites

public static final int DockToSpecialSites
See Also:
Constant Field Values

DockCorner

public static final int DockCorner
See Also:
Constant Field Values

DockFullSite

public static final int DockFullSite
See Also:
Constant Field Values

DockFullDocking

public static final int DockFullDocking
See Also:
Constant Field Values
Constructor Detail

KDockWidget

protected KDockWidget(java.lang.Class dummy)

KDockWidget

public KDockWidget(KDockManager dockManager,
                   java.lang.String name,
                   org.kde.qt.QPixmap pixmap,
                   org.kde.qt.QWidget parent,
                   java.lang.String strCaption,
                   java.lang.String strTabPageLabel,
                   int f)
Construct a dockwidget. Initially, docking to another and docking to this is allowed for every DockPosition. It is supposed to be no (tab) group. It will taken under control of its dockmanager.

Parameters:
dockManager - The responsible manager (dock helper)
name - Object instance name
pixmap - An icon (for instance shown when docked centered)
parent - Parent widget
strCaption - Title of the dockwidget window (shown when toplevel)
strTabPageLabel - The title of the tab page (shown when in tab page mode), if it is "", only the icon will be shown, if it is null, the label is set to strCaption
f - Qt.WidgetFlags widget flags

KDockWidget

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

KDockWidget

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

KDockWidget

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

KDockWidget

public KDockWidget(KDockManager dockManager,
                   java.lang.String name,
                   org.kde.qt.QPixmap pixmap)
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

manualDock

public KDockWidget manualDock(KDockWidget target,
                              int dockPos,
                              int spliPos,
                              org.kde.qt.QPoint pos,
                              boolean check,
                              int tabIndex)
This is a key method of this class! Use it to dock dockwidgets to another dockwidget at the right position within its KDockMainWindow or a toplevel dockwidget. If the target is null, it will become a toplevel dockwidget at position pos; Note: Docking to another dockwidget means exactly: A new parent dockwidget will be created, that replaces the target dockwidget and contains another single helper widget (tab widget or panner) which contains both dockwidgets, this and the target dockwidget. So consider parent<.child relationships change completely during such actions.

Parameters:
target - The dockwidget to dock to
dockPos - One of the DockPositions this is going to dock to
spliPos - The split relation (in percent, or percent*100 in high resolution) between both dockwidgets, target and this
pos - The dock position, mainly of interest for docking to the desktop (as toplevel dockwidget)
check - Only for internal use;
tabIndex - The position index of the tab widget (when in tab page mode), -1 (default) means append
Returns:
result The group dockwidget that replaces the target dockwidget and will be grandparent of target and this.

manualDock

public KDockWidget manualDock(KDockWidget target,
                              int dockPos,
                              int spliPos,
                              org.kde.qt.QPoint pos,
                              boolean check)

manualDock

public KDockWidget manualDock(KDockWidget target,
                              int dockPos,
                              int spliPos,
                              org.kde.qt.QPoint pos)

manualDock

public KDockWidget manualDock(KDockWidget target,
                              int dockPos,
                              int spliPos)

manualDock

public KDockWidget manualDock(KDockWidget target,
                              int dockPos)

setEnableDocking

public void setEnableDocking(int pos)
Specify where it is either possible or impossible for this to dock to another dockwidget.

Parameters:
pos - An OR'ed set of DockPositions

enableDocking

public int enableDocking()
Returns:
Where it is either possible or impossible for this to dock to another dockwidget (an OR'ed set of DockPositions).

setDockSite

public void setDockSite(int pos)
Specify where it is either possible or impossible for another dockwidget to dock to this.

Parameters:
pos - An OR'ed set of DockPositions

dockSite

public int dockSite()
Returns:
There it is either possible or impossible for another dockwidget to dock to this (an OR'ed set of DockPositions).

setWidget

public void setWidget(org.kde.qt.QWidget w)
Sets the embedded widget. A QLayout takes care about proper resizing, automatically.

Parameters:
w - The pointer to the dockwidget's child widget.

getWidget

public org.kde.qt.QWidget getWidget()
Get the embedded widget.

Returns:
The pointer to the dockwidget's child widget, 0L if there's no such child.

setHeader

public void setHeader(KDockWidgetAbstractHeader ah)
Sets the header of this dockwidget. A QLayout takes care about proper resizing, automatically. The header contains the drag panel, the close button and the stay button.

Parameters:
ah - A base class pointer to the dockwidget header

getHeader

public KDockWidgetAbstractHeader getHeader()
Since:
3.2 get the pointer to the header widget

makeDockVisible

public void makeDockVisible()
Normally it simply shows the dockwidget. But additionally, if it is docked to a tab widget (DockCenter), it is set as the active (visible) tab page.


mayBeHide

public boolean mayBeHide()
There are reasons that it's impossible:
  • It is a (tab) group.
  • It is already invisible ;-)
  • The parent of this is the KDockMainWindow.
  • It isn't able to dock to another widget.
  • @return If it may be possible to hide this.


    mayBeShow

    public boolean mayBeShow()
  • It is a (tab) group.
  • It is already visible ;-)
  • The parent of this is the KDockMainWindow.
  • @return If it may be possible to show this. There are reasons that it's impossible:


    dockManager

    public KDockManager dockManager()
    Returns:
    The dockmanager that is responsible for this.

    setToolTipString

    public void setToolTipString(java.lang.String ttStr)
    Stores a string for a tooltip. That tooltip string has only a meaning when this dockwidget is shown as tab page. In this case the tooltip is shown when one holds the mouse cursor on the tab page header. Such tooltip will for instance be useful, if you use only icons there. Note: Setting an empty string switches the tooltip off.

    Parameters:
    ttStr - A string for the tooltip on the tab.

    toolTipString

    public java.lang.String toolTipString()
    Returns:
    The tooltip string being shown on the appropriate tab page header when in dock-centered mode.

    isDockBackPossible

    public boolean isDockBackPossible()
    Returns:
    result true, if a dockback is possible, otherwise false.

    setTabPageLabel

    public void setTabPageLabel(java.lang.String label)
    Sets a string that is used for the label of the tab page when in tab page mode

    Parameters:
    label - The new tab page label.

    tabPageLabel

    public java.lang.String tabPageLabel()
    Returns:
    A string that is used for the label of the tab page when in tab page mode.

    event

    public boolean event(org.kde.qt.QEvent arg1)
    Catches and processes some QWidget events that are interesting for dockwidgets.

    Overrides:
    event in class org.kde.qt.QWidget

    show

    public void show()
    Add dockwidget management actions to QWidget.show.

    Overrides:
    show in class org.kde.qt.QWidget

    parentDockTabGroup

    public KDockTabGroup parentDockTabGroup()
    Returns:
    the parent widget of this if it inherits class KDockTabGroup

    parentDockContainer

    public org.kde.qt.QWidget parentDockContainer()

    setDockWindowType

    public void setDockWindowType(int windowType)
    Sets the type of the dock window

    Parameters:
    windowType - is type of dock window

    setDockWindowTransient

    public void setDockWindowTransient(org.kde.qt.QWidget parent,
                                       boolean transientEnabled)

    transientTo

    public org.kde.qt.QWidget transientTo()
    Returns the widget this dockwidget is set transient to, otherwise 0


    findNearestDockWidget

    public KDockWidget findNearestDockWidget(int pos)
    Lookup the nearest dockwidget docked left/right/top/bottom to this one or return 0

    Parameters:
    pos - is the position the wanted widget is docked to this one

    setPixmap

    public void setPixmap(org.kde.qt.QPixmap pixmap)
    Allows changing the pixmap which is used for the caption or dock tabs

    Parameters:
    pixmap - is the pixmap to set

    setPixmap

    public void setPixmap()

    pixmap

    public org.kde.qt.QPixmap pixmap()
    Returns the dockwidget's associated caption/dock tab pixmap


    currentDockPosition

    public int currentDockPosition()
    Returns:
    the current dock position.

    setForcedFixedWidth

    public void setForcedFixedWidth(int arg1)
    subject to changes. It doesn't completely work yet without small hacks from within the calling application (Perhaps KDE 3.1.x oder 3.2 width is in pixel. It only affects a widget, which is placed directly into a horizontal KDockSplitter


    setForcedFixedHeight

    public void setForcedFixedHeight(int arg1)
    subject to changes. It doesn't completely work yet without small hacks from within the calling application (Perhaps KDE 3.1.x oder 3.2 height is in pixel. It only affects a widget, which is placed directly into a vertical KDockSplitter


    restoreFromForcedFixedSize

    public void restoreFromForcedFixedSize()

    forcedFixedWidth

    public int forcedFixedWidth()

    forcedFixedHeight

    public int forcedFixedHeight()

    dockBack

    public void dockBack()
    Docks a dockwidget back to the dockwidget that was the neighbor widget before the current dock position.


    changeHideShowState

    public void changeHideShowState()
    Toggles the visibility state of the dockwidget if it is able to be shown or to be hidden.


    undock

    public void undock()
    Undocks this. It means it becomes a toplevel widget framed by the system window manager. A small panel at the top of this undocked widget gives the possibility to drag it into another dockwidget by mouse (docking).


    toDesktop

    public void toDesktop()
    Docks the widget to the desktop (as a toplevel widget)


    updateHeader

    protected void updateHeader()
    Checks some conditions and shows or hides the dockwidget header (drag panel). The header is hidden if:
  • the parent widget is the KDockMainWindow
  • this is a (tab) group dockwidget
  • it is not able to dock to another dockwidget
  • @short Checks some conditions and shows or hides the dockwidget header (drag panel).


    setLatestKDockContainer

    protected void setLatestKDockContainer(org.kde.qt.QWidget arg1)

    latestKDockContainer

    protected org.kde.qt.QWidget latestKDockContainer()

    setFormerBrotherDockWidget

    protected void setFormerBrotherDockWidget(KDockWidget arg1)

    loseFormerBrotherDockWidget

    protected void loseFormerBrotherDockWidget()
    Does several things here when it has noticed that the former brother widget (closest neighbor) gets lost. The former brother widget is needed for a possible dockback action, to speak with the Beatles: "To get back to where you once belonged" ;-)


    paintEvent

    protected void paintEvent(org.kde.qt.QPaintEvent arg1)
    Overrides:
    paintEvent in class org.kde.qt.QWidget

    mousePressEvent

    protected void mousePressEvent(org.kde.qt.QMouseEvent arg1)
    Overrides:
    mousePressEvent in class org.kde.qt.QWidget

    mouseReleaseEvent

    protected void mouseReleaseEvent(org.kde.qt.QMouseEvent arg1)
    Overrides:
    mouseReleaseEvent in class org.kde.qt.QWidget

    mouseMoveEvent

    protected void mouseMoveEvent(org.kde.qt.QMouseEvent arg1)
    Overrides:
    mouseMoveEvent in class org.kde.qt.QWidget

    leaveEvent

    protected void leaveEvent(org.kde.qt.QEvent arg1)
    Overrides:
    leaveEvent in class org.kde.qt.QWidget

    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