org.kde.koala
Class PartManager

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

public class PartManager
extends org.kde.qt.QObject

The part manager is an object which knows about a collection of parts (even nested ones) and handles activation/deactivation. Applications that want to embed parts without merging GUIs only use a KParts.PartManager. Those who want to merge GUIs use a KParts.MainWindow for example, in addition to a part manager. Parts know about the part manager to add nested parts to it. See also KParts.Part.manager() and KParts.Part.setManager(). See PartManagerSignals for signals emitted by PartManager


Field Summary
 
Fields inherited from class org.kde.qt.Qt
AlignAuto, AlignBottom, AlignCenter, AlignHCenter, AlignHorizontal_Mask, AlignJustify, AlignLeft, AlignRight, AlignTop, AlignVCenter, AlignVertical_Mask, AlphaDither_Mask, ALT, AltButton, AnchorHref, AnchorName, AndNotROP, AndROP, ArrowCursor, Ascending, ASCII_ACCEL, AutoColor, AutoDither, AutoText, AvoidDither, BDiagPattern, BeginsWith, BevelJoin, BitmapCursor, BlankCursor, Bottom, BottomLeft, BottomRight, BreakAnywhere, BusyCursor, CaseSensitive, ClearROP, ColorMode_Mask, ColorOnly, Contains, ControlButton, CopyROP, CrossCursor, CrossPattern, CTRL, CustomPattern, DashDotDotLine, DashDotLine, DashLine, Dense1Pattern, Dense2Pattern, Dense3Pattern, Dense4Pattern, Dense5Pattern, Dense6Pattern, Dense7Pattern, Descending, DiagCrossPattern, DiffuseAlphaDither, DiffuseDither, Dither_Mask, DitherMode_Mask, DockBottom, DockLeft, DockMinimized, DockRight, DockTop, DockTornOff, DockUnmanaged, DontClip, DontPrint, DotLine, DownArrow, EndsWith, EraseROP, ExactMatch, ExpandTabs, FDiagPattern, FixedColor, FixedPixmap, FlatCap, ForbiddenCursor, HiEnglishUnit, HiMetricUnit, Horizontal, HorPattern, IbeamCursor, Identical, IncludeTrailingSpaces, ISODate, Key_0, Key_1, Key_2, Key_3, Key_4, Key_5, Key_6, Key_7, Key_8, Key_9, Key_A, Key_aacute, Key_Aacute, Key_acircumflex, Key_Acircumflex, Key_acute, Key_adiaeresis, Key_Adiaeresis, Key_ae, Key_AE, Key_agrave, Key_Agrave, Key_Alt, Key_Ampersand, Key_Any, Key_Apostrophe, Key_aring, Key_Aring, Key_AsciiCircum, Key_AsciiTilde, Key_Asterisk, Key_At, Key_atilde, Key_Atilde, Key_B, Key_Back, Key_Backslash, Key_Backspace, Key_BackSpace, Key_Backtab, Key_BackTab, Key_Bar, Key_BassBoost, Key_BassDown, Key_BassUp, Key_BraceLeft, Key_BraceRight, Key_BracketLeft, Key_BracketRight, Key_brokenbar, Key_C, Key_CapsLock, Key_ccedilla, Key_Ccedilla, Key_cedilla, Key_cent, Key_Clear, Key_Colon, Key_Comma, Key_Control, Key_copyright, Key_currency, Key_D, Key_degree, Key_Delete, Key_diaeresis, Key_Direction_L, Key_Direction_R, Key_division, Key_Dollar, Key_Down, Key_E, Key_eacute, Key_Eacute, Key_ecircumflex, Key_Ecircumflex, Key_ediaeresis, Key_Ediaeresis, Key_egrave, Key_Egrave, Key_End, Key_Enter, Key_Equal, Key_Escape, Key_eth, Key_ETH, Key_Exclam, Key_exclamdown, Key_F, Key_F1, Key_F10, Key_F11, Key_F12, Key_F13, Key_F14, Key_F15, Key_F16, Key_F17, Key_F18, Key_F19, Key_F2, Key_F20, Key_F21, Key_F22, Key_F23, Key_F24, Key_F25, Key_F26, Key_F27, Key_F28, Key_F29, Key_F3, Key_F30, Key_F31, Key_F32, Key_F33, Key_F34, Key_F35, Key_F4, Key_F5, Key_F6, Key_F7, Key_F8, Key_F9, Key_Favorites, Key_Forward, Key_G, Key_Greater, Key_guillemotleft, Key_guillemotright, Key_H, Key_Help, Key_Home, Key_HomePage, Key_Hyper_L, Key_Hyper_R, Key_hyphen, Key_I, Key_iacute, Key_Iacute, Key_icircumflex, Key_Icircumflex, Key_idiaeresis, Key_Idiaeresis, Key_igrave, Key_Igrave, Key_Insert, Key_J, Key_K, Key_L, Key_Launch0, Key_Launch1, Key_Launch2, Key_Launch3, Key_Launch4, Key_Launch5, Key_Launch6, Key_Launch7, Key_Launch8, Key_Launch9, Key_LaunchA, Key_LaunchB, Key_LaunchC, Key_LaunchD, Key_LaunchE, Key_LaunchF, Key_LaunchMail, Key_LaunchMedia, Key_Left, Key_Less, Key_M, Key_macron, Key_masculine, Key_MediaLast, Key_MediaNext, Key_MediaPlay, Key_MediaPrev, Key_MediaRecord, Key_MediaStop, Key_Menu, Key_Meta, Key_Minus, Key_mu, Key_multiply, Key_N, Key_Next, Key_nobreakspace, Key_notsign, Key_ntilde, Key_Ntilde, Key_NumberSign, Key_NumLock, Key_O, Key_oacute, Key_Oacute, Key_ocircumflex, Key_Ocircumflex, Key_odiaeresis, Key_Odiaeresis, Key_ograve, Key_Ograve, Key_onehalf, Key_onequarter, Key_onesuperior, Key_Ooblique, Key_OpenUrl, Key_ordfeminine, Key_oslash, Key_otilde, Key_Otilde, Key_P, Key_PageDown, Key_PageUp, Key_paragraph, Key_ParenLeft, Key_ParenRight, Key_Pause, Key_Percent, Key_Period, Key_periodcentered, Key_Plus, Key_plusminus, Key_Print, Key_Prior, Key_Q, Key_Question, Key_questiondown, Key_QuoteDbl, Key_QuoteLeft, Key_R, Key_Refresh, Key_registered, Key_Return, Key_Right, Key_S, Key_ScrollLock, Key_Search, Key_section, Key_Semicolon, Key_Shift, Key_Slash, Key_Space, Key_ssharp, Key_Standby, Key_sterling, Key_Stop, Key_Super_L, Key_Super_R, Key_SysReq, Key_T, Key_Tab, Key_thorn, Key_THORN, Key_threequarters, Key_threesuperior, Key_TrebleDown, Key_TrebleUp, Key_twosuperior, Key_U, Key_uacute, Key_Uacute, Key_ucircumflex, Key_Ucircumflex, Key_udiaeresis, Key_Udiaeresis, Key_ugrave, Key_Ugrave, Key_Underscore, Key_unknown, Key_Up, Key_V, Key_VolumeDown, Key_VolumeMute, Key_VolumeUp, Key_W, Key_X, Key_Y, Key_yacute, Key_Yacute, Key_ydiaeresis, Key_yen, Key_Z, KeyButtonMask, Keypad, LastCursor, LastROP, Left, LeftArrow, LeftButton, LocalDate, LocalTime, LoEnglishUnit, LogText, LoMetricUnit, MacStyle, META, MetaButton, MidButton, Minimized, MiterJoin, MODIFIER_MASK, MonoOnly, MotifStyle, MouseButtonMask, MPenCapStyle, MPenJoinStyle, MPenStyle, MV_10_DOT_0, MV_10_DOT_1, MV_10_DOT_2, MV_10_DOT_3, MV_10_DOT_4, MV_9, MV_CHEETAH, MV_JAGUAR, MV_PANTHER, MV_PUMA, MV_TIGER, MV_Unknown, NandROP, NoAccel, NoAlpha, NoBackground, NoBrush, NoButton, NoMatch, NoPen, NopROP, NorROP, NotAndROP, NotCopyROP, NotEraseROP, NotOrROP, NotROP, NotXorROP, OpaqueMode, OrderedAlphaDither, OrderedDither, OrNotROP, OrROP, Overline, PaletteBackground, PaletteBase, PaletteBrightText, PaletteButton, PaletteButtonText, PaletteDark, PaletteForeground, PaletteHighlight, PaletteHighlightedText, PaletteLight, PaletteLink, PaletteLinkVisited, PaletteMid, PaletteMidlight, PaletteShadow, PaletteText, PartialMatch, PixelUnit, PlainText, PMStyle, PointingHandCursor, PreferDither, RichText, Right, RightArrow, RightButton, RoundCap, RoundJoin, SetROP, SHIFT, ShiftButton, ShowPrefix, SingleLine, SizeAllCursor, SizeBDiagCursor, SizeFDiagCursor, SizeHorCursor, SizeVerCursor, SolidLine, SolidPattern, SplitHCursor, SplitVCursor, SquareCap, StrikeOut, TextDate, ThresholdAlphaDither, ThresholdDither, Top, TopLeft, TopRight, TornOff, TransparentMode, TwipsUnit, UI_AnimateCombo, UI_AnimateMenu, UI_AnimateToolBox, UI_AnimateTooltip, UI_FadeMenu, UI_FadeTooltip, UI_General, Underline, UNICODE_ACCEL, Unmanaged, UpArrow, UpArrowCursor, UTC, VerPattern, Vertical, WaitCursor, WDestructiveClose, WGroupLeader, WhatsThisCursor, Win3Style, WindowActive, WindowFullScreen, WindowMaximized, WindowMinimized, WindowNoState, WindowsStyle, WMacDrawer, WMacNoSheet, WMouseNoMask, WNoAutoErase, WNoMousePropagation, WNorthWestGravity, WordBreak, WPaintClever, WPaintDesktop, WPaintUnclipped, WRepaintNoErase, WResizeNoErase, WShowModal, WState_AutoMask, WState_BlockUpdates, WState_CompressKeys, WState_ConfigPending, WState_Created, WState_CreatedHidden, WState_Disabled, WState_DND, WState_Exposed, WState_ForceDisabled, WState_ForceHide, WState_FullScreen, WState_HasMouse, WState_InPaintEvent, WState_Maximized, WState_Minimized, WState_MouseTracking, WState_OwnCursor, WState_OwnSizePolicy, WState_Polished, WState_Reparented, WState_Reserved0, WState_Resized, WState_Visible, WStaticContents, WStyle_ContextHelp, WStyle_Customize, WStyle_Dialog, WStyle_DialogBorder, WStyle_Mask, WStyle_Maximize, WStyle_Minimize, WStyle_MinMax, WStyle_NoBorder, WStyle_NoBorderEx, WStyle_NormalBorder, WStyle_Reserved, WStyle_Splash, WStyle_StaysOnTop, WStyle_SysMenu, WStyle_Title, WStyle_Tool, WSubWindow, WType_Desktop, WType_Dialog, WType_Mask, WType_Modal, WType_Popup, WType_TopLevel, WV_2000, WV_2003, WV_32s, WV_95, WV_98, WV_CE, WV_CE_based, WV_CENET, WV_DOS_based, WV_Me, WV_NT, WV_NT_based, WV_XP, WWinOwnDC, WX11BypassWM, X11ParentRelative, XorROP
 
