Search for usage in LXR

#include <KXmlGuiWindow>

Inheritance diagram for KXmlGuiWindow:

Public Types

enum  StandardWindowOption {
  ToolBar = 1 , Keys = 2 , StatusBar = 4 , Save = 8 ,
  Create = 16 , Default = ToolBar | Keys | StatusBar | Save | Create
typedef QFlags< StandardWindowOptionStandardWindowOptions
- Public Types inherited from QMainWindow
enum  DockOption
- Public Types inherited from QWidget
enum  RenderFlag
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
- Public Types inherited from KXMLGUIClient
enum  ReverseStateChange { StateNoReverse , StateReverse }


QString autoSaveGroup
bool autoSaveSettings
bool hasMenuBar
bool standardToolBarMenuEnabled
- Properties inherited from KMainWindow
QString autoSaveGroup
bool autoSaveSettings
bool hasMenuBar
- Properties inherited from QMainWindow
- Properties inherited from QWidget
- Properties inherited from QObject

Public Slots

virtual void configureToolbars ()
virtual void slotStateChanged (const QString &newstate)
void slotStateChanged (const QString &newstate, bool reverse)
- Public Slots inherited from KMainWindow
void appHelpActivated ()
virtual void setCaption (const QString &caption)
virtual void setCaption (const QString &caption, bool modified)
virtual void setPlainCaption (const QString &caption)
void setSettingsDirty ()

Public Member Functions

