• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KDE3Support

  • KParts
  • DockMainWindow3
Public Member Functions | Protected Slots | Protected Member Functions
KParts::DockMainWindow3 Class Reference

#include <dockmainwindow3.h>

Inheritance diagram for KParts::DockMainWindow3:
K3DockMainWindow KParts::PartBase KXmlGuiWindow KXMLGUIClient KMainWindow KXMLGUIBuilder KXMLGUIClient QMainWindow

List of all members.

Public Member Functions

 DockMainWindow3 (QWidget *parent=0L, const char *name=0L, Qt::WindowFlags f=0)
virtual ~DockMainWindow3 ()
- Public Member Functions inherited from K3DockMainWindow
 K3DockMainWindow (QWidget *parent=0L, const char *name=0L, Qt::WindowFlags f=Qt::Window)
virtual ~K3DockMainWindow ()
void activateDock ()
K3DockWidget * createDockWidget (const QString &name, const QPixmap &pixmap, QWidget *parent=0L, const QString &strCaption=QString(), const QString &strTabPageLabel=QLatin1String(" "))
Q3PopupMenu * dockHideShowMenu () const
K3DockWidget * getMainDockWidget () const
void makeDockInvisible (K3DockWidget *dock)
void makeDockVisible (K3DockWidget *dock)
void makeWidgetDockVisible (QWidget *widget)
K3DockManager * manager () const
void readDockConfig (QDomElement &base)
void readDockConfig (KConfig *c=0L, const QString &group=QString())
void setMainDockWidget (K3DockWidget *dockwidget)
void setView (QWidget *widget)
void writeDockConfig (QDomElement &base)
void writeDockConfig (KConfig *c=0L, const QString &group=QString())
- Public Member Functions inherited from KXmlGuiWindow
 KXmlGuiWindow (QWidget *parent=0, Qt::WindowFlags f=KDE_DEFAULT_WINDOWFLAGS)
virtual ~KMainWindow ()
virtual ~KXMLGUIBuilder ()
virtual ~KXMLGUIClient ()
virtual ~KXmlGuiWindow ()
QAction * action (const char *name) const
virtual QAction * action (const QDomElement &element) const
virtual KActionCollection * actionCollection () const
void addStateActionDisabled (const QString &state, const QString &action)
void addStateActionEnabled (const QString &state, const QString &action)
virtual void applyMainWindowSettings (const KConfigGroup &config, bool force=false)
KConfigGroup autoSaveConfigGroup () const
QString autoSaveGroup () const
bool autoSaveSettings () const
void beginXMLPlug (QWidget *)
KXMLGUIClient * builderClient () const
KComponentData builderComponentData () const
QList< KXMLGUIClient * > childClients ()
KXMLGUIBuilder * clientBuilder () const
virtual KComponentData componentData () const
virtual QStringList containerTags () const
virtual QWidget * createContainer (QWidget *parent, int index, const QDomElement &element, QAction *&containerAction)
virtual QAction * createCustomElement (QWidget *parent, int index, const QDomElement &element)
void createGUI (const QString &xmlfile=QString())
void createStandardStatusBarAction ()
KMenu * customHelpMenu (bool showWhatsThis=true)
virtual QStringList customTags () const
QString dbusName () const
virtual QDomDocument domDocument () const
void endXMLPlug ()
KXMLGUIFactory * factory () const
virtual void finalizeGUI (KXMLGUIClient *client)
void finalizeGUI (bool force)
StateChange getActionsToChangeForState (const QString &state)
virtual KXMLGUIFactory * guiFactory ()
bool hasMenuBar ()
KMenu * helpMenu (const QString &aboutAppText=QString(), bool showWhatsThis=true)
void ignoreInitialGeometry ()
bool initialGeometrySet () const
void insertChildClient (KXMLGUIClient *child)
bool isHelpMenuEnabled () const
bool isStandardToolBarMenuEnabled () const
 KMainWindow (QWidget *parent=0, Qt::WindowFlags f=KDE_DEFAULT_WINDOWFLAGS)
 KXMLGUIBuilder (QWidget *widget)
 KXMLGUIClient ()
 KXMLGUIClient (KXMLGUIClient *parent)
virtual QString localXMLFile () const
KMenuBar * menuBar ()
KXMLGUIClient * parentClient () const
void plugActionList (const QString &name, const QList< QAction * > &actionList)
void prepareXMLUnplug (QWidget *)
void reloadXML ()
void removeChildClient (KXMLGUIClient *child)
virtual void removeContainer (QWidget *container, QWidget *parent, QDomElement &element, QAction *containerAction)
virtual void removeCustomElement (QWidget *parent, QAction *action)
void replaceXMLFile (const QString &xmlfile, const QString &localxmlfile, bool merge=false)
void resetAutoSaveSettings ()
bool restore (int number, bool show=true)
void saveMainWindowSettings (const KConfigGroup &config)
void setAutoSaveSettings (const KConfigGroup &group, bool saveWindowSize=true)
void setAutoSaveSettings (const QString &groupName=QLatin1String("MainWindow"), bool saveWindowSize=true)
void setBuilderClient (KXMLGUIClient *client)
void setBuilderComponentData (const KComponentData &componentData)
void setClientBuilder (KXMLGUIBuilder *builder)
void setFactory (KXMLGUIFactory *factory)
void setHelpMenuEnabled (bool showHelpMenu=true)
void setStandardToolBarMenuEnabled (bool enable)
void setupGUI (const QSize &defaultSize, StandardWindowOptions options=Default, const QString &xmlfile=QString())
void setupGUI (StandardWindowOptions options=Default, const QString &xmlfile=QString())
void setupToolbarMenuActions ()
void setXMLGUIBuildDocument (const QDomDocument &doc)
KStatusBar * statusBar ()
KToolBar * toolBar (const QString &name=QString())
QAction * toolBarMenuAction ()
QList< KToolBar * > toolBars () const
void unplugActionList (const QString &name)
QWidget * widget ()
virtual QString xmlFile () const
QDomDocument xmlguiBuildDocument () const
- Public Member Functions inherited from KParts::PartBase
 PartBase ()