Constructor Summary
protected PartManager(java.lang.Class dummy)
           
  PartManager(org.kde.qt.QWidget parent)
           
  PartManager(org.kde.qt.QWidget topLevel, org.kde.qt.QObject parent)
           
  PartManager(org.kde.qt.QWidget topLevel, org.kde.qt.QObject parent, java.lang.String name)
          Constructs a part manager.
  PartManager(org.kde.qt.QWidget parent, java.lang.String name)
          Constructs a part manager.
 
Method Summary
 short activationButtonMask()
           
 Part activePart()
          Returns the active part.
 org.kde.qt.QWidget activeWidget()
          Returns the active widget of the current active part (see activePart()).
 void addManagedTopLevelWidget(org.kde.qt.QWidget topLevel)
          Adds the topLevel widget to the list of managed toplevel widgets.
 void addPart(Part part)
           
 void addPart(Part part, boolean setActive)
          Adds a part to the manager.
 boolean allowNestedParts()
           
 java.lang.String className()
           
 boolean eventFilter(org.kde.qt.QObject arg1, org.kde.qt.QEvent ev)
           
 boolean ignoreScrollBars()
           
 org.kde.qt.QMetaObject metaObject()
           
 int reason()
           
 void removeManagedTopLevelWidget(org.kde.qt.QWidget topLevel)
          Removes the topLevel widget from the list of managed toplevel widgets.
 void removePart(Part part)
          Removes a part from the manager (this does not delete the object) .
 void replacePart(Part oldPart, Part newPart)
           
 void replacePart(Part oldPart, Part newPart, boolean setActive)
          Replaces oldPart with newPart, and sets newPart as active if setActive is true.
 Part selectedPart()
          Returns the current selected part.
 org.kde.qt.QWidget selectedWidget()
          Returns the selected widget of the current selected part (see selectedPart()).
 void setActivationButtonMask(short buttonMask)
          Specifies which mouse buttons the partmanager should react upon.