 KXmlGuiWindow (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 ~KXmlGuiWindow () override
void applyMainWindowSettings (const KConfigGroup &config) override
void createGUI (const QString &xmlfile=QString())
void createStandardStatusBarAction ()
void finalizeGUI (bool force)
virtual void finalizeGUI (KXMLGUIClient *client)
virtual KXMLGUIFactoryguiFactory ()
bool isCommandBarEnabled () const
bool isHelpMenuEnabled () const
bool isStandardToolBarMenuEnabled () const
void setCommandBarEnabled (bool showCommandBar)
void setHelpMenuEnabled (bool showHelpMenu=true)
void setStandardToolBarMenuEnabled (bool showToolBarMenu)
void setupGUI (const QSize &defaultSize, StandardWindowOptions options=Default, const QString &xmlfile=QString())
void setupGUI (StandardWindowOptions options=Default, const QString &xmlfile=QString())
void setupToolbarMenuActions ()
QActiontoolBarMenuAction ()
- Public Member Functions inherited from KMainWindow
 KMainWindow (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 ~KMainWindow () override
KConfigGroup autoSaveConfigGroup () const
QString autoSaveGroup () const
bool autoSaveSettings () const
QString dbusName () const
bool hasMenuBar ()
void resetAutoSaveSettings ()
bool restore (int numberOfInstances, bool show=true)
void saveMainWindowSettings (KConfigGroup &config)
void setAutoSaveSettings (const KConfigGroup &group, bool saveWindowSize=true)
void setAutoSaveSettings (const QString &groupName=QStringLiteral("MainWindow"), bool saveWindowSize=true)
void setStateConfigGroup (const QString &configGroup)
KConfigGroup stateConfigGroup () const
KToolBartoolBar (const QString &name=QString())
QList< KToolBar * > toolBars () const
- Public Member Functions inherited from QMainWindow
 QMainWindow (QWidget *parent, Qt::WindowFlags flags)
void addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget)
void addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget, Qt::Orientation orientation)
QToolBaraddToolBar (const QString &title)
void addToolBar (Qt::ToolBarArea area, QToolBar *toolbar)
void addToolBar (QToolBar *toolbar)
void addToolBarBreak (Qt::ToolBarArea area)
QWidgetcentralWidget () const const
Qt::DockWidgetArea corner (Qt::Corner corner) const const
virtual QMenucreatePopupMenu ()
QMainWindow::DockOptions dockOptions () const const
Qt::DockWidgetArea dockWidgetArea (QDockWidget *dockwidget) const const
bool documentMode () const const
QSize iconSize () const const
void iconSizeChanged (const QSize &iconSize)
void insertToolBar (QToolBar *before, QToolBar *toolbar)
void insertToolBarBreak (QToolBar *before)
bool isAnimated () const const
bool isDockNestingEnabled () const const
QMenuBarmenuBar () const const
QWidgetmenuWidget () const const
void removeDockWidget (QDockWidget *dockwidget)
void removeToolBar (QToolBar *toolbar)
void removeToolBarBreak (QToolBar *before)
void resizeDocks (const QList< QDockWidget * > &docks, const QList< int > &sizes, Qt::Orientation orientation)
bool restoreDockWidget (QDockWidget *dockwidget)
bool restoreState (const QByteArray &state, int version)
QByteArray saveState (int version) const const
void setAnimated (bool enabled)
void setCentralWidget (QWidget *widget)
void setCorner (Qt::Corner corner, Qt::DockWidgetArea area)
void setDockNestingEnabled (bool enabled)
void setDockOptions (QMainWindow::DockOptions options)
void setDocumentMode (bool enabled)
void setIconSize (const QSize &iconSize)
void setMenuBar (QMenuBar *menuBar)
void setMenuWidget (QWidget *menuBar)
void setStatusBar (QStatusBar *statusbar)
void setTabPosition (Qt::DockWidgetAreas areas, QTabWidget::TabPosition tabPosition)
void setTabShape (QTabWidget::TabShape tabShape)
void setToolButtonStyle (Qt::ToolButtonStyle toolButtonStyle)
void setUnifiedTitleAndToolBarOnMac (bool set)
void splitDockWidget (QDockWidget *first, QDockWidget *second, Qt::Orientation orientation)
QStatusBarstatusBar () const const
void tabifiedDockWidgetActivated (QDockWidget *dockWidget)
QList< QDockWidget * > tabifiedDockWidgets (QDockWidget *dockwidget) const const
void tabifyDockWidget (QDockWidget *first, QDockWidget *second)
QTabWidget::TabPosition tabPosition (Qt::DockWidgetArea area) const const
QTabWidget::TabShape tabShape () const const
QWidgettakeCentralWidget ()
Qt::ToolBarArea toolBarArea (QToolBar *toolbar) const const
bool toolBarBreak (QToolBar *toolbar) const const
Qt::ToolButtonStyle toolButtonStyle () const const
void toolButtonStyleChanged (Qt::ToolButtonStyle toolButtonStyle)
bool unifiedTitleAndToolBarOnMac () const const
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
bool acceptDrops () const const
QString accessibleDescription () const const
QString accessibleName () const const
QList< QAction * > actions () const const
void activateWindow ()
void addAction (QAction *action)
void addActions (QList< QAction * > actions)
void adjustSize ()
bool autoFillBackground () const const
QPalette::ColorRole backgroundRole () const const
QBackingStorebackingStore () const const
QSize baseSize () const const
QWidgetchildAt (const QPoint &p) const const
QWidgetchildAt (int x, int y) const const
QRect childrenRect () const const
QRegion childrenRegion () const const
void clearFocus ()
void clearMask ()
bool close ()
QMargins contentsMargins () const const
QRect contentsRect () const const
Qt::ContextMenuPolicy contextMenuPolicy () const const
QCursor cursor () const const
void customContextMenuRequested (const QPoint &pos)
WId effectiveWinId () const const
void ensurePolished () const const
Qt::FocusPolicy focusPolicy () const const
QWidgetfocusProxy () const const
QWidgetfocusWidget () const const
const QFontfont () const const
QFontInfo fontInfo () const const
QFontMetrics fontMetrics () const const
QPalette::ColorRole foregroundRole () const const
QRect frameGeometry () const const
QSize frameSize () const const
const QRectgeometry () const const
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
QPixmap grab (const QRect &rectangle)
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
void grabKeyboard ()
void grabMouse ()
void grabMouse (const QCursor &cursor)
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
QGraphicsEffectgraphicsEffect () const const
QGraphicsProxyWidgetgraphicsProxyWidget () const const
bool hasEditFocus () const const
bool hasFocus () const const
virtual bool hasHeightForWidth () const const
bool hasMouseTracking () const const
bool hasTabletTracking () const const
int height () const const
virtual int heightForWidth (int w) const const
void hide ()
Qt::InputMethodHints inputMethodHints () const const
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const const
void insertAction (QAction *before, QAction *action)
void insertActions (QAction *before, QList< QAction * > actions)
bool isActiveWindow () const const
bool isAncestorOf (const QWidget *child) const const
bool isEnabled () const const
bool isEnabledTo (const QWidget *ancestor) const const
bool isEnabledToTLW () const const
bool isFullScreen () const const
bool isHidden () const const
bool isMaximized () const const
bool isMinimized () const const
bool isModal () const const
bool isTopLevel () const const
bool isVisible () const const
bool isVisibleTo (const QWidget *ancestor) const const
bool isWindow () const const
bool isWindowModified () const const
QLayoutlayout () const const
Qt::LayoutDirection layoutDirection () const const
QLocale locale () const const
void lower ()
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
QPoint mapFromGlobal (const QPoint &pos) const const
QPoint mapFromParent (const QPoint &pos) const const
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
QPoint mapToGlobal (const QPoint &pos) const const
QPoint mapToParent (const QPoint &pos) const const
QRegion mask () const const
int maximumHeight () const const
QSize maximumSize () const const
int maximumWidth () const const
int minimumHeight () const const
QSize minimumSize () const const
virtual QSize minimumSizeHint () const const
int minimumWidth () const const
void move (const QPoint &)
void move (int x, int y)
QWidgetnativeParentWidget () const const
QWidgetnextInFocusChain () const const
QRect normalGeometry () const const
void overrideWindowFlags (Qt::WindowFlags flags)
virtual QPaintEnginepaintEngine () const const override
const QPalettepalette () const const
QWidgetparentWidget () const const
QPoint pos () const const
QWidgetpreviousInFocusChain () const const
void raise ()
QRect rect () const const
void releaseKeyboard ()
void releaseMouse ()
void releaseShortcut (int id)
void removeAction (QAction *action)
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void repaint ()
void repaint (const QRect &rect)
void repaint (const QRegion &rgn)
void repaint (int x, int y, int w, int h)
void resize (const QSize &)
void resize (int w, int h)
bool restoreGeometry (const QByteArray &geometry)
QByteArray saveGeometry () const const
QScreenscreen () const const
void scroll (int dx, int dy)
void scroll (int dx, int dy, const QRect &r)
void setAcceptDrops (bool on)
void setAccessibleDescription (const QString &description)
void setAccessibleName (const QString &name)
void setAttribute (Qt::WidgetAttribute attribute, bool on)
void setAutoFillBackground (bool enabled)
void setBackgroundRole (QPalette::ColorRole role)
void setBaseSize (const QSize &)
void setBaseSize (int basew, int baseh)
void setContentsMargins (const QMargins &margins)
void setContentsMargins (int left, int top, int right, int bottom)
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
void setCursor (const QCursor &)
void setDisabled (bool disable)
void setEditFocus (bool enable)
void setEnabled (bool)
void setFixedHeight (int h)
void setFixedSize (const QSize &s)
void setFixedSize (int w, int h)
void setFixedWidth (int w)
void setFocus ()
void setFocus (Qt::FocusReason reason)
void setFocusPolicy (Qt::FocusPolicy policy)
void setFocusProxy (QWidget *w)
void setFont (const QFont &)
void setForegroundRole (QPalette::ColorRole role)
void setGeometry (const QRect &)
void setGeometry (int x, int y, int w, int h)
void setGraphicsEffect (QGraphicsEffect *effect)
void setHidden (bool hidden)
void setInputMethodHints (Qt::InputMethodHints hints)
void setLayout (QLayout *layout)
void setLayoutDirection (Qt::LayoutDirection direction)
void setLocale (const QLocale &locale)
void setMask (const QBitmap &bitmap)
void setMask (const QRegion &region)
void setMaximumHeight (int maxh)
void setMaximumSize (const QSize &)
void setMaximumSize (int maxw, int maxh)
void setMaximumWidth (int maxw)
void setMinimumHeight (int minh)
void setMinimumSize (const QSize &)
void setMinimumSize (int minw, int minh)
void setMinimumWidth (int minw)
void setMouseTracking (bool enable)
void setPalette (const QPalette &)
void setParent (QWidget *parent)
void setParent (QWidget *parent, Qt::WindowFlags f)
void setShortcutAutoRepeat (int id, bool enable)
void setShortcutEnabled (int id, bool enable)
void setSizeIncrement (const QSize &)
void setSizeIncrement (int w, int h)
void setSizePolicy (QSizePolicy)
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
void setStatusTip (const QString &)
void setStyle (QStyle *style)
void setStyleSheet (const QString &styleSheet)
void setTabletTracking (bool enable)
void setToolTip (const QString &)
void setToolTipDuration (int msec)
void setUpdatesEnabled (bool enable)
void setupUi (QWidget *widget)
virtual void setVisible (bool visible)
void setWhatsThis (const QString &)
void setWindowFilePath (const QString &filePath)
void setWindowFlag (Qt::WindowType flag, bool on)
void setWindowFlags (Qt::WindowFlags type)
void setWindowIcon (const QIcon &icon)
void setWindowIconText (const QString &)
void setWindowModality (Qt::WindowModality windowModality)
void setWindowModified (bool)
void setWindowOpacity (qreal level)
void setWindowRole (const QString &role)
void setWindowState (Qt::WindowStates windowState)
void setWindowTitle (const QString &)
void show ()
void showFullScreen ()
void showMaximized ()
void showMinimized ()
void showNormal ()
QSize size () const const
virtual QSize sizeHint () const const
QSize sizeIncrement () const const
QSizePolicy sizePolicy () const const
void stackUnder (QWidget *w)
QString statusTip () const const
QStylestyle () const const
QString styleSheet () const const
bool testAttribute (Qt::WidgetAttribute attribute) const const
QString toolTip () const const
int toolTipDuration () const const
QWidgettopLevelWidget () const const
bool underMouse () const const
void ungrabGesture (Qt::GestureType gesture)
void unsetCursor ()
void unsetLayoutDirection ()
void unsetLocale ()
void update ()
void update (const QRect &rect)
void update (const QRegion &rgn)
void update (int x, int y, int w, int h)
void updateGeometry ()
bool updatesEnabled () const const
QRegion visibleRegion () const const
QString whatsThis () const const
int width () const const
QWidgetwindow () const const
QString windowFilePath () const const
Qt::WindowFlags windowFlags () const const
QWindowwindowHandle () const const
QIcon windowIcon () const const
void windowIconChanged (const QIcon &icon)
QString windowIconText () const const
void windowIconTextChanged (const QString &iconText)
Qt::WindowModality windowModality () const const
qreal windowOpacity () const const
QString windowRole () const const
Qt::WindowStates windowState () const const
QString windowTitle () const const
void windowTitleChanged (const QString &title)
Qt::WindowType windowType () const const
WId winId () const const
int x () const const
int y () const const
- 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 eventFilter (QObject *watched, QEvent *event)
findChild (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
QList< T > findChildren (const QString &name, 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_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
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 (const QObject *object)
qobject_cast (QObject *object)
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
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
int depth () const const
int devicePixelRatio () const const
qreal devicePixelRatioF () const const
int height () const const
int heightMM () const const
int logicalDpiX () const const
int logicalDpiY () const const
bool paintingActive () const const
int physicalDpiX () const const
int physicalDpiY () const const
int width () const const
int widthMM () const const
- Public Member Functions inherited from KXMLGUIBuilder
 KXMLGUIBuilder (QWidget *widget)
KXMLGUIClientbuilderClient () const
virtual QStringList containerTags () const
virtual QWidgetcreateContainer (QWidget *parent, int index, const QDomElement &element, QAction *&containerAction)
virtual QActioncreateCustomElement (QWidget *parent, int index, const QDomElement &element)
virtual QStringList customTags () const
virtual void removeContainer (QWidget *container, QWidget *parent, QDomElement &element, QAction *containerAction)
void setBuilderClient (KXMLGUIClient *client)
QWidgetwidget ()
- Public Member Functions inherited from KXMLGUIClient
 KXMLGUIClient ()
 KXMLGUIClient (KXMLGUIClient *parent)
virtual ~KXMLGUIClient ()
virtual QActionaction (const QDomElement &element) const
QActionaction (const QString &name) const
virtual KActionCollectionactionCollection () const
void addStateActionDisabled (const QString &state, const QString &action)
void addStateActionEnabled (const QString &state, const QString &action)
void beginXMLPlug (QWidget *)
QList< KXMLGUIClient * > childClients ()
KXMLGUIBuilderclientBuilder () const
virtual QString componentName () const
virtual QDomDocument domDocument () const
void endXMLPlug ()
KXMLGUIFactoryfactory () const
StateChange getActionsToChangeForState (const QString &state)
void insertChildClient (KXMLGUIClient *child)
virtual QString localXMLFile () const
KXMLGUIClientparentClient () const
void plugActionList (const QString &name, const QList< QAction * > &actionList)
void prepareXMLUnplug (QWidget *)
void reloadXML ()
void removeChildClient (KXMLGUIClient *child)
void replaceXMLFile (const QString &xmlfile, const QString &localxmlfile, bool merge=false)
void setClientBuilder (KXMLGUIBuilder *builder)
void setFactory (KXMLGUIFactory *factory)
void setXMLGUIBuildDocument (const QDomDocument &doc)
void unplugActionList (const QString &name)
virtual QString xmlFile () const
QDomDocument xmlguiBuildDocument () const

Protected Slots

virtual void saveNewToolbarConfig ()
- Protected Slots inherited from KMainWindow
void saveAutoSaveSettings ()

Protected Member Functions

void checkAmbiguousShortcuts ()
bool event (QEvent *event) override
- Protected Member Functions inherited from KMainWindow
KXMLGUI_NO_EXPORT KMainWindow (KMainWindowPrivate &dd, QWidget *parent, Qt::WindowFlags f)
void closeEvent (QCloseEvent *) override
void keyPressEvent (QKeyEvent *keyEvent) override
virtual bool queryClose ()
virtual void readGlobalProperties (KConfig *sessionConfig)
virtual void readProperties (const KConfigGroup &)
bool readPropertiesInternal (KConfig *, int)
virtual void saveGlobalProperties (KConfig *sessionConfig)
virtual void saveProperties (KConfigGroup &)
void savePropertiesInternal (KConfig *, int)
bool settingsDirty () const
- Protected Member Functions inherited from QMainWindow
virtual void contextMenuEvent (QContextMenuEvent *event) override
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
virtual void changeEvent (QEvent *event)
void create (WId window, bool initializeWindow, bool destroyOldWindow)
void destroy (bool destroyWindow, bool destroySubWindows)
virtual void dragEnterEvent (QDragEnterEvent *event)
virtual void dragLeaveEvent (QDragLeaveEvent *event)
virtual void dragMoveEvent (QDragMoveEvent *event)
virtual void dropEvent (QDropEvent *event)
virtual void enterEvent (QEvent *event)
virtual void focusInEvent (QFocusEvent *event)
bool focusNextChild ()
virtual bool focusNextPrevChild (bool next)
virtual void focusOutEvent (QFocusEvent *event)
bool focusPreviousChild ()
virtual void hideEvent (QHideEvent *event)
virtual void initPainter (QPainter *painter) const const override
virtual void inputMethodEvent (QInputMethodEvent *event)
virtual void keyReleaseEvent (QKeyEvent *event)
virtual void leaveEvent (QEvent *event)
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
virtual void mouseDoubleClickEvent (QMouseEvent *event)
virtual void mouseMoveEvent (QMouseEvent *event)
virtual void mousePressEvent (QMouseEvent *event)
virtual void mouseReleaseEvent (QMouseEvent *event)
virtual void moveEvent (QMoveEvent *event)
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
virtual void paintEvent (QPaintEvent *event)
virtual void resizeEvent (QResizeEvent *event)
virtual void showEvent (QShowEvent *event)
virtual void tabletEvent (QTabletEvent *event)
void updateMicroFocus ()
virtual void wheelEvent (QWheelEvent *event)
- 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)
- Protected Member Functions inherited from KXMLGUIBuilder
virtual void virtual_hook (int id, void *data)
- Protected Member Functions inherited from KXMLGUIClient
void loadStandardsXmlFile ()
virtual void setComponentName (const QString &componentName, const QString &componentDisplayName)
virtual void setDOMDocument (const QDomDocument &document, bool merge=false)
virtual void setLocalXMLFile (const QString &file)
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)
virtual void virtual_hook (int id, void *data)

Additional Inherited Members

- Static Public Member Functions inherited from KMainWindow
static bool canBeRestored (int numberOfInstances)
static const QString classNameOfToplevel (int instanceNumber)
static QList< KMainWindow * > memberList ()
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
QWidgetfind (WId id)
QWidgetkeyboardGrabber ()
QWidgetmouseGrabber ()
void setTabOrder (QWidget *first, QWidget *second)
- 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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString tr (const char *sourceText, const char *disambiguation, int n)
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
- Static Public Member Functions inherited from KXMLGUIClient
static QString findMostRecentXMLFile (const QStringList &files, QString &doc)
static QString findVersionNumber (const QString &xml)
- Public Attributes inherited from QMainWindow
typedef DockOptions
- Public Attributes inherited from QWidget
typedef RenderFlags
- Public Attributes inherited from QObject
typedef QObjectList
- Public Attributes inherited from QPaintDevice
- Static Protected Member Functions inherited from KXMLGUIClient
static QString standardsXmlFileLocation ()
- Protected Attributes inherited from KMainWindow
std::unique_ptr< KMainWindowPrivate > const d_ptr

Detailed Description

KMainWindow with convenience functions and integration with XmlGui files.

This class includes several convenience <action>Enabled() functions to toggle the presence of functionality in your main window, including a KCommandBar instance.

The StandardWindowOptions enum can be used to pass additional options to describe the main window behavior/appearance. Use it in conjunction with setupGUI() to load an appnameui.rc file to manage the main window's actions.

setCommandBarEnabled() is set by default.

A minimal example can be created with QMainWindow::setCentralWidget() and setupGUI():

MainWindow::MainWindow(QWidget *parent) : KXmlGuiWindow(parent) {
textArea = new KTextEdit();
KMainWindow with convenience functions and integration with XmlGui files.
QObject * parent() const const

With this, a ready-made main window with menubar and statusbar is created, as well as two default menus, Settings and Help.

Management of QActions is made trivial in combination with KActionCollection and KStandardAction.

void MainWindow::setupActions() {
QAction *clearAction = new QAction(this);
setupGUI(Default, "texteditorui.rc");
Q_INVOKABLE QAction * addAction(const QString &name, QAction *action)
Add an action under the given name to the collection.
static void setDefaultShortcut(QAction *action, const QKeySequence &shortcut)
Set the default shortcut for the given action.
virtual KActionCollection * actionCollection() const
Retrieves the entire action collection for the GUI client.
@ Default
Sets all of the above options as true.
void setupGUI(StandardWindowOptions options=Default, const QString &xmlfile=QString())
Configures the current window and its actions in the typical KDE fashion.
QString i18n(const char *text, const TYPE &arg...)
QAction * quit(const QObject *recvr, const char *slot, QObject *parent)
void triggered(bool checked)
QIcon fromTheme(const QString &name)
QMetaObject::Connection connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QList< T > findChildren(const QString &name, Qt::FindChildOptions options) const const
void clear()

See https://develop.kde.org/docs/use/kxmlgui/ for a tutorial on how to create a simple text editor using KXmlGuiWindow.

See https://develop.kde.org/docs/use/session-managment for more information on session management.

See also

Definition at line 87 of file kxmlguiwindow.h.

Member Typedef Documentation

◆ StandardWindowOptions

Stores a combination of StandardWindowOptions values.

Use these options for the first argument of setupGUI().

See also

Definition at line 334 of file kxmlguiwindow.h.

Member Enumeration Documentation

◆ StandardWindowOption

Use these options for the first argument of setupGUI().

See also

Adds action(s) to show/hide the toolbar(s) and adds a menu action to configure the toolbar(s).

See also

Adds an action in the 'Settings' menu to open the configure keyboard shortcuts dialog.


Adds an action to show/hide the statusbar in the 'Settings' menu.

Note that setting this value will create a statusbar if one doesn't already exist.

See also

Autosaves (and loads) the toolbar/menubar/statusbar settings and window size using the default name.

Like KMainWindow::setAutoSaveSettings(), enabling this causes the application to save state data upon close in a KConfig-managed configuration file.

Typically you want to let the default window size be determined by the widgets' size hints. Make sure that setupGUI() is called after all the widgets are created (including QMainWindow::setCentralWidget()) so that the default size is managed properly.

See also

Calls createGUI() once ToolBar, Keys and Statusbar have been taken care of.

When using KParts::MainWindow, remove this flag from the setupGUI() call, since you'll be using createGUI(part) instead:
@ StatusBar
Adds an action to show/hide the statusbar in the 'Settings' menu.
@ Save
Autosaves (and loads) the toolbar/menubar/statusbar settings and window size using the default name.
@ Keys
Adds an action in the 'Settings' menu to open the configure keyboard shortcuts dialog.
See also

Sets all of the above options as true.

Definition at line 263 of file kxmlguiwindow.h.

Property Documentation

◆ autoSaveGroup

QString KXmlGuiWindow::autoSaveGroup

Definition at line 92 of file kxmlguiwindow.h.

◆ autoSaveSettings

bool KXmlGuiWindow::autoSaveSettings

Definition at line 91 of file kxmlguiwindow.h.

◆ hasMenuBar

bool KXmlGuiWindow::hasMenuBar

Definition at line 90 of file kxmlguiwindow.h.

◆ standardToolBarMenuEnabled

bool KXmlGuiWindow::standardToolBarMenuEnabled

Definition at line 93 of file kxmlguiwindow.h.

Constructor & Destructor Documentation

◆ KXmlGuiWindow()

KXmlGuiWindow::KXmlGuiWindow ( QWidget * parent = nullptr,
Qt::WindowFlags flags = Qt::WindowFlags() )

Construct a main window.

Note that by default a KXmlGuiWindow is created with the Qt::WA_DeleteOnClose attribute set, i.e. it is automatically destroyed when the window is closed. If you do not want this behavior, call:

void setAttribute(Qt::WidgetAttribute attribute, bool on)
QWidget * window() const const

KXmlGuiWindows must be created on the heap with 'new', like:

KXmlGuiWindow(QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
Construct a main window.

IMPORTANT: For session management and window management to work properly, all main windows in the application should have a different name. Otherwise, the base class KMainWindow will create a unique name, but it's recommended to explicitly pass a window name that will also describe the type of the window. If there can be several windows of the same type, append '#' (hash) to the name, and KMainWindow will replace it with numbers to make the names unique. For example, for a mail client which has one main window showing the mails and folders, and which can also have one or more windows for composing mails, the name for the folders window should be e.g. "mainwindow" and for the composer windows "composer#".

parentThe widget parent. This is usually nullptr, but it may also be the window group leader. In that case, the KXmlGuiWindow becomes a secondary window.
flagsSpecify the window flags. The default is none.
See also

Definition at line 148 of file kxmlguiwindow.cpp.

◆ ~KXmlGuiWindow()

KXmlGuiWindow::~KXmlGuiWindow ( )


Will also destroy the toolbars and menubar if needed.

Definition at line 213 of file kxmlguiwindow.cpp.

Member Function Documentation

◆ applyMainWindowSettings()

void KXmlGuiWindow::applyMainWindowSettings ( const KConfigGroup & config)

Read settings for statusbar, menubar and toolbar from their respective groups in the config file and apply them.

configConfig group to read the settings from.

Reimplemented from KMainWindow.

Definition at line 481 of file kxmlguiwindow.cpp.

◆ checkAmbiguousShortcuts()

void KXmlGuiWindow::checkAmbiguousShortcuts ( )

Checks if there are actions using the same shortcut.

This is called automatically from createGUI().


Definition at line 491 of file kxmlguiwindow.cpp.

◆ configureToolbars

void KXmlGuiWindow::configureToolbars ( )

Show a standard configure toolbar dialog.

This slot can be connected directly to the action to configure the toolbar.

virtual void configureToolbars()
Show a standard configure toolbar dialog.
QAction * configureToolbars(const QObject *recvr, const char *slot, QObject *parent)

Definition at line 261 of file kxmlguiwindow.cpp.

◆ createGUI()

void KXmlGuiWindow::createGUI ( const QString & xmlfile = QString())

Generates the interface based on a local XML file.

This is the function that generates UI elements such as the main menu, toolbar (if any) and statusbar. This is called by setupGUI(Create) as well.

Typically, in a regular application, you would use setupGUI() instead, as it sets up the toolbar/shortcut edit actions, among other things.

If xmlfile is an empty string, this method will try to construct a local XML filename like appnameui.rc where 'appname' is your app's name. Typically that app name is what KXMLGUIClient::componentName() returns. If that file does not exist, then the XML UI code will use only the global (standard) XML file for its layout purposes.

xmlfileThe path (relative or absolute) to the local xmlfile
See also

Definition at line 328 of file kxmlguiwindow.cpp.

◆ createStandardStatusBarAction()

void KXmlGuiWindow::createStandardStatusBarAction ( )

Creates a toggle under the 'Settings' menu to show/hide the statusbar.

Calling this method will create a statusbar if one doesn't already exist.

If an application maintains the action on its own (i.e. never calls this function), a connection needs to be made to let KMainWindow know when the hidden/shown status of the statusbar has changed. For example:

void setSettingsDirty()
Tell the main window that it should save its settings when being closed.
QAction * action(const QString &name) const
Retrieves an action of the client by name.

Otherwise the status might not be saved by KMainWindow.

This function only makes sense before calling createGUI() or when using setupGUI() without StandardWindowOption::StatusBar.
See also

Definition at line 453 of file kxmlguiwindow.cpp.

◆ event()

bool KXmlGuiWindow::event ( QEvent * event)

Reimplemented to catch QEvent::Polish in order to adjust the object name if needed, once all constructor code for the main window has run.

Also reimplemented to catch when a QDockWidget is added or removed.

Reimplemented from KMainWindow.

Definition at line 219 of file kxmlguiwindow.cpp.

◆ finalizeGUI() [1/2]

void KXmlGuiWindow::finalizeGUI ( bool force)

Definition at line 470 of file kxmlguiwindow.cpp.

◆ finalizeGUI() [2/2]

void KXMLGUIBuilder::finalizeGUI ( KXMLGUIClient * client)

Reimplemented from KXMLGUIBuilder.

Definition at line 73 of file kxmlguibuilder.cpp.

◆ guiFactory()

KXMLGUIFactory * KXmlGuiWindow::guiFactory ( )

Definition at line 249 of file kxmlguiwindow.cpp.

◆ isCommandBarEnabled()

bool KXmlGuiWindow::isCommandBarEnabled ( ) const

Returns whether a KCommandBar was set.

true by default, false if setCommandBarEnabled(false) was set.
See also

Definition at line 562 of file kxmlguiwindow.cpp.

◆ isHelpMenuEnabled()

bool KXmlGuiWindow::isHelpMenuEnabled ( ) const
true if the help menu is enabled, false if setHelpMenuEnabled(false) was set.
See also

Definition at line 243 of file kxmlguiwindow.cpp.

◆ isStandardToolBarMenuEnabled()

bool KXmlGuiWindow::isStandardToolBarMenuEnabled ( ) const

Returns whether setStandardToolBarMenuEnabled() was set.

This function only makes sense if createGUI() was used. This function returns true only if setStandardToolBarMenuEnabled() was set and will return false even if StandardWindowOption::ToolBar was used.
true if setStandardToolBarMenuEnabled() was set, false otherwise.
See also

Definition at line 447 of file kxmlguiwindow.cpp.

◆ saveNewToolbarConfig

void KXmlGuiWindow::saveNewToolbarConfig ( )

Rebuilds the GUI after KEditToolBar changes the toolbar layout.

See also

Definition at line 274 of file kxmlguiwindow.cpp.

◆ setCommandBarEnabled()

void KXmlGuiWindow::setCommandBarEnabled ( bool showCommandBar)

Enable a KCommandBar to list and quickly execute actions.

A KXmlGuiWindow by default automatically creates a KCommandBar, but it is inaccessible unless createGUI() or setupGUI(Create) is used.

It provides a HUD-like menu that lists all QActions in your application and can be activated via Ctrl+Atl+i or via an action in the 'Help' menu.

If you need more than a global set of QActions listed for your application, use KCommandBar directly instead.

showCommandBarWhether to show the command bar. true by default.
See also

Unset the shortcut

Definition at line 546 of file kxmlguiwindow.cpp.

◆ setHelpMenuEnabled()

void KXmlGuiWindow::setHelpMenuEnabled ( bool showHelpMenu = true)

Creates a standard help menu when calling createGUI() or setupGUI().

showHelpMenuWhether to create a Help Menu. true by default.
See also

Definition at line 237 of file kxmlguiwindow.cpp.

◆ setStandardToolBarMenuEnabled()

void KXmlGuiWindow::setStandardToolBarMenuEnabled ( bool showToolBarMenu)

Creates a toggle under the 'Settings' menu to show/hide the available toolbars.

The standard toolbar menu toggles the visibility of one or multiple toolbars.

If there is only one toolbar configured, a simple 'Show <toolbar name>' menu item is shown; if more than one toolbar is configured, a "Shown Toolbars" menu is created instead, with 'Show <toolbar1 name>', 'Show <toolbar2 name>' ... sub-menu actions.

If your application uses a non-default XmlGui resource file, then you can specify the exact position of the menu/menu item by adding a <Merge name="StandardToolBarMenuHandler" /> line to the settings menu section of your resource file ( usually appname.rc ).

showToolBarMenuWhether to show the standard toolbar menu. false by default.
This function only makes sense before calling createGUI(). Using setupGUI(ToolBar) overrides this function.
See also

Definition at line 420 of file kxmlguiwindow.cpp.

◆ setupGUI() [1/2]

void KXmlGuiWindow::setupGUI ( const QSize & defaultSize,
StandardWindowOptions options = Default,
const QString & xmlfile = QString() )

This is an overloaded function.

defaultSizeA manually specified window size that overrides the saved size.
optionsA combination of StandardWindowOptions to specify UI elements to be present in your application window.
xmlfileThe relative or absolute path to the local xmlfile.
See also

Definition at line 290 of file kxmlguiwindow.cpp.

◆ setupGUI() [2/2]

void KXmlGuiWindow::setupGUI ( StandardWindowOptions options = Default,
const QString & xmlfile = QString() )

Configures the current window and its actions in the typical KDE fashion.

You can specify which window options/features are going to be set up using options, see the StandardWindowOptions enum for more details.

MainWindow::MainWindow(QWidget* parent) : KXmlGuiWindow(parent){
textArea = new KTextEdit();
setupGUI(Default, "appnameui.rc");

Use a bitwise OR (|) to select multiple enum choices for setupGUI() (except when using StandardWindowOption::Default).

setupGUI(Save | Create, "appnameui.rc");
@ Create
Calls createGUI() once ToolBar, Keys and Statusbar have been taken care of.

Typically this function replaces createGUI(), but it is possible to call setupGUI(Create) together with helper functions such as setStandardToolBarMenuEnabled() and createStandardStatusBarAction().

To use createGUI() and setupGUI() for the same window, you must avoid using StandardWindowOption::Create. Prefer using only setupGUI().
When StandardWindowOption::Save is used, this method will restore the state of the application window (toolbar, dockwindows positions ...etc), so you need to have added all your actions to your UI before calling this method.
optionsA combination of StandardWindowOptions to specify UI elements to be present in your application window.
xmlfileThe relative or absolute path to the local xmlfile. If this is an empty string, the code will look for a local XML file appnameui.rc, where 'appname' is the name of your app. See the note about the xmlfile argument in createGUI().
See also

Definition at line 285 of file kxmlguiwindow.cpp.

◆ setupToolbarMenuActions()

void KXmlGuiWindow::setupToolbarMenuActions ( )

for KToolBar

Definition at line 205 of file kxmlguiwindow.cpp.

◆ slotStateChanged [1/2]

void KXmlGuiWindow::slotStateChanged ( const QString & newstate)

Applies a state change.

Reimplement this to enable and disable actions as defined in the XmlGui rc file.

newstateThe state change to be applied.

Definition at line 410 of file kxmlguiwindow.cpp.

◆ slotStateChanged [2/2]

void KXmlGuiWindow::slotStateChanged ( const QString & newstate,
bool reverse )

Applies a state change.

Reimplement this to enable and disable actions as defined in the XmlGui rc file.

This function can "reverse" the state (disable the actions which should be enabled, and vice-versa) if specified.

newstateThe state change to be applied.
reverseWhether to reverse newstate or not.

Definition at line 415 of file kxmlguiwindow.cpp.

◆ toolBarMenuAction()

QAction * KXmlGuiWindow::toolBarMenuAction ( )
A pointer to the main window's action responsible for the toolbar's menu.

Definition at line 195 of file kxmlguiwindow.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sun Feb 25 2024 18:47:50 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.