class PartManager

The part manager is an object which knows about a collection of parts (even nested ones) and handles activation/deactivation. More...

Full nameKParts::PartManager
Definition#include <partmanager.h>
InheritsQObject (qt) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Signals

Protected Methods

Protected Slots


Detailed Description

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().

enum SelectionPolicy { Direct, TriState }

SelectionPolicy

 PartManager ( QWidget * parent, const char * name = 0L )

PartManager

Constructs a part manager.

Parameters:
parentThe toplevel widget (window / dialog) the partmanager should monitor for activation/selection events

 PartManager ( QWidget * topLevel, QObject *parent, const char *name = 0 )

PartManager

Constructs a part manager.

Parameters:
topLevelThe toplevel widget (window / dialog ) the partmanager should monitor for activation/selection events
parentThe parent QObject.

 ~PartManager ()

~PartManager

[virtual]

void  setSelectionPolicy ( SelectionPolicy policy )

setSelectionPolicy

Sets the selection policy of the partmanager.

SelectionPolicy  selectionPolicy ()

selectionPolicy

[const]

Returns the current selection policy.

void  setAllowNestedParts ( bool allow )

setAllowNestedParts

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.

bool  allowNestedParts ()

allowNestedParts

[const]

See also: setAllowNestedParts

void  setIgnoreScrollBars ( bool ignore )

setIgnoreScrollBars

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).

bool  ignoreScrollBars ()

ignoreScrollBars

[const]

See also: setIgnoreScrollBars

bool  eventFilter ( QObject *obj, QEvent *ev )

eventFilter

[virtual]

void  addPart ( Part *part, bool setActive = true )

addPart

[virtual]

Adds a part to the manager.

Sets it to the active part automatically if setActive is true (default ).

void  removePart ( Part *part )

removePart

[virtual]

Removes a part from the manager (this does not delete the object) .

Sets the active part to 0 if part is the activePart() .

void  replacePart ( Part * oldPart, Part * newPart, bool setActive = true )

replacePart

[virtual]

Replaces oldPart with newPart, and sets newPart as active if setActive is true. This is an optimised version of removePart + addPart

void  setActivePart ( Part *part, QWidget *widget = 0L )

setActivePart

[virtual]

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 .

Part * activePart ()

activePart

[const virtual]

Returns the active part.

QWidgetactiveWidget ()

activeWidget

[const virtual]

Returns the active widget of the current active part (see activePart ).

void  setSelectedPart ( Part *part, QWidget *widget = 0L )

setSelectedPart

[virtual]

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 .

Part * selectedPart ()

selectedPart

[const virtual]

Returns the current selected part.

QWidgetselectedWidget ()

selectedWidget

[const virtual]

Returns the selected widget of the current selected part (see selectedPart ).

const QPtrListparts ()

parts

[const]

Returns the list of parts being managed by the partmanager.

void  addManagedTopLevelWidget ( const QWidget *topLevel )

addManagedTopLevelWidget

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.

void  removeManagedTopLevelWidget ( const QWidget *topLevel )

removeManagedTopLevelWidget

Removes the topLevel widget from the list of managed toplevel widgets.

See also: addManagedTopLevelWidget

void  partAdded ( KParts::Part *part )

partAdded

[signal]

Emitted when a new part has been added.

See also: addPart()

void  partRemoved ( KParts::Part *part )

partRemoved

[signal]

Emitted when a part has been removed.

See also: removePart()

void  activePartChanged ( KParts::Part *newPart )

activePartChanged

[signal]

Emitted when the active part has changed.

See also: setActivePart()

void  setActiveInstance ( KInstance * instance )

setActiveInstance

[protected virtual]

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.

void  slotObjectDestroyed ()

slotObjectDestroyed

[protected slots slot]

Removes a part when it is destroyed.

void  slotWidgetDestroyed ()

slotWidgetDestroyed

[protected slots slot]

void  slotManagedTopLevelWidgetDestroyed ()

slotManagedTopLevelWidgetDestroyed

[protected slots slot]

void  virtual_hook ( int id, void* data )

virtual_hook

[protected virtual]


Generated by: dfaure on faure on Tue Apr 16 08:50:22 2002, using kdoc 2.0a53.