---

KParts::PartManager Class Reference

#include <partmanager.h>

List of all members.

Signals
void	partAdded (KParts::Part *part)
void	partRemoved (KParts::Part *part)
void	activePartChanged (KParts::Part *newPart)
Public Methods
	PartManager (QWidget *parent, const char *name=0L)
	PartManager (QWidget *topLevel, QObject *parent, const char *name=0)
void	setSelectionPolicy (SelectionPolicy policy)
SelectionPolicy	selectionPolicy () const
void	setAllowNestedParts (bool allow)
bool	allowNestedParts () const
void	setIgnoreScrollBars (bool ignore)
bool	ignoreScrollBars () const
void	setActivationButtonMask (short int buttonMask)
short int	activationButtonMask () const
virtual void	addPart (Part *part, bool setActive=true)
virtual void	removePart (Part *part)
virtual void	replacePart (Part *oldPart, Part *newPart, bool setActive=true)
virtual void	setActivePart (Part *part, QWidget *widget=0L)
virtual Part *	activePart () const
virtual QWidget *	activeWidget () const
virtual void	setSelectedPart (Part *part, QWidget *widget=0L)
virtual Part *	selectedPart () const
virtual QWidget *	selectedWidget () const
const QPtrList< Part > *	parts () const
void	addManagedTopLevelWidget (const QWidget *topLevel)
void	removeManagedTopLevelWidget (const QWidget *topLevel)
Protected Slots
void	slotObjectDestroyed ()
Protected Methods
virtual void	setActiveInstance (KInstance *instance)

---

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

Definition at line 47 of file partmanager.h.

---

Constructor & Destructor Documentation

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

Constructs a part manager. Parameters: parent  The toplevel widget (window / dialog) the partmanager should monitor for activation/selection events

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

Constructs a part manager. Parameters: topLevel  The toplevel widget (window / dialog ) the partmanager should monitor for activation/selection events parent  The parent QObject.

---

Member Function Documentation

short int KParts::PartManager::activationButtonMask (    )

See also: setActivationButtonMask

virtual Part* KParts::PartManager::activePart (    )  [virtual]

Returns the active part.

void KParts::PartManager::activePartChanged (  KParts::Part *    newPart )  [signal]

Emitted when the active part has changed. See also: setActivePart()

virtual QWidget* KParts::PartManager::activeWidget (    )  [virtual]

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

void KParts::PartManager::addManagedTopLevelWidget (  const 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.

virtual void KParts::PartManager::addPart (  Part *    part, bool    setActive = true )  [virtual]

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

bool KParts::PartManager::allowNestedParts (    )

See also: setAllowNestedParts

bool KParts::PartManager::ignoreScrollBars (    )

See also: setIgnoreScrollBars

void KParts::PartManager::partAdded (  KParts::Part *    part )  [signal]

Emitted when a new part has been added. See also: addPart()

void KParts::PartManager::partRemoved (  KParts::Part *    part )  [signal]

Emitted when a part has been removed. See also: removePart()

const QPtrList<Part>* KParts::PartManager::parts (    )

Returns the list of parts being managed by the partmanager.

void KParts::PartManager::removeManagedTopLevelWidget (  const QWidget *    topLevel )

Removes the topLevel widget from the list of managed toplevel widgets. See also: addManagedTopLevelWidget

virtual void KParts::PartManager::removePart (  Part *    part )  [virtual]

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

virtual void KParts::PartManager::replacePart (  Part *    oldPart, Part *    newPart, bool    setActive = true )  [virtual]

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

virtual Part* KParts::PartManager::selectedPart (    )  [virtual]

Returns the current selected part.

virtual QWidget* KParts::PartManager::selectedWidget (    )  [virtual]

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

SelectionPolicy KParts::PartManager::selectionPolicy (    )

Returns the current selection policy.

void KParts::PartManager::setActivationButtonMask (  short int    buttonMask )

Specifies which mouse buttons the partmanager should react upon. By default it reacts on all mouse buttons (LMB/MMB/RMB). Parameters: mouseButtons  a combination of Qt::ButtonState values e.g. Qt::LeftButton | Qt::MidButton

virtual void KParts::PartManager::setActiveInstance (  KInstance *    instance )  [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.

virtual void KParts::PartManager::setActivePart (  Part *    part, QWidget *    widget = 0L )  [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 .

void KParts::PartManager::setAllowNestedParts (  bool    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.

void KParts::PartManager::setIgnoreScrollBars (  bool    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).

virtual void KParts::PartManager::setSelectedPart (  Part *    part, QWidget *    widget = 0L )  [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 .

void KParts::PartManager::setSelectionPolicy (  SelectionPolicy    policy )

Sets the selection policy of the partmanager.

void KParts::PartManager::slotObjectDestroyed (    )  [protected, slot]

Removes a part when it is destroyed.

---

The documentation for this class was generated from the following file:

• partmanager.h

---