protected  void setActiveInstance(KInstanceInterface instance)
          Changes the active instance when the active part changes.
 void setActivePart(Part part)
           
 void setActivePart(Part part, org.kde.qt.QWidget widget)
          Sets the active part.
 void setAllowNestedParts(boolean allow)
          Specifies whether the partmanager should handle/allow nested parts or not.
 void setIgnoreScrollBars(boolean ignore)
          Specifies whether the partmanager should ignore mouse click events for scrollbars or not.
 void setSelectedPart(Part part)
           
 void setSelectedPart(Part part, org.kde.qt.QWidget widget)
          Sets the selected part.
protected  void slotManagedTopLevelWidgetDestroyed()
           
protected  void slotObjectDestroyed()
          Removes a part when it is destroyed.
protected  void slotWidgetDestroyed()
           
 
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, dispose, dumpObjectInfo, dumpObjectTree, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, event, finalize, highPriority, i18n, inherits, insertChild, installEventFilter, isA, isDisposed, isWidgetType, killTimer, killTimers, name, name, normalizeSignalSlot, objectTrees, parent, property, queryList, queryList, queryList, queryList, queryList, registerUserData, removeChild, removeEventFilter, sender, setName, setProperty, signalsBlocked, startTimer, timerEvent, tr, tr
 
Methods inherited from class org.kde.qt.Qt
arrowCursor, bin, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, black, blankCursor, blue, color0, color1, copyBlt, copyBlt, copyBlt, copyBlt, copyBlt, crossCursor, cyan, darkBlue, darkCyan, darkGray, darkGreen, darkMagenta, darkRed, darkYellow, dec, dynamicCast, endl, flush, forbiddenCursor, fromUtf8, gray, green, hex, ibeamCursor, lightGray, magenta, oct, op_div, op_div, op_div, op_div, op_equals, op_equals, op_equals, op_equals, op_minus, op_minus, op_minus, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_not_equals, op_not_equals, op_not_equals, op_not_equals, op_plus, op_plus, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, pointingHandCursor, qAlpha, qApp, qAppName, qBlue, qCompress, qCompress, qDebug, qDebug, qDrawArrow, qDrawItem, qDrawItem, qDrawItem, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qFatal, qFatal, qGLVersion, qGray, qGray, qGreen, qInitNetworkProtocols, qInstallPath, qInstallPathBins, qInstallPathData, qInstallPathDocs, qInstallPathHeaders, qInstallPathLibs, qInstallPathPlugins, qInstallPathSysconf, qInstallPathTranslations, qItemRect, qItemRect, qObsolete, qObsolete, qObsolete, qRed, qRgb, qRgba, qRound, qSharedBuild, qSuppressObsoleteWarnings, qSuppressObsoleteWarnings, qSysInfo, qSystemWarning, qSystemWarning, qUncompress, qUncompress, qVersion, qWarning, qWarning, red, reset, SIGNAL, sizeAllCursor, sizeBDiagCursor, sizeFDiagCursor, sizeHorCursor, sizeVerCursor, SLOT, splitHCursor, splitVCursor, upArrowCursor, waitCursor, whatsThisCursor, white, ws, yellow
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PartManager

protected PartManager(java.lang.Class dummy)

PartManager

public PartManager(org.kde.qt.QWidget parent,
                   java.lang.String name)
Constructs a part manager.

Parameters:
parent - The toplevel widget (window / dialog) the partmanager should monitor for activation/selection events
name - The object's name, if any.

PartManager

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

PartManager

public PartManager(org.kde.qt.QWidget topLevel,
                   org.kde.qt.QObject parent,
                   java.lang.String name)
Constructs a part manager.

Parameters:
topLevel - The toplevel widget (window / dialog ) the partmanager should monitor for activation/selection events
parent - The parent QObject.
name - The object's name, if any.

PartManager

public PartManager(org.kde.qt.QWidget topLevel,
                   org.kde.qt.QObject parent)
Method Detail

metaObject

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

className

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

setAllowNestedParts