virtual ~PartBase ()
QObject * partObject () const
void setPartObject (QObject *object)

Protected Slots

void createGUI (KParts::Part *part)
virtual void slotSetStatusBarText (const QString &)
- Protected Slots inherited from K3DockMainWindow
void slotDockWidgetUndocked ()
- Protected Slots inherited from KXmlGuiWindow
void saveAutoSaveSettings ()
virtual void saveNewToolbarConfig ()
virtual void showAboutApplication ()
- Protected Slots inherited from KMainWindow

Protected Member Functions

virtual void createShellGUI (bool create=true)
- Protected Member Functions inherited from K3DockMainWindow
virtual void virtual_hook (int id, void *data)
- Protected Member Functions inherited from KXmlGuiWindow
virtual void closeEvent (QCloseEvent *)
virtual bool event (QEvent *event)
 KMainWindow (KMainWindowPrivate &dd, QWidget *parent, Qt::WindowFlags f)
void loadStandardsXmlFile ()
void parseGeometry (bool parsewidth)
virtual bool queryClose ()
virtual bool queryExit ()
virtual void readGlobalProperties (KConfig *sessionConfig)
virtual void readProperties (const KConfigGroup &)
bool readPropertiesInternal (KConfig *, int)
void restoreWindowSize (const KConfigGroup &config)
virtual void saveGlobalProperties (KConfig *sessionConfig)
virtual void saveProperties (KConfigGroup &)
void savePropertiesInternal (KConfig *, int)
void saveWindowSize (const KConfigGroup &config) const
virtual void setComponentData (const KComponentData &componentData)
virtual void setDOMDocument (const QDomDocument &document, bool merge=false)
virtual void setLocalXMLFile (const QString &file)
bool settingsDirty () const
virtual void setXML (const QString &document, bool merge=false)
virtual void setXMLFile (const QString &file, bool merge=false, bool setXMLDoc=true)
virtual void stateChanged (const QString &newstate, ReverseStateChange reverse=StateNoReverse)
- Protected Member Functions inherited from KParts::PartBase
 PartBase (PartBasePrivate &dd)
void loadPlugins (QObject *parent, KXMLGUIClient *parentGUIClient, const KComponentData &componentData)
virtual void setComponentData (const KComponentData &componentData, bool loadPlugins)
virtual void setComponentData (const KComponentData &componentData)
void setPluginInterfaceVersion (int version)
void setPluginLoadingMode (PluginLoadingMode loadingMode)

Additional Inherited Members

- Public Types inherited from KParts::PartBase
enum  PluginLoadingMode
- Public Types inherited from KXMLGUIClient
- Signals inherited from K3DockMainWindow
void dockWidgetHasUndocked (K3DockWidget *)
- Public Attributes inherited from KParts::PartBase
 DoNotLoadPlugins
 LoadPlugins
 LoadPluginsIfEnabled
- Public Attributes inherited from KXMLGUIClient
- Protected Attributes inherited from K3DockMainWindow
K3DockManager * dockManager
K3DockWidget * mainDockWidget
- Protected Attributes inherited from KXmlGuiWindow
KMainWindowPrivate *const k_ptr
- Protected Attributes inherited from KMainWindow
- Protected Attributes inherited from KParts::PartBase
PartBasePrivate * d_ptr

Detailed Description

A KPart-aware main window with ability for docking widgets, whose user interface is described in XML.

Inherit your main dock-window from this class and don't forget to call setXMLFile() in the inherited constructor.

It implements all internal interfaces in the case of a K3DockMainWindow3 as host: the builder and servant interface (for menu merging).

Definition at line 47 of file dockmainwindow3.h.


Constructor & Destructor Documentation

DockMainWindow3::DockMainWindow3 ( QWidget *  parent = 0L,
const char *  name = 0L,
Qt::WindowFlags  f = 0 
)

Constructor, same signature as K3DockMainWindow3.

Definition at line 60 of file dockmainwindow3.cpp.

DockMainWindow3::~DockMainWindow3 ( )
virtual

Destructor.

Definition at line 68 of file dockmainwindow3.cpp.


Member Function Documentation

void DockMainWindow3::createGUI ( KParts::Part *  part)
protectedslot

Create the GUI (by merging the host's and the active part's)

Called on startup and whenever the active part changes For this you need to connect this slot to the KPartManager::activePartChanged() signal

Parameters:
partThe active part (set to 0L if no part).

Definition at line 73 of file dockmainwindow3.cpp.

void DockMainWindow3::createShellGUI ( bool  create = true)
protectedvirtual

Definition at line 130 of file dockmainwindow3.cpp.

void DockMainWindow3::slotSetStatusBarText ( const QString &  text)
protectedvirtualslot

Called when the active part wants to change the statusbar message Reimplement if your dock-mainwindow has a complex statusbar (with several items)

Definition at line 125 of file dockmainwindow3.cpp.


The documentation for this class was generated from the following files:
  • dockmainwindow3.h
  • dockmainwindow3.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 23 2013 22:04:44 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDE3Support

Skip menu "KDE3Support"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.10.5 API Reference

Skip menu "kdelibs-4.10.5 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal