<HTML> <HEAD> <TITLE>Source: partmanager.h</TITLE> <META NAME="Generator" CONTENT="KDOC "> </HEAD> <BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff"> <TABLE WIDTH="100%" BORDER="0"> <TR> <TD> <TABLE BORDER="0"> <TR><TD valign="top" align="left" cellspacing="10"> <h1>Source: partmanager.h</h1> </TD> <TD valign="top" align="right" colspan="1"></TD></TR> </TABLE> <HR> <TABLE BORDER="0"> </TABLE> </TD> <TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR> <TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR> <TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR> <TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR> <TR><TD><small><A HREF="index.html">Index</A></small></TD></TR> </TABLE></TD></TR></TABLE> <pre> /* This file is part of the KDE project Copyright (C) 1999 Simon Hausmann <hausmann@kde.org> (C) 1999 David Faure <faure@kde.org> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifndef __kpartmanager_h__ #define __kpartmanager_h__ #include <qobject.h> #include <qwidget.h> #include <qlist.h> class KInstance; namespace KParts { class Part; class PartManagerPrivate; /** * 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 @ref KParts::PartManager. Those who want to merge GUIs use a * @ref KParts::MainWindow for example, in addition to a part manager. * * Parts know about the part manager to add nested parts to it. * See also @ref KParts::Part::manager() and @ref KParts::Part::setManager(). */ class PartManager : public QObject { Q_OBJECT Q_ENUMS( SelectionPolicy ) Q_PROPERTY( SelectionPolicy selectionPolicy READ selectionPolicy WRITE setSelectionPolicy ) Q_PROPERTY( bool allowNestedParts READ allowNestedParts WRITE setAllowNestedParts ) Q_PROPERTY( bool ignoreScrollBars READ ignoreScrollBars WRITE setIgnoreScrollBars ) public: // the default policy of a PartManager is Direct! enum SelectionPolicy { Direct, TriState }; /** * Create a part manager. * * @param parent The toplevel widget (window / dialog) the * partmanager should monitor for activation/selection * events */ PartManager( QWidget * parent, const char * name = 0L ); /** * Create a part manager. * * @param topLevel The toplevel widget (window / dialog ) the * partmanager should monitor for activation/selection * events * @param parent The parent QObject. */ PartManager( QWidget * topLevel, QObject *parent, const char *name = 0 ); virtual ~PartManager(); /** * Set the selection policy of the partmanager. */ void setSelectionPolicy( SelectionPolicy policy ); /** * Retrieve the current selection policy. */ SelectionPolicy selectionPolicy() const; /** * Specify 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 @ref 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 setAllowNestedParts( bool allow ); /** * @see setAllowNestedParts */ bool allowNestedParts() const; /** * Specify 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). */ void setIgnoreScrollBars( bool ignore ); /** * @see setIgnoreScrollBars */ bool ignoreScrollBars() const; /** * @internal */ virtual bool eventFilter( QObject *obj, QEvent *ev ); /** * Add a Part to the manager. * * Sets it to the active part automatically if @p setActive is true (default ). */ virtual void addPart( Part *part, bool setActive = true ); /** * Remove a part from the manager (this does not delete the object) . * * Sets the active part to 0 if @p part is the @ref activePart() . */ virtual void removePart( Part *part ); /** * Replaces @p oldPart with @p newPart, and sets @p newPart as active if * @p setActive is true. * This is an optimised version of @ref removePart + @ref addPart */ virtual void replacePart( Part * oldPart, Part * newPart, bool setActive = true ); /** * Set the active part. * * The active part receives activation events. * * @p 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 . */ virtual void setActivePart( Part *part, QWidget *widget = 0L ); /** * Retrieve the active part. **/ virtual Part *activePart() const; /** * Retrieve the active widget of the current active part (see @ref activePart ). */ virtual QWidget *activeWidget() const; /** * Set the selected part. * * The selected part receives selection events. * * @p 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 . */ virtual void setSelectedPart( Part *part, QWidget *widget = 0L ); /** * Retrieve the current selected part. */ virtual Part *selectedPart() const; /** * Retrieve the selected widget of the current selected part (see @ref selectedPart ). */ virtual QWidget *selectedWidget() const; /** * Retrieve the list of parts being managed by the partmanager. */ const QList<Part> *parts() const; /** * Adds the @p 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 addManagedTopLevelWidget( const QWidget *topLevel ); /** * Removes the @p topLevel widget from the list of managed toplevel widgets. * @see addManagedTopLevelWidget */ void removeManagedTopLevelWidget( const QWidget *topLevel ); signals: /** * Emitted when a new part has been added. * @see addPart() **/ void partAdded( KParts::Part *part ); /** * Emitted when a part has been removed. * @see removePart() **/ void partRemoved( KParts::Part *part ); /** * Emitted when the active part has changed. * @see setActivePart() **/ void activePartChanged( KParts::Part *newPart ); protected: /** * 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 setActiveInstance( KInstance * instance ); protected slots: /** * Removes a part when it is destroyed. **/ void slotObjectDestroyed(); /** * @internal */ void slotWidgetDestroyed(); /** * @internal */ void slotManagedTopLevelWidgetDestroyed(); private: Part * findPartFromWidget( QWidget * widget, const QPoint &pos ); Part * findPartFromWidget( QWidget * widget ); PartManagerPrivate *d; }; }; #endif </pre> <HR> <table> <tr><td><small>Generated by: qateam on updates.mandrakesoft.com on Mon Dec 30 16:09:25 2002, using kdoc 2.0a53.</small></td></tr> </table> </BODY> </HTML>