public void setAllowNestedParts(boolean allow)
Specifies whether the partmanager should handle/allow nested parts or not. This is a property the shell has to set/specify. Per default we assume that the shell cannot handle nested parts. However in case of a KOffice shell for example we allow nested parts. A Part is nested (a child part) if its parent object inherits KParts.Part. If a child part is activated and nested parts are not allowed/handled, then the top parent part in the tree is activated.


allowNestedParts

public boolean allowNestedParts()
See Also:
setAllowNestedParts(boolean)

setIgnoreScrollBars

public void setIgnoreScrollBars(boolean ignore)
Specifies whether the partmanager should ignore mouse click events for scrollbars or not. If the partmanager ignores them, then clicking on the scrollbars of a non-active/non-selected part will not change the selection or activation state. The default value is false (read: scrollbars are NOT ignored).


ignoreScrollBars

public boolean ignoreScrollBars()
See Also:
setIgnoreScrollBars(boolean)

setActivationButtonMask

public void setActivationButtonMask(short buttonMask)
Specifies which mouse buttons the partmanager should react upon. By default it reacts on all mouse buttons (LMB/MMB/RMB).

Parameters:
buttonMask - a combination of Qt.ButtonState values e.g. Qt.LeftButton | Qt.MidButton

activationButtonMask

public short activationButtonMask()
See Also:
setActivationButtonMask(short)

eventFilter

public boolean eventFilter(org.kde.qt.QObject arg1,
                           org.kde.qt.QEvent ev)
Overrides:
eventFilter in class org.kde.qt.QObject

addPart

public void addPart(Part part,
                    boolean setActive)
Adds a part to the manager. Sets it to the active part automatically if setActive is true (default ). Behavior fix in KDE3.4: the part's widget is shown only if setActive is true, it used to be shown in all cases before.


addPart

public void addPart(Part part)

removePart

public void removePart(Part part)
Removes a part from the manager (this does not delete the object) . Sets the active part to 0 if part is the activePart() .


replacePart

public void replacePart(Part oldPart,
                        Part newPart,
                        boolean setActive)
Replaces oldPart with newPart, and sets newPart as active if setActive is true. This is an optimised version of removePart + addPart


replacePart

public void replacePart(Part oldPart,
                        Part newPart)

setActivePart

public void setActivePart(Part part,
                          org.kde.qt.QWidget widget)
Sets the active part. The active part receives activation events. widget can be used to specify which widget was responsible for the activation. This is important if you have multiple views for a document/part, like in KOffice.


setActivePart

public void setActivePart(Part part)

activePart

public Part activePart()
Returns the active part.


activeWidget

public org.kde.qt.QWidget activeWidget()
Returns the active widget of the current active part (see activePart()).


setSelectedPart

public void setSelectedPart(Part part,
                            org.kde.qt.QWidget widget)
Sets the selected part. The selected part receives selection events. widget can be used to specify which widget was responsible for the selection. This is important if you have multiple views for a document/part, like in KOffice.


setSelectedPart

public void setSelectedPart(Part part)

selectedPart

public Part selectedPart()
Returns the current selected part.


selectedWidget

public org.kde.qt.QWidget selectedWidget()
Returns the selected widget of the current selected part (see selectedPart()).


addManagedTopLevelWidget

public void addManagedTopLevelWidget(org.kde.qt.QWidget topLevel)
Adds the topLevel widget to the list of managed toplevel widgets. Usually a PartManager only listens for events (for activation/selection) for one toplevel widget (and its children), the one specified in the constructor. Sometimes however (like for example when using the KDE dockwidget library), it is necessary to extend this.


removeManagedTopLevelWidget

public void removeManagedTopLevelWidget(org.kde.qt.QWidget topLevel)
Removes the topLevel widget from the list of managed toplevel widgets.

See Also:
addManagedTopLevelWidget(org.kde.qt.QWidget)

reason

public int reason()
Returns:
the reason for the last activePartChanged signal emitted.
See Also:
Reason

setActiveInstance

protected void setActiveInstance(KInstanceInterface instance)
Changes the active instance when the active part changes. The active instance is used by KBugReport and KAboutDialog. Override if you really need to - usually you don't need to.


slotObjectDestroyed

protected void slotObjectDestroyed()
Removes a part when it is destroyed.


slotWidgetDestroyed

protected void slotWidgetDestroyed()

slotManagedTopLevelWidgetDestroyed

protected void slotManagedTopLevelWidgetDestroyed()