KParts::PartManager

#include <KParts/PartManager>

Inheritance diagram for KParts::PartManager:

Public Types

enum  Reason { ReasonLeftClick = 100, ReasonMidClick, ReasonRightClick, NoReason }
 
enum  SelectionPolicy { Direct, TriState }
 

Properties

bool allowNestedParts
 
bool ignoreScrollBars
 
SelectionPolicy selectionPolicy
 
- Properties inherited from QObject
 objectName
 

Signals

void activePartChanged (KParts::Part *newPart)
 
void partAdded (KParts::Part *part)
 
void partRemoved (KParts::Part *part)
 

Public Member Functions

 PartManager (QWidget *parent)
 
 PartManager (QWidget *topLevel, QObject *parent)
 
short int activationButtonMask () const
 
virtual PartactivePart () const
 
virtual QWidgetactiveWidget () const
 
void addManagedTopLevelWidget (const QWidget *topLevel)
 
virtual void addPart (Part *part, bool setActive=true)
 
bool allowNestedParts () const
 
bool eventFilter (QObject *obj, QEvent *ev) override
 
bool ignoreScrollBars () const
 
const QList< Part * > parts () const
 
int reason () const
 
void removeManagedTopLevelWidget (const QWidget *topLevel)
 
virtual void removePart (Part *part)
 
virtual void replacePart (Part *oldPart, Part *newPart, bool setActive=true)
 
virtual PartselectedPart () const
 
virtual QWidgetselectedWidget () const
 
SelectionPolicy selectionPolicy () const
 
void setActivationButtonMask (short int buttonMask)
 
virtual void setActivePart (Part *part, QWidget *widget=nullptr)
 
void setAllowNestedParts (bool allow)
 
void setIgnoreScrollBars (bool ignore)
 
virtual void setSelectedPart (Part *part, QWidget *widget=nullptr)
 
void setSelectionPolicy (SelectionPolicy policy)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Slots

void slotManagedTopLevelWidgetDestroyed ()
 
void slotObjectDestroyed ()
 
void slotWidgetDestroyed ()
 

Protected Member Functions

void setIgnoreExplictFocusRequests (bool)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

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 36 of file partmanager.h.

Member Enumeration Documentation

This extends QFocusEvent::Reason with the non-focus-event reasons for partmanager to activate a part.

To test for "any focusin reason", use < ReasonLeftClick NoReason usually means: explicit activation with setActivePart.

Definition at line 52 of file partmanager.h.

Selection policy. The default policy of a PartManager is Direct.

Definition at line 44 of file partmanager.h.

Constructor & Destructor Documentation

PartManager::PartManager ( QWidget parent)

Constructs a part manager.

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

Definition at line 105 of file partmanager.cpp.

PartManager::PartManager ( QWidget topLevel,
QObject parent 
)

Constructs a part manager.

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

Definition at line 116 of file partmanager.cpp.

Member Function Documentation

short int PartManager::activationButtonMask ( ) const
See also
setActivationButtonMask

Definition at line 178 of file partmanager.cpp.

Part * PartManager::activePart ( ) const
virtual

Returns the active part.

Definition at line 491 of file partmanager.cpp.

void KParts::PartManager::activePartChanged ( KParts::Part newPart)
signal

Emitted when the active part has changed.

See also
setActivePart()
QWidget * PartManager::activeWidget ( ) const
virtual

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

Definition at line 496 of file partmanager.cpp.

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

Definition at line 568 of file partmanager.cpp.

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

Definition at line 341 of file partmanager.cpp.

bool KParts::PartManager::allowNestedParts ( ) const
bool PartManager::eventFilter ( QObject obj,
QEvent ev 
)
overridevirtual

Reimplemented from QObject.

Definition at line 183 of file partmanager.cpp.

bool KParts::PartManager::ignoreScrollBars ( ) const
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 QList< Part * > PartManager::parts ( ) const

Returns the list of parts being managed by the partmanager.

Definition at line 563 of file partmanager.cpp.

int PartManager::reason ( ) const
Returns
the reason for the last activePartChanged signal emitted.
See also
Reason

Definition at line 594 of file partmanager.cpp.

void PartManager::removeManagedTopLevelWidget ( const QWidget topLevel)

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

See also
addManagedTopLevelWidget

Definition at line 583 of file partmanager.cpp.

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

Definition at line 377 of file partmanager.cpp.

void 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

Definition at line 400 of file partmanager.cpp.

Part * PartManager::selectedPart ( ) const
virtual

Returns the current selected part.

Deprecated:
Since 5.72, for lack of usage.

Definition at line 534 of file partmanager.cpp.

QWidget * PartManager::selectedWidget ( ) const
virtual

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

Deprecated:
Since 5.72, for lack of usage.

Definition at line 542 of file partmanager.cpp.

SelectionPolicy KParts::PartManager::selectionPolicy ( ) const

Returns the current selection policy.

void 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
buttonMaska combination of Qt::ButtonState values e.g. Qt::LeftButton | Qt::MiddleButton

Definition at line 173 of file partmanager.cpp.

void PartManager::setActivePart ( Part part,
QWidget widget = nullptr 
)
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 .

Definition at line 417 of file partmanager.cpp.

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

Definition at line 153 of file partmanager.cpp.

void PartManager::setIgnoreExplictFocusRequests ( bool  ignore)
protected

Sets whether the PartManager ignores explict set focus requests from the part.

By default this option is set to false. Set it to true to prevent the part from sending explicit set focus requests to the client application.

Since
4.10

Definition at line 599 of file partmanager.cpp.

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

Definition at line 163 of file partmanager.cpp.

void PartManager::setSelectedPart ( Part part,
QWidget widget = nullptr 
)
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 .

Deprecated:
Since 5.72, for lack of usage.

Definition at line 502 of file partmanager.cpp.

void PartManager::setSelectionPolicy ( SelectionPolicy  policy)

Sets the selection policy of the partmanager.

Definition at line 143 of file partmanager.cpp.

void PartManager::slotManagedTopLevelWidgetDestroyed ( )
protectedslot

Definition at line 588 of file partmanager.cpp.

void PartManager::slotObjectDestroyed ( )
protectedslot

Removes a part when it is destroyed.

Definition at line 548 of file partmanager.cpp.

void PartManager::slotWidgetDestroyed ( )
protectedslot

Definition at line 554 of file partmanager.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Sep 24 2020 22:55:21 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.